@easyedu/js-lsm-api 1.56.0 → 1.57.0

package/.openapi-generator/FILES

@@ -80,6 +80,7 @@ docs/GetPortal.md
 docs/GetPortalBasicReporting.md
 docs/GetPortalBasicReportingCertificates.md
 docs/GetPortalBasicReportingPortalInfo.md
+docs/GetPortalFaviconUpload.md
 docs/GetPortalList.md
 docs/GetPortalLogoUpload.md
 docs/GetPortalStudentReporting.md
@@ -362,6 +363,7 @@ src/models/GetPortal.ts
 src/models/GetPortalBasicReporting.ts
 src/models/GetPortalBasicReportingCertificates.ts
 src/models/GetPortalBasicReportingPortalInfo.ts
+src/models/GetPortalFaviconUpload.ts
 src/models/GetPortalList.ts
 src/models/GetPortalLogoUpload.ts
 src/models/GetPortalStudentReporting.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.56.0
+# @easyedu/js-lsm-api@1.57.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -131,12 +131,14 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *ModuleApi* | [**putModule**](docs/ModuleApi.md#putmodule) | **PUT** /courses/{courseId}/modules/{moduleId} | Update a module by id
 *ModuleApi* | [**putModuleReorder**](docs/ModuleApi.md#putmodulereorder) | **PUT** /courses/{courseId}/modules/reorder | Reorder modules in a course
 *OtherApi* | [**getHealth**](docs/OtherApi.md#gethealth) | **GET** /healthcheck | Health check endpoint
+*PortalApi* | [**deletePortalFavicon**](docs/PortalApi.md#deleteportalfavicon) | **DELETE** /portals/{portalId}/branding/favicon | Remove the portal favicon
 *PortalApi* | [**deletePortalLogo**](docs/PortalApi.md#deleteportallogo) | **DELETE** /portals/{portalId}/branding/logo | Remove the portal logo
 *PortalApi* | [**getPortalById**](docs/PortalApi.md#getportalbyid) | **GET** /portals/{portalId} | Get a portal by id (can use \'current\' to get the current users selected portal)
 *PortalApi* | [**getPortalList**](docs/PortalApi.md#getportallist) | **GET** /portals | Get all portals a user has access to
 *PortalApi* | [**getPortalUsers**](docs/PortalApi.md#getportalusers) | **GET** /portals/{portalId}/users | Get all users for a portal with optional role filtering
 *PortalApi* | [**inviteUserToPortal**](docs/PortalApi.md#inviteusertoportal) | **POST** /portals/{portalId}/invite | Invite a new user to a portal
 *PortalApi* | [**postPortal**](docs/PortalApi.md#postportal) | **POST** /portals | Create a new portal as a child of the current selected portal
+*PortalApi* | [**postPortalFaviconUpload**](docs/PortalApi.md#postportalfaviconupload) | **POST** /portals/{portalId}/branding/favicon | Upload a favicon image for portal branding
 *PortalApi* | [**postPortalLogoUpload**](docs/PortalApi.md#postportallogoupload) | **POST** /portals/{portalId}/branding/logo | Upload a logo image for portal branding
 *PortalApi* | [**putPortalBranding**](docs/PortalApi.md#putportalbranding) | **PUT** /portals/{portalId} | Update portal branding (name, background color, text color)
 *PortalApi* | [**updateSelectedPortal**](docs/PortalApi.md#updateselectedportal) | **PUT** /portals/{portalId}/selected | Update the users current selected portal. Returns new JWT with updated roles.
@@ -284,6 +286,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetPortalBasicReporting](docs/GetPortalBasicReporting.md)
 - [GetPortalBasicReportingCertificates](docs/GetPortalBasicReportingCertificates.md)
 - [GetPortalBasicReportingPortalInfo](docs/GetPortalBasicReportingPortalInfo.md)
+- [GetPortalFaviconUpload](docs/GetPortalFaviconUpload.md)
 - [GetPortalList](docs/GetPortalList.md)
 - [GetPortalLogoUpload](docs/GetPortalLogoUpload.md)
 - [GetPortalStudentReporting](docs/GetPortalStudentReporting.md)
@@ -478,7 +481,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.56.0`
+- Package version: `1.57.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/PortalApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetPortal, GetPortalList, GetPortalLogoUpload, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
+import type { GetPortal, GetPortalFaviconUpload, GetPortalList, GetPortalLogoUpload, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
+export interface DeletePortalFaviconRequest {
+    portalId: string;
+}
 export interface DeletePortalLogoRequest {
     portalId: string;
 }
@@ -32,6 +35,10 @@ export interface InviteUserToPortalRequest {
 export interface PostPortalRequest {
     postPortal: PostPortal;
 }
+export interface PostPortalFaviconUploadRequest {
+    portalId: string;
+    file: Blob;
+}
 export interface PostPortalLogoUploadRequest {
     portalId: string;
     file: Blob;
@@ -47,6 +54,18 @@ export interface UpdateSelectedPortalRequest {
  *
  */
 export declare class PortalApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deletePortalFavicon without sending the request
+     */
+    deletePortalFaviconRequestOpts(requestParameters: DeletePortalFaviconRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Remove the portal favicon
+     */
+    deletePortalFaviconRaw(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove the portal favicon
+     */
+    deletePortalFavicon(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for deletePortalLogo without sending the request
      */
@@ -119,6 +138,18 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Create a new portal as a child of the current selected portal
      */
     postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Creates request options for postPortalFaviconUpload without sending the request
+     */
+    postPortalFaviconUploadRequestOpts(requestParameters: PostPortalFaviconUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a favicon image for portal branding
+     */
+    postPortalFaviconUploadRaw(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalFaviconUpload>>;
+    /**
+     * Upload a favicon image for portal branding
+     */
+    postPortalFaviconUpload(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalFaviconUpload>;
     /**
      * Creates request options for postPortalLogoUpload without sending the request
      */

package/dist/apis/PortalApi.js

@@ -29,6 +29,44 @@ const index_1 = require("../models/index");
  *
  */
 class PortalApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deletePortalFavicon without sending the request
+     */
+    deletePortalFaviconRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling deletePortalFavicon().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    deletePortalFaviconRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deletePortalFaviconRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Remove the portal favicon
+     */
+    deletePortalFavicon(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deletePortalFaviconRaw(requestParameters, initOverrides);
+        });
+    }
     /**
      * Creates request options for deletePortalLogo without sending the request
      */
@@ -278,6 +316,67 @@ class PortalApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for postPortalFaviconUpload without sending the request
+     */
+    postPortalFaviconUploadRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            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']);
+            }
+            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
+     */
+    postPortalFaviconUploadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postPortalFaviconUploadRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, index_1.GetPortalFaviconUploadFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Upload a favicon image for portal branding
+     */
+    postPortalFaviconUpload(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postPortalFaviconUploadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for postPortalLogoUpload without sending the request
      */

package/dist/esm/apis/PortalApi.d.ts

@@ -10,7 +10,10 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import type { GetPortal, GetPortalList, GetPortalLogoUpload, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
+import type { GetPortal, GetPortalFaviconUpload, GetPortalList, GetPortalLogoUpload, GetPortalUserList, PostPortal, PostPortalInvite, PutPortalBranding } from '../models/index';
+export interface DeletePortalFaviconRequest {
+    portalId: string;
+}
 export interface DeletePortalLogoRequest {
     portalId: string;
 }
@@ -32,6 +35,10 @@ export interface InviteUserToPortalRequest {
 export interface PostPortalRequest {
     postPortal: PostPortal;
 }
+export interface PostPortalFaviconUploadRequest {
+    portalId: string;
+    file: Blob;
+}
 export interface PostPortalLogoUploadRequest {
     portalId: string;
     file: Blob;
@@ -47,6 +54,18 @@ export interface UpdateSelectedPortalRequest {
  *
  */
 export declare class PortalApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deletePortalFavicon without sending the request
+     */
+    deletePortalFaviconRequestOpts(requestParameters: DeletePortalFaviconRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Remove the portal favicon
+     */
+    deletePortalFaviconRaw(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove the portal favicon
+     */
+    deletePortalFavicon(requestParameters: DeletePortalFaviconRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Creates request options for deletePortalLogo without sending the request
      */
@@ -119,6 +138,18 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Create a new portal as a child of the current selected portal
      */
     postPortal(requestParameters: PostPortalRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortal>;
+    /**
+     * Creates request options for postPortalFaviconUpload without sending the request
+     */
+    postPortalFaviconUploadRequestOpts(requestParameters: PostPortalFaviconUploadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Upload a favicon image for portal branding
+     */
+    postPortalFaviconUploadRaw(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPortalFaviconUpload>>;
+    /**
+     * Upload a favicon image for portal branding
+     */
+    postPortalFaviconUpload(requestParameters: PostPortalFaviconUploadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalFaviconUpload>;
     /**
      * Creates request options for postPortalLogoUpload without sending the request
      */

package/dist/esm/apis/PortalApi.js

@@ -21,11 +21,49 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 import * as runtime from '../runtime';
-import { GetPortalFromJSON, GetPortalListFromJSON, GetPortalLogoUploadFromJSON, GetPortalUserListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
+import { GetPortalFromJSON, GetPortalFaviconUploadFromJSON, GetPortalListFromJSON, GetPortalLogoUploadFromJSON, GetPortalUserListFromJSON, PostPortalToJSON, PostPortalInviteToJSON, PutPortalBrandingToJSON, } from '../models/index';
 /**
  *
  */
 export class PortalApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for deletePortalFavicon without sending the request
+     */
+    deletePortalFaviconRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['portalId'] == null) {
+                throw new runtime.RequiredError('portalId', 'Required parameter "portalId" was null or undefined when calling deletePortalFavicon().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            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
+     */
+    deletePortalFaviconRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.deletePortalFaviconRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Remove the portal favicon
+     */
+    deletePortalFavicon(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.deletePortalFaviconRaw(requestParameters, initOverrides);
+        });
+    }
     /**
      * Creates request options for deletePortalLogo without sending the request
      */
@@ -275,6 +313,67 @@ export class PortalApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for postPortalFaviconUpload without sending the request
+     */
+    postPortalFaviconUploadRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            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 = {};
+            const headerParameters = {};
+            const consumes = [
+                { contentType: 'multipart/form-data' },
+            ];
+            // @ts-ignore: canConsumeForm may be unused
+            const canConsumeForm = runtime.canConsumeForm(consumes);
+            let formParams;
+            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']);
+            }
+            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
+     */
+    postPortalFaviconUploadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.postPortalFaviconUploadRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetPortalFaviconUploadFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Upload a favicon image for portal branding
+     */
+    postPortalFaviconUpload(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.postPortalFaviconUploadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for postPortalLogoUpload without sending the request
      */

package/dist/esm/models/GetPortal.d.ts

@@ -39,6 +39,12 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     logoUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortal
+     */
+    faviconUrl?: string | null;
     /**
      *
      * @type {string}

package/dist/esm/models/GetPortal.js

@@ -49,6 +49,7 @@ export function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
         'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
+        'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
@@ -66,6 +67,7 @@ export function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'parent_portal_id': value['parentPortalId'],
         'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
         'base_type': value['baseType'],

package/dist/esm/models/GetPortalFaviconUpload.d.ts

@@ -0,0 +1,32 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetPortalFaviconUpload
+ */
+export interface GetPortalFaviconUpload {
+    /**
+     * Presigned URL for the uploaded favicon image
+     * @type {string}
+     * @memberof GetPortalFaviconUpload
+     */
+    faviconUrl: string;
+}
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+export declare function instanceOfGetPortalFaviconUpload(value: object): value is GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadFromJSON(json: any): GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadToJSON(json: any): GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadToJSONTyped(value?: GetPortalFaviconUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPortalFaviconUpload.js

@@ -0,0 +1,43 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+export function instanceOfGetPortalFaviconUpload(value) {
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined)
+        return false;
+    return true;
+}
+export function GetPortalFaviconUploadFromJSON(json) {
+    return GetPortalFaviconUploadFromJSONTyped(json, false);
+}
+export function GetPortalFaviconUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'faviconUrl': json['favicon_url'],
+    };
+}
+export function GetPortalFaviconUploadToJSON(json) {
+    return GetPortalFaviconUploadToJSONTyped(json, false);
+}
+export function GetPortalFaviconUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'favicon_url': value['faviconUrl'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -70,6 +70,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';

package/dist/esm/models/index.js

@@ -72,6 +72,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';

package/dist/models/GetPortal.d.ts

@@ -39,6 +39,12 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     logoUrl?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPortal
+     */
+    faviconUrl?: string | null;
     /**
      *
      * @type {string}

package/dist/models/GetPortal.js

@@ -57,6 +57,7 @@ function GetPortalFromJSONTyped(json, ignoreDiscriminator) {
         'name': json['name'],
         'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
         'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
+        'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
@@ -74,6 +75,7 @@ function GetPortalToJSONTyped(value, ignoreDiscriminator = false) {
         'name': value['name'],
         'parent_portal_id': value['parentPortalId'],
         'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
         'base_type': value['baseType'],

package/dist/models/GetPortalFaviconUpload.d.ts

@@ -0,0 +1,32 @@
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface GetPortalFaviconUpload
+ */
+export interface GetPortalFaviconUpload {
+    /**
+     * Presigned URL for the uploaded favicon image
+     * @type {string}
+     * @memberof GetPortalFaviconUpload
+     */
+    faviconUrl: string;
+}
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+export declare function instanceOfGetPortalFaviconUpload(value: object): value is GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadFromJSON(json: any): GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadToJSON(json: any): GetPortalFaviconUpload;
+export declare function GetPortalFaviconUploadToJSONTyped(value?: GetPortalFaviconUpload | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetPortalFaviconUpload.js

@@ -0,0 +1,50 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.instanceOfGetPortalFaviconUpload = instanceOfGetPortalFaviconUpload;
+exports.GetPortalFaviconUploadFromJSON = GetPortalFaviconUploadFromJSON;
+exports.GetPortalFaviconUploadFromJSONTyped = GetPortalFaviconUploadFromJSONTyped;
+exports.GetPortalFaviconUploadToJSON = GetPortalFaviconUploadToJSON;
+exports.GetPortalFaviconUploadToJSONTyped = GetPortalFaviconUploadToJSONTyped;
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+function instanceOfGetPortalFaviconUpload(value) {
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined)
+        return false;
+    return true;
+}
+function GetPortalFaviconUploadFromJSON(json) {
+    return GetPortalFaviconUploadFromJSONTyped(json, false);
+}
+function GetPortalFaviconUploadFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'faviconUrl': json['favicon_url'],
+    };
+}
+function GetPortalFaviconUploadToJSON(json) {
+    return GetPortalFaviconUploadToJSONTyped(json, false);
+}
+function GetPortalFaviconUploadToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'favicon_url': value['faviconUrl'],
+    };
+}

package/dist/models/index.d.ts

@@ -70,6 +70,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';

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);

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/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@easyedu/js-lsm-api",
-  "version": "1.56.0",
+  "version": "1.57.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
      */

package/src/models/GetPortal.ts

@@ -43,6 +43,12 @@ export interface GetPortal {
      * @memberof GetPortal
      */
     logoUrl?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPortal
+     */
+    faviconUrl?: string | null;
     /**
      * 
      * @type {string}
@@ -104,6 +110,7 @@ export function GetPortalFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'name': json['name'],
         'parentPortalId': json['parent_portal_id'] == null ? undefined : json['parent_portal_id'],
         'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
+        'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
         'headerBackgroundColor': json['header_background_color'],
         'headerTextColor': json['header_text_color'],
         'baseType': json['base_type'] == null ? undefined : json['base_type'],
@@ -125,6 +132,7 @@ export function GetPortalToJSONTyped(value?: GetPortal | null, ignoreDiscriminat
         'name': value['name'],
         'parent_portal_id': value['parentPortalId'],
         'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
         'header_background_color': value['headerBackgroundColor'],
         'header_text_color': value['headerTextColor'],
         'base_type': value['baseType'],

package/src/models/GetPortalFaviconUpload.ts

@@ -0,0 +1,66 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * LMS API
+ * LMS API
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface GetPortalFaviconUpload
+ */
+export interface GetPortalFaviconUpload {
+    /**
+     * Presigned URL for the uploaded favicon image
+     * @type {string}
+     * @memberof GetPortalFaviconUpload
+     */
+    faviconUrl: string;
+}
+
+/**
+ * Check if a given object implements the GetPortalFaviconUpload interface.
+ */
+export function instanceOfGetPortalFaviconUpload(value: object): value is GetPortalFaviconUpload {
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined) return false;
+    return true;
+}
+
+export function GetPortalFaviconUploadFromJSON(json: any): GetPortalFaviconUpload {
+    return GetPortalFaviconUploadFromJSONTyped(json, false);
+}
+
+export function GetPortalFaviconUploadFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPortalFaviconUpload {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'faviconUrl': json['favicon_url'],
+    };
+}
+
+export function GetPortalFaviconUploadToJSON(json: any): GetPortalFaviconUpload {
+    return GetPortalFaviconUploadToJSONTyped(json, false);
+}
+
+export function GetPortalFaviconUploadToJSONTyped(value?: GetPortalFaviconUpload | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'favicon_url': value['faviconUrl'],
+    };
+}
+

package/src/models/index.ts

@@ -72,6 +72,7 @@ export * from './GetPortal';
 export * from './GetPortalBasicReporting';
 export * from './GetPortalBasicReportingCertificates';
 export * from './GetPortalBasicReportingPortalInfo';
+export * from './GetPortalFaviconUpload';
 export * from './GetPortalList';
 export * from './GetPortalLogoUpload';
 export * from './GetPortalStudentReporting';