@easyedu/js-lsm-api 1.30.0 → 1.31.0

package/docs/OtherApi.md

@@ -0,0 +1,66 @@
+# OtherApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**getHealth**](OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint |
+
+
+
+## getHealth
+
+> getHealth()
+
+Health check endpoint
+
+### Example
+
+```ts
+import {
+  Configuration,
+  OtherApi,
+} from '@easyedu/js-lsm-api';
+import type { GetHealthRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new OtherApi();
+
+  try {
+    const data = await api.getHealth();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### 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 |
+|-------------|-------------|------------------|
+| **200** | Service is healthy |  -  |
+
+[[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/Paginated.md

@@ -0,0 +1,40 @@
+
+# Paginated
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`page` | number
+`pageSize` | number
+`totalPages` | number
+`totalItems` | number
+
+## Example
+
+```typescript
+import type { Paginated } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "page": null,
+  "pageSize": null,
+  "totalPages": null,
+  "totalItems": null,
+} satisfies Paginated
+
+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 Paginated
+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/PortalApi.md

@@ -0,0 +1,493 @@
+# PortalApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**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 |
+| [**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 |
+
+
+
+## getPortalById
+
+> GetPortal getPortalById(portalId)
+
+Get a portal by id (can use \'current\' to get the current users selected portal)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalByIdRequest } 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 GetPortalByIdRequest;
+
+  try {
+    const data = await api.getPortalById(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
+
+[**GetPortal**](GetPortal.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 portal 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)
+
+
+## getPortalList
+
+> GetPortalList getPortalList()
+
+Get all portals a user has access to
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalListRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  try {
+    const data = await api.getPortalList();
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**GetPortalList**](GetPortalList.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 portal 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)
+
+
+## getPortalUsers
+
+> GetPortalUserList getPortalUsers(portalId, type, roles, search, page, pageSize)
+
+Get all users for a portal with optional role filtering
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPortalUsersRequest } 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,
+    // 'student' | 'instructor' | Filter users by type (student maps to Learner, instructor maps to Instructor) (optional)
+    type: type_example,
+    // Array<'Admin' | 'Instructor' | 'Learner'> | Filter users by role (can specify multiple) (optional)
+    roles: ...,
+    // string | Search users by first name, last name, or email (optional)
+    search: Josh,
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+  } satisfies GetPortalUsersRequest;
+
+  try {
+    const data = await api.getPortalUsers(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`] |
+| **type** | `student`, `instructor` | Filter users by type (student maps to Learner, instructor maps to Instructor) | [Optional] [Defaults to `undefined`] [Enum: student, instructor] |
+| **roles** | `Admin`, `Instructor`, `Learner` | Filter users by role (can specify multiple) | [Optional] [Enum: Admin, Instructor, Learner] |
+| **search** | `string` | Search users by first name, last name, or email | [Optional] [Defaults to `undefined`] |
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetPortalUserList**](GetPortalUserList.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 portal users response OK |  -  |
+| **400** | get portal users response error |  -  |
+| **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)
+
+
+## inviteUserToPortal
+
+> inviteUserToPortal(portalId, postPortalInvite)
+
+Invite a new user to a portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { InviteUserToPortalRequest } 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,
+    // PostPortalInvite | User object that needs to be added
+    postPortalInvite: ...,
+  } satisfies InviteUserToPortalRequest;
+
+  try {
+    const data = await api.inviteUserToPortal(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`] |
+| **postPortalInvite** | [PostPortalInvite](PostPortalInvite.md) | User object that needs to be added | |
+
+### Return type
+
+`void` (Empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: Not defined
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | invite user to portal response OK |  -  |
+| **400** | invite user to portal response error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postPortal
+
+> GetPortal postPortal(postPortal)
+
+Create a new portal as a child of the current selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PostPortalRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  const body = {
+    // PostPortal | Portal object that needs to be created
+    postPortal: ...,
+  } satisfies PostPortalRequest;
+
+  try {
+    const data = await api.postPortal(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postPortal** | [PostPortal](PostPortal.md) | Portal object that needs to be created | |
+
+### Return type
+
+[**GetPortal**](GetPortal.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 portal response OK |  -  |
+| **400** | post portal response error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putPortalBranding
+
+> GetPortal putPortalBranding(portalId, putPortalBranding)
+
+Update portal branding (name, background color, text color)
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PutPortalBrandingRequest } 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,
+    // PutPortalBranding | Portal branding fields to update
+    putPortalBranding: ...,
+  } satisfies PutPortalBrandingRequest;
+
+  try {
+    const data = await api.putPortalBranding(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`] |
+| **putPortalBranding** | [PutPortalBranding](PutPortalBranding.md) | Portal branding fields to update | |
+
+### Return type
+
+[**GetPortal**](GetPortal.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 portal branding response OK |  -  |
+| **400** | put portal branding response error |  -  |
+| **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)
+
+
+## updateSelectedPortal
+
+> updateSelectedPortal(portalId, selectedUserRole)
+
+Update the users current selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { UpdateSelectedPortalRequest } 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 (optional)
+    selectedUserRole: selectedUserRole_example,
+  } satisfies UpdateSelectedPortalRequest;
+
+  try {
+    const data = await api.updateSelectedPortal(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`] |
+| **selectedUserRole** | `string` |  | [Optional] [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 |
+|-------------|-------------|------------------|
+| **200** | update selected portal response OK |  -  |
+| **400** | update selected portal response error |  -  |
+
+[[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/PostContentQuiz.md

@@ -0,0 +1,42 @@
+
+# PostContentQuiz
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`name` | string
+`description` | string
+`questionSelection` | [PostContentQuizQuestionSelection](PostContentQuizQuestionSelection.md)
+`settings` | [PostContentQuizSettings](PostContentQuizSettings.md)
+`assignment` | [PostContentQuizAssignment](PostContentQuizAssignment.md)
+
+## Example
+
+```typescript
+import type { PostContentQuiz } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "name": null,
+  "description": null,
+  "questionSelection": null,
+  "settings": null,
+  "assignment": null,
+} satisfies PostContentQuiz
+
+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 PostContentQuiz
+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/PostContentQuizAssignment.md

@@ -0,0 +1,41 @@
+
+# PostContentQuizAssignment
+
+Assignment settings for the quiz
+
+## Properties
+
+Name | Type
+------------ | -------------
+`dueDate` | Date
+`availableFrom` | Date
+`availableUntil` | Date
+`assignedUsers` | Array<string>
+
+## Example
+
+```typescript
+import type { PostContentQuizAssignment } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "dueDate": null,
+  "availableFrom": null,
+  "availableUntil": null,
+  "assignedUsers": null,
+} satisfies PostContentQuizAssignment
+
+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 PostContentQuizAssignment
+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)
+
+