@easyedu/js-lsm-api 1.60.0 → 1.61.0

package/.openapi-generator/FILES

@@ -88,6 +88,7 @@ docs/GetPortalStudentReportingCertificates.md
 docs/GetPortalStudentReportingPortalInfo.md
 docs/GetPortalUser.md
 docs/GetPortalUserList.md
+docs/GetPublicPortalBranding.md
 docs/GetQuestion.md
 docs/GetQuestionAnswerChoicesInner.md
 docs/GetQuestionList.md
@@ -375,6 +376,7 @@ src/models/GetPortalStudentReportingCertificates.ts
 src/models/GetPortalStudentReportingPortalInfo.ts
 src/models/GetPortalUser.ts
 src/models/GetPortalUserList.ts
+src/models/GetPublicPortalBranding.ts
 src/models/GetQuestion.ts
 src/models/GetQuestionAnswerChoicesInner.ts
 src/models/GetQuestionList.ts

package/README.md

@@ -1,4 +1,4 @@
-# @easyedu/js-lsm-api@1.60.0
+# @easyedu/js-lsm-api@1.61.0
 
 A TypeScript SDK client for the sbzw93t49b.execute-api.us-east-2.amazonaws.com API.
 
@@ -136,6 +136,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 *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* | [**getPublicPortalBranding**](docs/PortalApi.md#getpublicportalbranding) | **GET** /public/portal/branding | Public portal branding resolved from the request host
 *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
@@ -296,6 +297,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 - [GetPortalStudentReportingPortalInfo](docs/GetPortalStudentReportingPortalInfo.md)
 - [GetPortalUser](docs/GetPortalUser.md)
 - [GetPortalUserList](docs/GetPortalUserList.md)
+- [GetPublicPortalBranding](docs/GetPublicPortalBranding.md)
 - [GetQuestion](docs/GetQuestion.md)
 - [GetQuestionAnswerChoicesInner](docs/GetQuestionAnswerChoicesInner.md)
 - [GetQuestionList](docs/GetQuestionList.md)
@@ -487,7 +489,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `1.0.0`
-- Package version: `1.60.0`
+- Package version: `1.61.0`
 - Generator version: `7.22.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/PortalApi.d.ts

@@ -15,6 +15,7 @@ import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
 import { type GetPortalList } from '../models/GetPortalList';
 import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
 import { type GetPortalUserList } from '../models/GetPortalUserList';
+import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
 import { type PostPortal } from '../models/PostPortal';
 import { type PostPortalInvite } from '../models/PostPortalInvite';
 import { type PutPortalBranding } from '../models/PutPortalBranding';
@@ -122,6 +123,20 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Get all users for a portal with optional role filtering
      */
     getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
+    /**
+     * Creates request options for getPublicPortalBranding without sending the request
+     */
+    getPublicPortalBrandingRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBrandingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicPortalBranding>>;
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBranding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicPortalBranding>;
     /**
      * Creates request options for inviteUserToPortal without sending the request
      */

package/dist/apis/PortalApi.js

@@ -29,6 +29,7 @@ const GetPortalFaviconUpload_1 = require("../models/GetPortalFaviconUpload");
 const GetPortalList_1 = require("../models/GetPortalList");
 const GetPortalLogoUpload_1 = require("../models/GetPortalLogoUpload");
 const GetPortalUserList_1 = require("../models/GetPortalUserList");
+const GetPublicPortalBranding_1 = require("../models/GetPublicPortalBranding");
 const PostPortal_1 = require("../models/PostPortal");
 const PostPortalInvite_1 = require("../models/PostPortalInvite");
 const PutPortalBranding_1 = require("../models/PutPortalBranding");
@@ -241,6 +242,43 @@ class PortalApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getPublicPortalBranding without sending the request
+     */
+    getPublicPortalBrandingRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/public/portal/branding`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBrandingRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getPublicPortalBrandingRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => (0, GetPublicPortalBranding_1.GetPublicPortalBrandingFromJSON)(jsonValue));
+        });
+    }
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBranding(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getPublicPortalBrandingRaw(initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for inviteUserToPortal without sending the request
      */

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

@@ -15,6 +15,7 @@ import { type GetPortalFaviconUpload } from '../models/GetPortalFaviconUpload';
 import { type GetPortalList } from '../models/GetPortalList';
 import { type GetPortalLogoUpload } from '../models/GetPortalLogoUpload';
 import { type GetPortalUserList } from '../models/GetPortalUserList';
+import { type GetPublicPortalBranding } from '../models/GetPublicPortalBranding';
 import { type PostPortal } from '../models/PostPortal';
 import { type PostPortalInvite } from '../models/PostPortalInvite';
 import { type PutPortalBranding } from '../models/PutPortalBranding';
@@ -122,6 +123,20 @@ export declare class PortalApi extends runtime.BaseAPI {
      * Get all users for a portal with optional role filtering
      */
     getPortalUsers(requestParameters: GetPortalUsersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPortalUserList>;
+    /**
+     * Creates request options for getPublicPortalBranding without sending the request
+     */
+    getPublicPortalBrandingRequestOpts(): Promise<runtime.RequestOpts>;
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBrandingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicPortalBranding>>;
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBranding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicPortalBranding>;
     /**
      * Creates request options for inviteUserToPortal without sending the request
      */

package/dist/esm/apis/PortalApi.js

@@ -26,6 +26,7 @@ import { GetPortalFaviconUploadFromJSON, } from '../models/GetPortalFaviconUploa
 import { GetPortalListFromJSON, } from '../models/GetPortalList';
 import { GetPortalLogoUploadFromJSON, } from '../models/GetPortalLogoUpload';
 import { GetPortalUserListFromJSON, } from '../models/GetPortalUserList';
+import { GetPublicPortalBrandingFromJSON, } from '../models/GetPublicPortalBranding';
 import { PostPortalToJSON, } from '../models/PostPortal';
 import { PostPortalInviteToJSON, } from '../models/PostPortalInvite';
 import { PutPortalBrandingToJSON, } from '../models/PutPortalBranding';
@@ -238,6 +239,43 @@ export class PortalApi extends runtime.BaseAPI {
             return yield response.value();
         });
     }
+    /**
+     * Creates request options for getPublicPortalBranding without sending the request
+     */
+    getPublicPortalBrandingRequestOpts() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const queryParameters = {};
+            const headerParameters = {};
+            let urlPath = `/public/portal/branding`;
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBrandingRaw(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getPublicPortalBrandingRequestOpts();
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => GetPublicPortalBrandingFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    getPublicPortalBranding(initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getPublicPortalBrandingRaw(initOverrides);
+            return yield response.value();
+        });
+    }
     /**
      * Creates request options for inviteUserToPortal without sending the request
      */

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

@@ -0,0 +1,68 @@
+/**
+ * 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.
+ */
+/**
+ * Public portal branding resolved from the browser host.
+ * @export
+ * @interface GetPublicPortalBranding
+ */
+export interface GetPublicPortalBranding {
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    slug: string | null;
+    /**
+     * Presigned portal logo URL when a logo is configured.
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    logoUrl: string | null;
+    /**
+     * Presigned portal favicon URL when a favicon is configured.
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    faviconUrl: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    headerBackgroundColor: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    headerTextColor: string;
+}
+/**
+ * Check if a given object implements the GetPublicPortalBranding interface.
+ */
+export declare function instanceOfGetPublicPortalBranding(value: object): value is GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingFromJSON(json: any): GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingToJSON(json: any): GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingToJSONTyped(value?: GetPublicPortalBranding | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/GetPublicPortalBranding.js

@@ -0,0 +1,67 @@
+/* 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 GetPublicPortalBranding interface.
+ */
+export function instanceOfGetPublicPortalBranding(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined)
+        return false;
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined)
+        return false;
+    if (!('headerBackgroundColor' in value) || value['headerBackgroundColor'] === undefined)
+        return false;
+    if (!('headerTextColor' in value) || value['headerTextColor'] === undefined)
+        return false;
+    return true;
+}
+export function GetPublicPortalBrandingFromJSON(json) {
+    return GetPublicPortalBrandingFromJSONTyped(json, false);
+}
+export function GetPublicPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'logoUrl': json['logo_url'],
+        'faviconUrl': json['favicon_url'],
+        'headerBackgroundColor': json['header_background_color'],
+        'headerTextColor': json['header_text_color'],
+    };
+}
+export function GetPublicPortalBrandingToJSON(json) {
+    return GetPublicPortalBrandingToJSONTyped(json, false);
+}
+export function GetPublicPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'slug': value['slug'],
+        'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}

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

@@ -78,6 +78,7 @@ export * from './GetPortalStudentReportingCertificates';
 export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
 export * from './GetPortalUserList';
+export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';

package/dist/esm/models/index.js

@@ -80,6 +80,7 @@ export * from './GetPortalStudentReportingCertificates';
 export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
 export * from './GetPortalUserList';
+export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';

package/dist/models/GetPublicPortalBranding.d.ts

@@ -0,0 +1,68 @@
+/**
+ * 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.
+ */
+/**
+ * Public portal branding resolved from the browser host.
+ * @export
+ * @interface GetPublicPortalBranding
+ */
+export interface GetPublicPortalBranding {
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    id: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    name: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    slug: string | null;
+    /**
+     * Presigned portal logo URL when a logo is configured.
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    logoUrl: string | null;
+    /**
+     * Presigned portal favicon URL when a favicon is configured.
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    faviconUrl: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    headerBackgroundColor: string;
+    /**
+     *
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    headerTextColor: string;
+}
+/**
+ * Check if a given object implements the GetPublicPortalBranding interface.
+ */
+export declare function instanceOfGetPublicPortalBranding(value: object): value is GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingFromJSON(json: any): GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingToJSON(json: any): GetPublicPortalBranding;
+export declare function GetPublicPortalBrandingToJSONTyped(value?: GetPublicPortalBranding | null, ignoreDiscriminator?: boolean): any;

package/dist/models/GetPublicPortalBranding.js

@@ -0,0 +1,74 @@
+"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.instanceOfGetPublicPortalBranding = instanceOfGetPublicPortalBranding;
+exports.GetPublicPortalBrandingFromJSON = GetPublicPortalBrandingFromJSON;
+exports.GetPublicPortalBrandingFromJSONTyped = GetPublicPortalBrandingFromJSONTyped;
+exports.GetPublicPortalBrandingToJSON = GetPublicPortalBrandingToJSON;
+exports.GetPublicPortalBrandingToJSONTyped = GetPublicPortalBrandingToJSONTyped;
+/**
+ * Check if a given object implements the GetPublicPortalBranding interface.
+ */
+function instanceOfGetPublicPortalBranding(value) {
+    if (!('id' in value) || value['id'] === undefined)
+        return false;
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('slug' in value) || value['slug'] === undefined)
+        return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined)
+        return false;
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined)
+        return false;
+    if (!('headerBackgroundColor' in value) || value['headerBackgroundColor'] === undefined)
+        return false;
+    if (!('headerTextColor' in value) || value['headerTextColor'] === undefined)
+        return false;
+    return true;
+}
+function GetPublicPortalBrandingFromJSON(json) {
+    return GetPublicPortalBrandingFromJSONTyped(json, false);
+}
+function GetPublicPortalBrandingFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'id': json['id'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'logoUrl': json['logo_url'],
+        'faviconUrl': json['favicon_url'],
+        'headerBackgroundColor': json['header_background_color'],
+        'headerTextColor': json['header_text_color'],
+    };
+}
+function GetPublicPortalBrandingToJSON(json) {
+    return GetPublicPortalBrandingToJSONTyped(json, false);
+}
+function GetPublicPortalBrandingToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'id': value['id'],
+        'name': value['name'],
+        'slug': value['slug'],
+        'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}

package/dist/models/index.d.ts

@@ -78,6 +78,7 @@ export * from './GetPortalStudentReportingCertificates';
 export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
 export * from './GetPortalUserList';
+export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';

package/dist/models/index.js

@@ -96,6 +96,7 @@ __exportStar(require("./GetPortalStudentReportingCertificates"), exports);
 __exportStar(require("./GetPortalStudentReportingPortalInfo"), exports);
 __exportStar(require("./GetPortalUser"), exports);
 __exportStar(require("./GetPortalUserList"), exports);
+__exportStar(require("./GetPublicPortalBranding"), exports);
 __exportStar(require("./GetQuestion"), exports);
 __exportStar(require("./GetQuestionAnswerChoicesInner"), exports);
 __exportStar(require("./GetQuestionList"), exports);

package/docs/GetPublicPortalBranding.md

@@ -0,0 +1,47 @@
+
+# GetPublicPortalBranding
+
+Public portal branding resolved from the browser host.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`id` | string
+`name` | string
+`slug` | string
+`logoUrl` | string
+`faviconUrl` | string
+`headerBackgroundColor` | string
+`headerTextColor` | string
+
+## Example
+
+```typescript
+import type { GetPublicPortalBranding } from '@easyedu/js-lsm-api'
+
+// TODO: Update the object below with actual values
+const example = {
+  "id": null,
+  "name": null,
+  "slug": null,
+  "logoUrl": null,
+  "faviconUrl": null,
+  "headerBackgroundColor": null,
+  "headerTextColor": null,
+} satisfies GetPublicPortalBranding
+
+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 GetPublicPortalBranding
+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

@@ -9,6 +9,7 @@ All URIs are relative to *https://sbzw93t49b.execute-api.us-east-2.amazonaws.com
 | [**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 |
+| [**getPublicPortalBranding**](PortalApi.md#getpublicportalbranding) | **GET** /public/portal/branding | Public portal branding resolved from the request host |
 | [**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 |
@@ -354,6 +355,67 @@ 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)
 
 
+## getPublicPortalBranding
+
+> GetPublicPortalBranding getPublicPortalBranding()
+
+Public portal branding resolved from the request host
+
+Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  PortalApi,
+} from '@easyedu/js-lsm-api';
+import type { GetPublicPortalBrandingRequest } from '@easyedu/js-lsm-api';
+
+async function example() {
+  console.log("🚀 Testing @easyedu/js-lsm-api SDK...");
+  const api = new PortalApi();
+
+  try {
+    const data = await api.getPublicPortalBranding();
+    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
+
+[**GetPublicPortalBranding**](GetPublicPortalBranding.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Public portal branding |  -  |
+| **400** | Invalid portal host |  -  |
+| **404** | Portal host 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)
+
+
 ## inviteUserToPortal
 
 > inviteUserToPortal(portalId, postPortalInvite)

package/package.json

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

package/src/apis/PortalApi.ts

@@ -38,6 +38,11 @@ import {
     GetPortalUserListFromJSON,
     GetPortalUserListToJSON,
 } from '../models/GetPortalUserList';
+import {
+    type GetPublicPortalBranding,
+    GetPublicPortalBrandingFromJSON,
+    GetPublicPortalBrandingToJSON,
+} from '../models/GetPublicPortalBranding';
 import {
     type PostPortal,
     PostPortalFromJSON,
@@ -348,6 +353,45 @@ export class PortalApi extends runtime.BaseAPI {
         return await response.value();
     }
 
+    /**
+     * Creates request options for getPublicPortalBranding without sending the request
+     */
+    async getPublicPortalBrandingRequestOpts(): Promise<runtime.RequestOpts> {
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+
+        let urlPath = `/public/portal/branding`;
+
+        return {
+            path: urlPath,
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    async getPublicPortalBrandingRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<GetPublicPortalBranding>> {
+        const requestOptions = await this.getPublicPortalBrandingRequestOpts();
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => GetPublicPortalBrandingFromJSON(jsonValue));
+    }
+
+    /**
+     * Resolves the browser Origin/Referer/Host to a platform portal and returns branding for unauthenticated pages.
+     * Public portal branding resolved from the request host
+     */
+    async getPublicPortalBranding(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<GetPublicPortalBranding> {
+        const response = await this.getPublicPortalBrandingRaw(initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for inviteUserToPortal without sending the request
      */

package/src/models/GetPublicPortalBranding.ts

@@ -0,0 +1,120 @@
+/* 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';
+/**
+ * Public portal branding resolved from the browser host.
+ * @export
+ * @interface GetPublicPortalBranding
+ */
+export interface GetPublicPortalBranding {
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    id: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    slug: string | null;
+    /**
+     * Presigned portal logo URL when a logo is configured.
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    logoUrl: string | null;
+    /**
+     * Presigned portal favicon URL when a favicon is configured.
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    faviconUrl: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    headerBackgroundColor: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof GetPublicPortalBranding
+     */
+    headerTextColor: string;
+}
+
+/**
+ * Check if a given object implements the GetPublicPortalBranding interface.
+ */
+export function instanceOfGetPublicPortalBranding(value: object): value is GetPublicPortalBranding {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('slug' in value) || value['slug'] === undefined) return false;
+    if (!('logoUrl' in value) || value['logoUrl'] === undefined) return false;
+    if (!('faviconUrl' in value) || value['faviconUrl'] === undefined) return false;
+    if (!('headerBackgroundColor' in value) || value['headerBackgroundColor'] === undefined) return false;
+    if (!('headerTextColor' in value) || value['headerTextColor'] === undefined) return false;
+    return true;
+}
+
+export function GetPublicPortalBrandingFromJSON(json: any): GetPublicPortalBranding {
+    return GetPublicPortalBrandingFromJSONTyped(json, false);
+}
+
+export function GetPublicPortalBrandingFromJSONTyped(json: any, ignoreDiscriminator: boolean): GetPublicPortalBranding {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'id': json['id'],
+        'name': json['name'],
+        'slug': json['slug'],
+        'logoUrl': json['logo_url'],
+        'faviconUrl': json['favicon_url'],
+        'headerBackgroundColor': json['header_background_color'],
+        'headerTextColor': json['header_text_color'],
+    };
+}
+
+export function GetPublicPortalBrandingToJSON(json: any): GetPublicPortalBranding {
+    return GetPublicPortalBrandingToJSONTyped(json, false);
+}
+
+export function GetPublicPortalBrandingToJSONTyped(value?: GetPublicPortalBranding | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'id': value['id'],
+        'name': value['name'],
+        'slug': value['slug'],
+        'logo_url': value['logoUrl'],
+        'favicon_url': value['faviconUrl'],
+        'header_background_color': value['headerBackgroundColor'],
+        'header_text_color': value['headerTextColor'],
+    };
+}
+

package/src/models/index.ts

@@ -80,6 +80,7 @@ export * from './GetPortalStudentReportingCertificates';
 export * from './GetPortalStudentReportingPortalInfo';
 export * from './GetPortalUser';
 export * from './GetPortalUserList';
+export * from './GetPublicPortalBranding';
 export * from './GetQuestion';
 export * from './GetQuestionAnswerChoicesInner';
 export * from './GetQuestionList';