@easyedu/js-lsm-api 1.29.0 → 1.31.0

package/docs/GetUserQuizAttemptsAllOfSummary.md

@@ -0,0 +1,47 @@
+
+# GetUserQuizAttemptsAllOfSummary
+
+User\'s quiz attempt summary
+
+## Properties
+
+Name | Type
+------------ | -------------
+`totalAttempts` | number
+`completedAttempts` | number
+`inProgressAttempts` | number
+`passedAttempts` | number
+`failedAttempts` | number
+`averageScore` | number
+`totalTimeHours` | number
+
+## Example
+
+```typescript
+import type { GetUserQuizAttemptsAllOfSummary } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "totalAttempts": null,
+  "completedAttempts": null,
+  "inProgressAttempts": null,
+  "passedAttempts": null,
+  "failedAttempts": null,
+  "averageScore": null,
+  "totalTimeHours": null,
+} satisfies GetUserQuizAttemptsAllOfSummary
+
+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 GetUserQuizAttemptsAllOfSummary
+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/LoginRes.md

@@ -0,0 +1,36 @@
+
+# LoginRes
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`authData` | [LoginResAuthData](LoginResAuthData.md)
+`userData` | [LoginResUserData](LoginResUserData.md)
+
+## Example
+
+```typescript
+import type { LoginRes } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "authData": null,
+  "userData": null,
+} satisfies LoginRes
+
+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 LoginRes
+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/LoginResAuthData.md

@@ -0,0 +1,36 @@
+
+# LoginResAuthData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`token` | string
+`exp` | number
+
+## Example
+
+```typescript
+import type { LoginResAuthData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "token": null,
+  "exp": null,
+} satisfies LoginResAuthData
+
+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 LoginResAuthData
+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/LoginResUserData.md

@@ -0,0 +1,40 @@
+
+# LoginResUserData
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`userId` | string
+`userFullName` | string
+`userRole` | string
+`selectedPortal` | [LoginResUserDataSelectedPortal](LoginResUserDataSelectedPortal.md)
+
+## Example
+
+```typescript
+import type { LoginResUserData } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "userId": null,
+  "userFullName": null,
+  "userRole": null,
+  "selectedPortal": null,
+} satisfies LoginResUserData
+
+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 LoginResUserData
+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/LoginResUserDataSelectedPortal.md

@@ -0,0 +1,36 @@
+
+# LoginResUserDataSelectedPortal
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`portalName` | string
+`portalId` | string
+
+## Example
+
+```typescript
+import type { LoginResUserDataSelectedPortal } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "portalName": null,
+  "portalId": null,
+} satisfies LoginResUserDataSelectedPortal
+
+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 LoginResUserDataSelectedPortal
+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/ManualSelection.md

@@ -0,0 +1,36 @@
+
+# ManualSelection
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`method` | string
+`questionIds` | Array<string>
+
+## Example
+
+```typescript
+import type { ManualSelection } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "method": null,
+  "questionIds": null,
+} satisfies ManualSelection
+
+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 ManualSelection
+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/MediaContent.md

@@ -0,0 +1,38 @@
+
+# MediaContent
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`url` | string
+`fileSize` | number
+`mimeType` | string
+
+## Example
+
+```typescript
+import type { MediaContent } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "url": null,
+  "fileSize": null,
+  "mimeType": null,
+} satisfies MediaContent
+
+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 MediaContent
+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/ModuleApi.md

@@ -0,0 +1,284 @@
+# ModuleApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**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 |
+| [**putModule**](ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id |
+
+
+
+## getModule
+
+> GetModule getModule(moduleId, courseId)
+
+get a course module
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { GetModuleRequest } 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 GetModuleRequest;
+
+  try {
+    const data = await api.getModule(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
+
+[**GetModule**](GetModule.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get module response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## getModuleList
+
+> GetModuleList getModuleList(courseId)
+
+get module list
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { GetModuleListRequest } 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,
+  } satisfies GetModuleListRequest;
+
+  try {
+    const data = await api.getModuleList(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
+
+[**GetModuleList**](GetModuleList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | get module list response OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postModule
+
+> GetModule postModule(courseId, postModule)
+
+Post a new module
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { PostModuleRequest } 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,
+    // PostModule | Module object that needs to be added
+    postModule: ...,
+  } satisfies PostModuleRequest;
+
+  try {
+    const data = await api.postModule(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`] |
+| **postModule** | [PostModule](PostModule.md) | Module object that needs to be added | |
+
+### 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 |
+|-------------|-------------|------------------|
+| **200** | post module response OK |  -  |
+
+[[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)
+
+Update a module by id
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ModuleApi,
+} from '@easyedu/js-lsm-api';
+import type { PutModuleRequest } 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,
+    // PutModule | Module object that needs to be updated
+    putModule: ...,
+  } satisfies PutModuleRequest;
+
+  try {
+    const data = await api.putModule(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`] |
+| **putModule** | [PutModule](PutModule.md) | Module object that needs to be updated | |
+
+### 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 |
+|-------------|-------------|------------------|
+| **200** | put module response OK |  -  |
+
+[[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/MultipleAnswer.md

@@ -0,0 +1,36 @@
+
+# MultipleAnswer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`answerChoiceIds` | Array<string>
+
+## Example
+
+```typescript
+import type { MultipleAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "answerChoiceIds": null,
+} satisfies MultipleAnswer
+
+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 MultipleAnswer
+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/MultipleAnswer1.md

@@ -0,0 +1,36 @@
+
+# MultipleAnswer1
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+`answerChoiceIds` | Array<string>
+
+## Example
+
+```typescript
+import type { MultipleAnswer1 } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+  "answerChoiceIds": null,
+} satisfies MultipleAnswer1
+
+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 MultipleAnswer1
+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/NoAnswer.md

@@ -0,0 +1,34 @@
+
+# NoAnswer
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`type` | string
+
+## Example
+
+```typescript
+import type { NoAnswer } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "type": null,
+} satisfies NoAnswer
+
+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 NoAnswer
+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)
+
+