@easyedu/js-lsm-api 1.103.0 → 1.104.0

package/docs/ChatApi.md

@@ -5,10 +5,16 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
 | [**deleteConversation**](ChatApi.md#deleteconversation) | **DELETE** /chat/conversations/{conversationId} | Delete a conversation |
+| [**getChatAdminConversation**](ChatApi.md#getchatadminconversation) | **GET** /chat/admin/conversations/{conversationId} | Get a conversation transcript from the selected portal |
+| [**getChatAdminConversations**](ChatApi.md#getchatadminconversations) | **GET** /chat/admin/conversations | List conversations in the selected portal |
+| [**getChatAdminSettings**](ChatApi.md#getchatadminsettings) | **GET** /chat/admin/settings | Get chatbot settings for the selected portal |
+| [**getChatAdminUsage**](ChatApi.md#getchatadminusage) | **GET** /chat/admin/usage | Get chatbot usage analytics for the selected portal |
+| [**getChatQuota**](ChatApi.md#getchatquota) | **GET** /chat/quota | Get the current user\'s chat quota |
 | [**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 |
+| [**putChatAdminSettings**](ChatApi.md#putchatadminsettings) | **PUT** /chat/admin/settings | Update chatbot settings for the selected portal |
 
 
 
@@ -80,6 +86,352 @@ 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)
 
 
+## getChatAdminConversation
+
+> AdminConversationDetail getChatAdminConversation(conversationId)
+
+Get a conversation transcript from the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetChatAdminConversationRequest } 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 GetChatAdminConversationRequest;
+
+  try {
+    const data = await api.getChatAdminConversation(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
+
+[**AdminConversationDetail**](AdminConversationDetail.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal-scoped conversation transcript and usage |  -  |
+| **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)
+
+
+## getChatAdminConversations
+
+> AdminConversationList getChatAdminConversations(page, pageSize, userId, model, createdFrom, createdTo)
+
+List conversations in the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetChatAdminConversationsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // number (optional)
+    page: 56,
+    // number (optional)
+    pageSize: 56,
+    // string | User external ID (optional)
+    userId: userId_example,
+    // string (optional)
+    model: model_example,
+    // number | Inclusive Unix timestamp (optional)
+    createdFrom: 789,
+    // number | Exclusive Unix timestamp (optional)
+    createdTo: 789,
+  } satisfies GetChatAdminConversationsRequest;
+
+  try {
+    const data = await api.getChatAdminConversations(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **page** | `number` |  | [Optional] [Defaults to `1`] |
+| **pageSize** | `number` |  | [Optional] [Defaults to `20`] |
+| **userId** | `string` | User external ID | [Optional] [Defaults to `undefined`] |
+| **model** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **createdFrom** | `number` | Inclusive Unix timestamp | [Optional] [Defaults to `undefined`] |
+| **createdTo** | `number` | Exclusive Unix timestamp | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**AdminConversationList**](AdminConversationList.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal-scoped conversation summaries |  -  |
+| **400** | Invalid filters |  -  |
+| **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)
+
+
+## getChatAdminSettings
+
+> GetChatSettings getChatAdminSettings()
+
+Get chatbot settings for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetChatAdminSettingsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  try {
+    const data = await api.getChatAdminSettings();
+    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
+
+[**GetChatSettings**](GetChatSettings.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Selected portal chatbot settings |  -  |
+| **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)
+
+
+## getChatAdminUsage
+
+> GetChatUsage getChatAdminUsage(userId, model, from, to)
+
+Get chatbot usage analytics for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetChatAdminUsageRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // string | User external ID (optional)
+    userId: userId_example,
+    // string (optional)
+    model: model_example,
+    // number | Inclusive Unix timestamp; defaults to 30 UTC days before to (optional)
+    from: 789,
+    // number | Exclusive Unix timestamp; defaults to now (optional)
+    to: 789,
+  } satisfies GetChatAdminUsageRequest;
+
+  try {
+    const data = await api.getChatAdminUsage(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` | User external ID | [Optional] [Defaults to `undefined`] |
+| **model** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **from** | `number` | Inclusive Unix timestamp; defaults to 30 UTC days before to | [Optional] [Defaults to `undefined`] |
+| **to** | `number` | Exclusive Unix timestamp; defaults to now | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**GetChatUsage**](GetChatUsage.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Portal-scoped chatbot usage analytics |  -  |
+| **400** | Invalid timestamp range or range exceeds 366 days |  -  |
+| **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)
+
+
+## getChatQuota
+
+> ChatQuota getChatQuota()
+
+Get the current user\'s chat quota
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { GetChatQuotaRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  try {
+    const data = await api.getChatQuota();
+    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
+
+[**ChatQuota**](ChatQuota.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Chat quota and next UTC reset |  -  |
+| **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)
+
+
 ## getConversationMessages
 
 > Array<GetChatMessage> getConversationMessages(conversationId)
@@ -281,6 +633,7 @@ No authorization required
 | **201** | Conversation created with LLM response |  -  |
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
+| **429** | Learner daily message quota exceeded |  -  |
 
 [[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
 
@@ -352,6 +705,75 @@ No authorization required
 | **401** | Unauthorized |  -  |
 | **403** | Forbidden |  -  |
 | **404** | Conversation not found |  -  |
+| **429** | Learner daily message quota exceeded |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
+## putChatAdminSettings
+
+> GetChatSettings putChatAdminSettings(putChatSettings)
+
+Update chatbot settings for the selected portal
+
+### Example
+
+```ts
+import {
+  Configuration,
+  ChatApi,
+} from '@easyedu/js-lsm-api';
+import type { PutChatAdminSettingsRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new ChatApi();
+
+  const body = {
+    // PutChatSettings
+    putChatSettings: ...,
+  } satisfies PutChatAdminSettingsRequest;
+
+  try {
+    const data = await api.putChatAdminSettings(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **putChatSettings** | [PutChatSettings](PutChatSettings.md) |  | |
+
+### Return type
+
+[**GetChatSettings**](GetChatSettings.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Updated selected portal chatbot settings |  -  |
+| **400** | Invalid learner daily message limit |  -  |
+| **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)
 

package/docs/ChatDailyUsage.md

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

@@ -0,0 +1,46 @@
+
+# ChatModelUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`provider` | string
+`model` | string
+`acceptedRequests` | number
+`providerRequestCount` | number
+`inputTokens` | number
+`outputTokens` | number
+`totalTokens` | number
+
+## Example
+
+```typescript
+import type { ChatModelUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "provider": null,
+  "model": null,
+  "acceptedRequests": null,
+  "providerRequestCount": null,
+  "inputTokens": null,
+  "outputTokens": null,
+  "totalTokens": null,
+} satisfies ChatModelUsage
+
+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 ChatModelUsage
+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/ChatQuota.md

@@ -0,0 +1,42 @@
+
+# ChatQuota
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`applies` | boolean
+`limit` | number
+`used` | number
+`remaining` | number
+`resetsAt` | number
+
+## Example
+
+```typescript
+import type { ChatQuota } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "applies": null,
+  "limit": null,
+  "used": null,
+  "remaining": null,
+  "resetsAt": null,
+} satisfies ChatQuota
+
+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 ChatQuota
+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/ChatQuotaExceeded.md

@@ -0,0 +1,42 @@
+
+# ChatQuotaExceeded
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`error` | string
+`limit` | number
+`used` | number
+`remaining` | number
+`resetsAt` | number
+
+## Example
+
+```typescript
+import type { ChatQuotaExceeded } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "error": null,
+  "limit": null,
+  "used": null,
+  "remaining": null,
+  "resetsAt": null,
+} satisfies ChatQuotaExceeded
+
+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 ChatQuotaExceeded
+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/ChatTurnUsage.md

@@ -0,0 +1,48 @@
+
+# ChatTurnUsage
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`status` | string
+`provider` | string
+`model` | string
+`providerRequestCount` | number
+`inputTokens` | number
+`outputTokens` | number
+`totalTokens` | number
+`createdAt` | number
+
+## Example
+
+```typescript
+import type { ChatTurnUsage } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "status": null,
+  "provider": null,
+  "model": null,
+  "providerRequestCount": null,
+  "inputTokens": null,
+  "outputTokens": null,
+  "totalTokens": null,
+  "createdAt": null,
+} satisfies ChatTurnUsage
+
+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 ChatTurnUsage
+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/ChatUsageTotals.md

@@ -0,0 +1,46 @@
+
+# ChatUsageTotals
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`acceptedRequests` | number
+`successfulRequests` | number
+`failedRequests` | number
+`providerRequestCount` | number
+`inputTokens` | number
+`outputTokens` | number
+`totalTokens` | number
+
+## Example
+
+```typescript
+import type { ChatUsageTotals } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "acceptedRequests": null,
+  "successfulRequests": null,
+  "failedRequests": null,
+  "providerRequestCount": null,
+  "inputTokens": null,
+  "outputTokens": null,
+  "totalTokens": null,
+} satisfies ChatUsageTotals
+
+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 ChatUsageTotals
+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)
+
+