@easyedu/js-lsm-api 1.39.0 → 1.41.0

package/docs/ChatApi.md

@@ -0,0 +1,357 @@
+# ChatApi
+
+All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com/stage1*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**deleteConversation**](ChatApi.md#deleteconversation) | **DELETE** /chat/conversations/{conversationId} | Delete a conversation |
+| [**getConversationMessages**](ChatApi.md#getconversationmessages) | **GET** /chat/conversations/{conversationId}/messages | Get all messages in a conversation |
+| [**getConversations**](ChatApi.md#getconversations) | **GET** /chat/conversations | List conversations for the current user |
+| [**postConversation**](ChatApi.md#postconversation) | **POST** /chat/conversations | Create a new conversation |
+| [**postMessage**](ChatApi.md#postmessage) | **POST** /chat/conversations/{conversationId}/messages | Send a message to a conversation |
+
+
+
+## deleteConversation
+
+> deleteConversation(conversationId)
+
+Delete a conversation
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteConversationRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // string
+    conversationId: conversationId_example,
+  } satisfies DeleteConversationRequest;
+
+  try {
+    const data = await api.deleteConversation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **conversationId** | `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** | Conversation deleted |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Conversation 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)
+
+
+## getConversationMessages
+
+> Array<GetChatMessage> getConversationMessages(conversationId)
+
+Get all messages in a conversation
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetConversationMessagesRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // string
+    conversationId: conversationId_example,
+  } satisfies GetConversationMessagesRequest;
+
+  try {
+    const data = await api.getConversationMessages(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **conversationId** | `string` |  | [Defaults to `undefined`] |
+
+### Return type
+
+[**Array<GetChatMessage>**](GetChatMessage.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | List of messages in the conversation |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Conversation 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)
+
+
+## getConversations
+
+> GetConversationList getConversations(page, pageSize)
+
+List conversations for the current user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetConversationsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // number | Page number for pagination (optional)
+    page: 56,
+    // number | Number of items per page (optional)
+    pageSize: 56,
+  } satisfies GetConversationsRequest;
+
+  try {
+    const data = await api.getConversations(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` | Page number for pagination | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` | Number of items per page | [Optional] [Defaults to `20`] |
+
+### Return type
+
+[**GetConversationList**](GetConversationList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Paginated list of conversations |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postConversation
+
+> PostConversationResponse postConversation(postConversation)
+
+Create a new conversation
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { PostConversationRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // PostConversation | Initial message to start the conversation
+    postConversation: ...,
+  } satisfies PostConversationRequest;
+
+  try {
+    const data = await api.postConversation(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **postConversation** | [PostConversation](PostConversation.md) | Initial message to start the conversation | |
+
+### Return type
+
+[**PostConversationResponse**](PostConversationResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **201** | Conversation created with LLM response |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## postMessage
+
+> PostMessageResponse postMessage(conversationId, postMessage)
+
+Send a message to a conversation
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { PostMessageRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // string
+    conversationId: conversationId_example,
+    // PostMessage | Message to send
+    postMessage: ...,
+  } satisfies PostMessageRequest;
+
+  try {
+    const data = await api.postMessage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **conversationId** | `string` |  | [Defaults to `undefined`] |
+| **postMessage** | [PostMessage](PostMessage.md) | Message to send | |
+
+### Return type
+
+[**PostMessageResponse**](PostMessageResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | LLM response to the message |  -  |
+| **401** | Unauthorized |  -  |
+| **403** | Forbidden |  -  |
+| **404** | Conversation 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)
+

package/docs/GetChatMessage.md

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

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

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

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

@@ -4,16 +4,84 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deletePortalLogo**](PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo |
 | [**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 |
+| [**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) |
 | [**updateSelectedPortal**](PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles. |
 
 
 
+## deletePortalLogo
+
+> deletePortalLogo(portalId)
+
+Remove the portal logo
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { DeletePortalLogoRequest } 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 DeletePortalLogoRequest;
+
+  try {
+    const data = await api.deletePortalLogo(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
+
+`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** | Logo removed successfully |  -  |
+| **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)
+
+
 ## getPortalById
 
 > GetPortal getPortalById(portalId)
@@ -353,6 +421,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)
 
 
+## postPortalLogoUpload
+
+> GetPortalLogoUpload postPortalLogoUpload(portalId, file)
+
+Upload a logo image for portal branding
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PostPortalLogoUploadRequest } 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,
+    // Blob | Logo image file (PNG, JPEG, or SVG). Max 5MB.
+    file: BINARY_DATA_HERE,
+  } satisfies PostPortalLogoUploadRequest;
+
+  try {
+    const data = await api.postPortalLogoUpload(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`] |
+| **file** | `Blob` | Logo image file (PNG, JPEG, or SVG). Max 5MB. | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalLogoUpload**](GetPortalLogoUpload.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `multipart/form-data`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Logo uploaded successfully |  -  |
+| **400** | Invalid file type or file too large |  -  |
+| **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)
+
+
 ## putPortalBranding
 
 > GetPortal putPortalBranding(portalId, putPortalBranding)

package/docs/PostConversation.md

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