@easyedu/js-lsm-api 1.57.0 → 1.59.0

package/docs/UpdateSelectedPortalResponseSelectedPortal.md

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

@@ -4,17 +4,85 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deleteUserAvatar**](UserApi.md#deleteuseravatar) | **DELETE** /users/{userId}/avatar | Remove the current user\'s profile photo |
 | [**getAuthCheck**](UserApi.md#getauthcheck) | **GET** /auth/check | Check if a user is logged in |
 | [**getCurrentUserPermissions**](UserApi.md#getcurrentuserpermissions) | **GET** /users/current/permissions | Get the current user\'s permissions |
 | [**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 |
+| [**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 |
 
 
 
+## deleteUserAvatar
+
+> deleteUserAvatar(userId)
+
+Remove the current user\'s profile photo
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { DeleteUserAvatarRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // string
+    userId: userId_example,
+  } satisfies DeleteUserAvatarRequest;
+
+  try {
+    const data = await api.deleteUserAvatar(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `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** | Avatar removed successfully |  -  |
+| **404** | User 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)
+
+
 ## getAuthCheck
 
 > getAuthCheck()
@@ -320,6 +388,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)
 
 
+## postUserAvatarUpload
+
+> GetUserAvatarUpload postUserAvatarUpload(userId, file)
+
+Upload a profile photo for the current user
+
+### Example
+
+```ts
+import {
+  Configuration,
+  UserApi,
+} from '@easyedu/js-lsm-api';
+import type { PostUserAvatarUploadRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new UserApi();
+
+  const body = {
+    // string
+    userId: userId_example,
+    // Blob | Avatar image file (PNG, JPEG, or SVG). Max 2MB.
+    file: BINARY_DATA_HERE,
+  } satisfies PostUserAvatarUploadRequest;
+
+  try {
+    const data = await api.postUserAvatarUpload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **userId** | `string` |  | [Defaults to `undefined`] |
+| **file** | `Blob` | Avatar image file (PNG, JPEG, or SVG). Max 2MB. | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetUserAvatarUpload**](GetUserAvatarUpload.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** | Avatar uploaded successfully |  -  |
+| **400** | Invalid file type or file too large |  -  |
+| **404** | User 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)
+
+
 ## putUser
 
 > GetUser putUser(userId, putUser)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.57.0",
+  "version": "1.59.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/CertificateApi.ts

@@ -12,42 +12,57 @@
  * Do not edit the class manually.
  */
 
-
 import * as runtime from '../runtime';
-import type {
-  Certificate,
-  CertificateConfig,
-  CertificatePublic,
-  EffectiveCertificateConfig,
-  GetCertificateConfigList,
-  GetCertificateList,
-  PostCertificate,
-  PostCertificateConfig,
-  PostRevokeCertificate,
-  PutCertificateConfig,
-} from '../models/index';
 import {
+    type Certificate,
     CertificateFromJSON,
     CertificateToJSON,
+} from '../models/Certificate';
+import {
+    type CertificateConfig,
     CertificateConfigFromJSON,
     CertificateConfigToJSON,
+} from '../models/CertificateConfig';
+import {
+    type CertificatePublic,
     CertificatePublicFromJSON,
     CertificatePublicToJSON,
+} from '../models/CertificatePublic';
+import {
+    type EffectiveCertificateConfig,
     EffectiveCertificateConfigFromJSON,
     EffectiveCertificateConfigToJSON,
+} from '../models/EffectiveCertificateConfig';
+import {
+    type GetCertificateConfigList,
     GetCertificateConfigListFromJSON,
     GetCertificateConfigListToJSON,
+} from '../models/GetCertificateConfigList';
+import {
+    type GetCertificateList,
     GetCertificateListFromJSON,
     GetCertificateListToJSON,
+} from '../models/GetCertificateList';
+import {
+    type PostCertificate,
     PostCertificateFromJSON,
     PostCertificateToJSON,
+} from '../models/PostCertificate';
+import {
+    type PostCertificateConfig,
     PostCertificateConfigFromJSON,
     PostCertificateConfigToJSON,
+} from '../models/PostCertificateConfig';
+import {
+    type PostRevokeCertificate,
     PostRevokeCertificateFromJSON,
     PostRevokeCertificateToJSON,
+} from '../models/PostRevokeCertificate';
+import {
+    type PutCertificateConfig,
     PutCertificateConfigFromJSON,
     PutCertificateConfigToJSON,
-} from '../models/index';
+} from '../models/PutCertificateConfig';
 
 export interface DeleteCertificateConfigRequest {
     configId: string;
@@ -130,7 +145,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/certificate-configs/{configId}`;
-        urlPath = urlPath.replace(`{${"configId"}}`, encodeURIComponent(String(requestParameters['configId'])));
+        urlPath = urlPath.replace('{configId}', encodeURIComponent(String(requestParameters['configId'])));
 
         return {
             path: urlPath,
@@ -174,7 +189,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/certificates/{certificateId}`;
-        urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+        urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
 
         return {
             path: urlPath,
@@ -219,7 +234,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/certificate-configs/{configId}`;
-        urlPath = urlPath.replace(`{${"configId"}}`, encodeURIComponent(String(requestParameters['configId'])));
+        urlPath = urlPath.replace('{configId}', encodeURIComponent(String(requestParameters['configId'])));
 
         return {
             path: urlPath,
@@ -309,7 +324,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/certificates/{certificateId}/pdf`;
-        urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+        urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
 
         return {
             path: urlPath,
@@ -460,7 +475,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/courses/{courseId}/certificate-config/effective`;
-        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
 
         return {
             path: urlPath,
@@ -561,7 +576,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/courses/{courseId}/certificates`;
-        urlPath = urlPath.replace(`{${"courseId"}}`, encodeURIComponent(String(requestParameters['courseId'])));
+        urlPath = urlPath.replace('{courseId}', encodeURIComponent(String(requestParameters['courseId'])));
 
         return {
             path: urlPath,
@@ -616,7 +631,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/certificates/{certificateId}/revoke`;
-        urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+        urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
 
         return {
             path: urlPath,
@@ -671,7 +686,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/certificate-configs/{configId}`;
-        urlPath = urlPath.replace(`{${"configId"}}`, encodeURIComponent(String(requestParameters['configId'])));
+        urlPath = urlPath.replace('{configId}', encodeURIComponent(String(requestParameters['configId'])));
 
         return {
             path: urlPath,
@@ -717,7 +732,7 @@ export class CertificateApi extends runtime.BaseAPI {
 
 
         let urlPath = `/public/certificates/{certificateId}/verify`;
-        urlPath = urlPath.replace(`{${"certificateId"}}`, encodeURIComponent(String(requestParameters['certificateId'])));
+        urlPath = urlPath.replace('{certificateId}', encodeURIComponent(String(requestParameters['certificateId'])));
 
         return {
             path: urlPath,

package/src/apis/ChatApi.ts

@@ -12,30 +12,37 @@
  * Do not edit the class manually.
  */
 
-
 import * as runtime from '../runtime';
-import type {
-  GetChatMessage,
-  GetConversationList,
-  PostConversation,
-  PostConversationResponse,
-  PostMessage,
-  PostMessageResponse,
-} from '../models/index';
 import {
+    type GetChatMessage,
     GetChatMessageFromJSON,
     GetChatMessageToJSON,
+} from '../models/GetChatMessage';
+import {
+    type GetConversationList,
     GetConversationListFromJSON,
     GetConversationListToJSON,
+} from '../models/GetConversationList';
+import {
+    type PostConversation,
     PostConversationFromJSON,
     PostConversationToJSON,
+} from '../models/PostConversation';
+import {
+    type PostConversationResponse,
     PostConversationResponseFromJSON,
     PostConversationResponseToJSON,
+} from '../models/PostConversationResponse';
+import {
+    type PostMessage,
     PostMessageFromJSON,
     PostMessageToJSON,
+} from '../models/PostMessage';
+import {
+    type PostMessageResponse,
     PostMessageResponseFromJSON,
     PostMessageResponseToJSON,
-} from '../models/index';
+} from '../models/PostMessageResponse';
 
 export interface DeleteConversationRequest {
     conversationId: string;
@@ -81,7 +88,7 @@ export class ChatApi extends runtime.BaseAPI {
 
 
         let urlPath = `/chat/conversations/{conversationId}`;
-        urlPath = urlPath.replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId'])));
+        urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
 
         return {
             path: urlPath,
@@ -125,7 +132,7 @@ export class ChatApi extends runtime.BaseAPI {
 
 
         let urlPath = `/chat/conversations/{conversationId}/messages`;
-        urlPath = urlPath.replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId'])));
+        urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
 
         return {
             path: urlPath,
@@ -271,7 +278,7 @@ export class ChatApi extends runtime.BaseAPI {
 
 
         let urlPath = `/chat/conversations/{conversationId}/messages`;
-        urlPath = urlPath.replace(`{${"conversationId"}}`, encodeURIComponent(String(requestParameters['conversationId'])));
+        urlPath = urlPath.replace('{conversationId}', encodeURIComponent(String(requestParameters['conversationId'])));
 
         return {
             path: urlPath,