@easyedu/js-lsm-api 1.56.0 → 1.58.0

package/dist/models/index.js

@@ -88,6 +88,7 @@ __exportStar(require("./GetPortal"), exports);
 __exportStar(require("./GetPortalBasicReporting"), exports);
 __exportStar(require("./GetPortalBasicReportingCertificates"), exports);
 __exportStar(require("./GetPortalBasicReportingPortalInfo"), exports);
+__exportStar(require("./GetPortalFaviconUpload"), exports);
 __exportStar(require("./GetPortalList"), exports);
 __exportStar(require("./GetPortalLogoUpload"), exports);
 __exportStar(require("./GetPortalStudentReporting"), exports);
@@ -157,6 +158,7 @@ __exportStar(require("./GetSupportTicketAttachment"), exports);
 __exportStar(require("./GetSupportTicketComment"), exports);
 __exportStar(require("./GetSupportTicketList"), exports);
 __exportStar(require("./GetUser"), exports);
+__exportStar(require("./GetUserAvatarUpload"), exports);
 __exportStar(require("./GetUserQuizAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfAttempts"), exports);
 __exportStar(require("./GetUserQuizAttemptsAllOfFilters"), exports);

package/docs/GetPortal.md

@@ -10,6 +10,7 @@ Name | Type
 `name` | string
 `parentPortalId` | string
 `logoUrl` | string
+`faviconUrl` | string
 `headerBackgroundColor` | string
 `headerTextColor` | string
 `baseType` | string
@@ -25,6 +26,7 @@ const example = {
   "name": null,
   "parentPortalId": null,
   "logoUrl": null,
+  "faviconUrl": null,
   "headerBackgroundColor": null,
   "headerTextColor": null,
   "baseType": null,

package/docs/GetPortalFaviconUpload.md

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

@@ -10,6 +10,7 @@ Name | Type
 `firstName` | string
 `lastName` | string
 `email` | string
+`avatarUrl` | string
 `lastUpdated` | number
 
 ## Example
@@ -23,6 +24,7 @@ const example = {
   "firstName": null,
   "lastName": null,
   "email": null,
+  "avatarUrl": null,
   "lastUpdated": null,
 } satisfies GetUser
 

package/docs/GetUserAvatarUpload.md

@@ -0,0 +1,34 @@
+
+# GetUserAvatarUpload
+
+
+## Properties
+
+Name | Type
+------------ | -------------
+`avatarUrl` | string
+
+## Example
+
+```typescript
+import type { GetUserAvatarUpload } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "avatarUrl": null,
+} satisfies GetUserAvatarUpload
+
+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 GetUserAvatarUpload
+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,18 +4,86 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 
 | Method | HTTP request | Description |
 |------------- | ------------- | -------------|
+| [**deletePortalFavicon**](PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon |
 | [**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 |
+| [**postPortalFaviconUpload**](PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding |
 | [**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. |
 
 
 
+## deletePortalFavicon
+
+> deletePortalFavicon(portalId)
+
+Remove the portal favicon
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { DeletePortalFaviconRequest } 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 DeletePortalFaviconRequest;
+
+  try {
+    const data = await api.deletePortalFavicon(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** | Favicon 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)
+
+
 ## deletePortalLogo
 
 > deletePortalLogo(portalId)
@@ -421,6 +489,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)
 
 
+## postPortalFaviconUpload
+
+> GetPortalFaviconUpload postPortalFaviconUpload(portalId, file)
+
+Upload a favicon image for portal branding
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { PostPortalFaviconUploadRequest } 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 | Favicon image file (PNG, ICO, or SVG). Max 1MB.
+    file: BINARY_DATA_HERE,
+  } satisfies PostPortalFaviconUploadRequest;
+
+  try {
+    const data = await api.postPortalFaviconUpload(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` | Favicon image file (PNG, ICO, or SVG). Max 1MB. | [Defaults to `undefined`] |
+
+### Return type
+
+[**GetPortalFaviconUpload**](GetPortalFaviconUpload.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** | Favicon 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)
+
+
 ## postPortalLogoUpload
 
 > GetPortalLogoUpload postPortalLogoUpload(portalId, file)

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.56.0",
+  "version": "1.58.0",
   "description": "OpenAPI client for @easyedu/js-lsm-api",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/PortalApi.ts

@@ -16,6 +16,7 @@
 import * as runtime from '../runtime';
 import type {
   GetPortal,
+  GetPortalFaviconUpload,
   GetPortalList,
   GetPortalLogoUpload,
   GetPortalUserList,
@@ -26,6 +27,8 @@ import type {
 import {
     GetPortalFromJSON,
     GetPortalToJSON,
+    GetPortalFaviconUploadFromJSON,
+    GetPortalFaviconUploadToJSON,
     GetPortalListFromJSON,
     GetPortalListToJSON,
     GetPortalLogoUploadFromJSON,
@@ -40,6 +43,10 @@ import {
     PutPortalBrandingToJSON,
 } from '../models/index';
 
+export interface DeletePortalFaviconRequest {
+    portalId: string;
+}
+
 export interface DeletePortalLogoRequest {
     portalId: string;
 }
@@ -66,6 +73,11 @@ export interface PostPortalRequest {
     postPortal: PostPortal;
 }
 
+export interface PostPortalFaviconUploadRequest {
+    portalId: string;
+    file: Blob;
+}
+
 export interface PostPortalLogoUploadRequest {
     portalId: string;
     file: Blob;
@@ -85,6 +97,50 @@ export interface UpdateSelectedPortalRequest {
  */
 export class PortalApi extends runtime.BaseAPI {
 
+    /**
+     * Creates request options for deletePortalFavicon without sending the request
+     */
+    async deletePortalFaviconRequestOpts(requestParameters: DeletePortalFaviconRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling deletePortalFavicon().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/portals/{portalId}/branding/favicon`;
+        urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Remove the portal favicon
+     */
+    async deletePortalFaviconRaw(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>> {
+        const requestOptions = await this.deletePortalFaviconRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.VoidApiResponse(response);
+    }
+
+    /**
+     * Remove the portal favicon
+     */
+    async deletePortalFavicon(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void> {
+        await this.deletePortalFaviconRaw(requestParameters, initOverrides);
+    }
+
     /**
      * Creates request options for deletePortalLogo without sending the request
      */
@@ -377,6 +433,79 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for postPortalFaviconUpload without sending the request
+     */
+    async postPortalFaviconUploadRequestOpts(requestParameters: PostPortalFaviconUploadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['portalId'] == null) {
+            throw new runtime.RequiredError(
+                'portalId',
+                'Required parameter "portalId" was null or undefined when calling postPortalFaviconUpload().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling postPortalFaviconUpload().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        const consumes: runtime.Consume[] = [
+            { contentType: 'multipart/form-data' },
+        ];
+        // @ts-ignore: canConsumeForm may be unused
+        const canConsumeForm = runtime.canConsumeForm(consumes);
+
+        let formParams: { append(param: string, value: any): any };
+        let useForm = false;
+        // use FormData to transmit files using content-type "multipart/form-data"
+        useForm = canConsumeForm;
+        if (useForm) {
+            formParams = new FormData();
+        } else {
+            formParams = new URLSearchParams();
+        }
+
+        if (requestParameters['file'] != null) {
+            formParams.append('file', requestParameters['file'] as any);
+        }
+
+
+        let urlPath = `/portals/{portalId}/branding/favicon`;
+        urlPath = urlPath.replace(`{${"portalId"}}`, encodeURIComponent(String(requestParameters['portalId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * Upload a favicon image for portal branding
+     */
+    async postPortalFaviconUploadRaw(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalFaviconUpload>> {
+        const requestOptions = await this.postPortalFaviconUploadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFaviconUploadFromJSON(jsonValue));
+    }
+
+    /**
+     * Upload a favicon image for portal branding
+     */
+    async postPortalFaviconUpload(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalFaviconUpload> {
+        const response = await this.postPortalFaviconUploadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for postPortalLogoUpload without sending the request
      */