@knowledge-stack/ksapi 1.49.0 → 1.51.0

package/dist/models/TenantResponse.js

@@ -19,7 +19,8 @@ exports.TenantResponseFromJSON = TenantResponseFromJSON;
 exports.TenantResponseFromJSONTyped = TenantResponseFromJSONTyped;
 exports.TenantResponseToJSON = TenantResponseToJSON;
 exports.TenantResponseToJSONTyped = TenantResponseToJSONTyped;
-const TenantSettings_1 = require("./TenantSettings");
+const TenantBrandingResponse_1 = require("./TenantBrandingResponse");
+const TenantSettingsResponse_1 = require("./TenantSettingsResponse");
 /**
  * Check if a given object implements the TenantResponse interface.
  */
@@ -43,7 +44,8 @@ function TenantResponseFromJSONTyped(json, ignoreDiscriminator) {
         'id': json['id'],
         'name': json['name'],
         'idpConfig': json['idp_config'] == null ? undefined : json['idp_config'],
-        'settings': (0, TenantSettings_1.TenantSettingsFromJSON)(json['settings']),
+        'settings': (0, TenantSettingsResponse_1.TenantSettingsResponseFromJSON)(json['settings']),
+        'branding': json['branding'] == null ? undefined : (0, TenantBrandingResponse_1.TenantBrandingResponseFromJSON)(json['branding']),
     };
 }
 function TenantResponseToJSON(json) {
@@ -57,7 +59,8 @@ function TenantResponseToJSONTyped(value, ignoreDiscriminator = false) {
         'id': value['id'],
         'name': value['name'],
         'idp_config': value['idpConfig'],
-        'settings': (0, TenantSettings_1.TenantSettingsToJSON)(value['settings']),
+        'settings': (0, TenantSettingsResponse_1.TenantSettingsResponseToJSON)(value['settings']),
+        'branding': (0, TenantBrandingResponse_1.TenantBrandingResponseToJSON)(value['branding']),
     };
 }
 exports.TenantResponsePropertyValidationAttributesMap = {};

package/dist/models/TenantSettingsResponse.d.ts

@@ -0,0 +1,54 @@
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.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 type { SupportedLanguage } from './SupportedLanguage';
+/**
+ * Tenant settings as exposed via API (no internal S3 URIs).
+ * @export
+ * @interface TenantSettingsResponse
+ */
+export interface TenantSettingsResponse {
+    /**
+     *
+     * @type {SupportedLanguage}
+     * @memberof TenantSettingsResponse
+     */
+    language: SupportedLanguage;
+    /**
+     * Tenant description
+     * @type {string}
+     * @memberof TenantSettingsResponse
+     */
+    description: string;
+}
+/**
+ * Check if a given object implements the TenantSettingsResponse interface.
+ */
+export declare function instanceOfTenantSettingsResponse(value: object): value is TenantSettingsResponse;
+export declare function TenantSettingsResponseFromJSON(json: any): TenantSettingsResponse;
+export declare function TenantSettingsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantSettingsResponse;
+export declare function TenantSettingsResponseToJSON(json: any): TenantSettingsResponse;
+export declare function TenantSettingsResponseToJSONTyped(value?: TenantSettingsResponse | null, ignoreDiscriminator?: boolean): any;
+export declare const TenantSettingsResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number;
+        minLength?: number;
+        pattern?: string;
+        maximum?: number;
+        exclusiveMaximum?: boolean;
+        minimum?: number;
+        exclusiveMinimum?: boolean;
+        multipleOf?: number;
+        maxItems?: number;
+        minItems?: number;
+        uniqueItems?: boolean;
+    };
+};

package/dist/models/TenantSettingsResponse.js

@@ -0,0 +1,57 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Knowledge Stack API
+ * Knowledge Stack backend API for authentication and knowledge management
+ *
+ * The version of the OpenAPI document: 0.1.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.TenantSettingsResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfTenantSettingsResponse = instanceOfTenantSettingsResponse;
+exports.TenantSettingsResponseFromJSON = TenantSettingsResponseFromJSON;
+exports.TenantSettingsResponseFromJSONTyped = TenantSettingsResponseFromJSONTyped;
+exports.TenantSettingsResponseToJSON = TenantSettingsResponseToJSON;
+exports.TenantSettingsResponseToJSONTyped = TenantSettingsResponseToJSONTyped;
+const SupportedLanguage_1 = require("./SupportedLanguage");
+/**
+ * Check if a given object implements the TenantSettingsResponse interface.
+ */
+function instanceOfTenantSettingsResponse(value) {
+    if (!('language' in value) || value['language'] === undefined)
+        return false;
+    if (!('description' in value) || value['description'] === undefined)
+        return false;
+    return true;
+}
+function TenantSettingsResponseFromJSON(json) {
+    return TenantSettingsResponseFromJSONTyped(json, false);
+}
+function TenantSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'language': (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['language']),
+        'description': json['description'],
+    };
+}
+function TenantSettingsResponseToJSON(json) {
+    return TenantSettingsResponseToJSONTyped(json, false);
+}
+function TenantSettingsResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['language']),
+        'description': value['description'],
+    };
+}
+exports.TenantSettingsResponsePropertyValidationAttributesMap = {};

package/dist/models/TenantSettingsUpdate.d.ts

@@ -28,6 +28,26 @@ export interface TenantSettingsUpdate {
      * @memberof TenantSettingsUpdate
      */
     description?: string | null;
+    /**
+     * Custom brand name for logo
+     * @type {string}
+     * @memberof TenantSettingsUpdate
+     */
+    brandName?: string | null;
+    /**
+     * Primary brand hex color (e.g. '#2563eb')
+     * @type {string}
+     * @memberof TenantSettingsUpdate
+     */
+    brandColor?: string | null;
+    /**
+     * Custom CSS variable overrides
+     * @type {{ [key: string]: string; }}
+     * @memberof TenantSettingsUpdate
+     */
+    themeOverrides?: {
+        [key: string]: string;
+    } | null;
 }
 /**
  * Check if a given object implements the TenantSettingsUpdate interface.

package/dist/models/TenantSettingsUpdate.js

@@ -36,6 +36,9 @@ function TenantSettingsUpdateFromJSONTyped(json, ignoreDiscriminator) {
     return {
         'language': json['language'] == null ? undefined : (0, SupportedLanguage_1.SupportedLanguageFromJSON)(json['language']),
         'description': json['description'] == null ? undefined : json['description'],
+        'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
+        'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
+        'themeOverrides': json['theme_overrides'] == null ? undefined : json['theme_overrides'],
     };
 }
 function TenantSettingsUpdateToJSON(json) {
@@ -48,6 +51,9 @@ function TenantSettingsUpdateToJSONTyped(value, ignoreDiscriminator = false) {
     return {
         'language': (0, SupportedLanguage_1.SupportedLanguageToJSON)(value['language']),
         'description': value['description'],
+        'brand_name': value['brandName'],
+        'brand_color': value['brandColor'],
+        'theme_overrides': value['themeOverrides'],
     };
 }
 exports.TenantSettingsUpdatePropertyValidationAttributesMap = {};

package/dist/models/index.d.ts

@@ -1,6 +1,7 @@
 export * from './AcceptInviteResponse';
 export * from './ApiKeyResponse';
 export * from './Args';
+export * from './BrandingLogoType';
 export * from './BulkTagRequest';
 export * from './ChunkBulkResponse';
 export * from './ChunkContentItem';
@@ -97,8 +98,9 @@ export * from './SubtreeChunkGroup';
 export * from './SubtreeChunksResponse';
 export * from './SupportedLanguage';
 export * from './TagResponse';
+export * from './TenantBrandingResponse';
 export * from './TenantResponse';
-export * from './TenantSettings';
+export * from './TenantSettingsResponse';
 export * from './TenantSettingsUpdate';
 export * from './TenantUserEditRequest';
 export * from './TenantUserResponse';

package/dist/models/index.js

@@ -19,6 +19,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 __exportStar(require("./AcceptInviteResponse"), exports);
 __exportStar(require("./ApiKeyResponse"), exports);
 __exportStar(require("./Args"), exports);
+__exportStar(require("./BrandingLogoType"), exports);
 __exportStar(require("./BulkTagRequest"), exports);
 __exportStar(require("./ChunkBulkResponse"), exports);
 __exportStar(require("./ChunkContentItem"), exports);
@@ -115,8 +116,9 @@ __exportStar(require("./SubtreeChunkGroup"), exports);
 __exportStar(require("./SubtreeChunksResponse"), exports);
 __exportStar(require("./SupportedLanguage"), exports);
 __exportStar(require("./TagResponse"), exports);
+__exportStar(require("./TenantBrandingResponse"), exports);
 __exportStar(require("./TenantResponse"), exports);
-__exportStar(require("./TenantSettings"), exports);
+__exportStar(require("./TenantSettingsResponse"), exports);
 __exportStar(require("./TenantSettingsUpdate"), exports);
 __exportStar(require("./TenantUserEditRequest"), exports);
 __exportStar(require("./TenantUserResponse"), exports);

package/docs/BrandingLogoType.md

@@ -0,0 +1,33 @@
+
+# BrandingLogoType
+
+Types of branding logos that can be uploaded.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { BrandingLogoType } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies BrandingLogoType
+
+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 BrandingLogoType
+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/TenantBrandingResponse.md

@@ -0,0 +1,45 @@
+
+# TenantBrandingResponse
+
+Resolved branding with presigned URLs instead of internal S3 URIs.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`brandName` | string
+`brandColor` | string
+`logoUrl` | string
+`logoDarkUrl` | string
+`faviconUrl` | string
+`themeOverrides` | { [key: string]: string; }
+
+## Example
+
+```typescript
+import type { TenantBrandingResponse } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "brandName": null,
+  "brandColor": null,
+  "logoUrl": null,
+  "logoDarkUrl": null,
+  "faviconUrl": null,
+  "themeOverrides": null,
+} satisfies TenantBrandingResponse
+
+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 TenantBrandingResponse
+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/TenantResponse.md

@@ -10,7 +10,8 @@ Name | Type
 `id` | string
 `name` | string
 `idpConfig` | { [key: string]: string; }
-`settings` | [TenantSettings](TenantSettings.md)
+`settings` | [TenantSettingsResponse](TenantSettingsResponse.md)
+`branding` | [TenantBrandingResponse](TenantBrandingResponse.md)
 
 ## Example
 
@@ -23,6 +24,7 @@ const example = {
   "name": null,
   "idpConfig": null,
   "settings": null,
+  "branding": null,
 } satisfies TenantResponse
 
 console.log(example)

package/docs/{TenantSettings.md → TenantSettingsResponse.md}

@@ -1,6 +1,7 @@
 
-# TenantSettings
+# TenantSettingsResponse
 
+Tenant settings as exposed via API (no internal S3 URIs).
 
 ## Properties
 
@@ -12,13 +13,13 @@ Name | Type
 ## Example
 
 ```typescript
-import type { TenantSettings } from '@knowledge-stack/ksapi'
+import type { TenantSettingsResponse } from '@knowledge-stack/ksapi'
 
 // TODO: Update the object below with actual values
 const example = {
   "language": null,
   "description": null,
-} satisfies TenantSettings
+} satisfies TenantSettingsResponse
 
 console.log(example)
 
@@ -27,7 +28,7 @@ const exampleJSON: string = JSON.stringify(example)
 console.log(exampleJSON)
 
 // Parse the JSON string back to an object
-const exampleParsed = JSON.parse(exampleJSON) as TenantSettings
+const exampleParsed = JSON.parse(exampleJSON) as TenantSettingsResponse
 console.log(exampleParsed)
 ```
 

package/docs/TenantSettingsUpdate.md

@@ -9,6 +9,9 @@ Name | Type
 ------------ | -------------
 `language` | [SupportedLanguage](SupportedLanguage.md)
 `description` | string
+`brandName` | string
+`brandColor` | string
+`themeOverrides` | { [key: string]: string; }
 
 ## Example
 
@@ -19,6 +22,9 @@ import type { TenantSettingsUpdate } from '@knowledge-stack/ksapi'
 const example = {
   "language": null,
   "description": null,
+  "brandName": null,
+  "brandColor": null,
+  "themeOverrides": null,
 } satisfies TenantSettingsUpdate
 
 console.log(example)

package/docs/TenantsApi.md

@@ -6,12 +6,14 @@ All URIs are relative to *http://localhost:8000*
 |------------- | ------------- | -------------|
 | [**createTenant**](TenantsApi.md#createtenantoperation) | **POST** /v1/tenants | Create Tenant |
 | [**deleteTenant**](TenantsApi.md#deletetenant) | **DELETE** /v1/tenants/{tenant_id} | Delete Tenant |
+| [**deleteTenantLogo**](TenantsApi.md#deletetenantlogo) | **DELETE** /v1/tenants/{tenant_id}/branding/logo | Delete Tenant Logo |
 | [**deleteTenantUser**](TenantsApi.md#deletetenantuser) | **DELETE** /v1/tenants/{tenant_id}/users/{user_id} | Delete Tenant User |
 | [**getTenant**](TenantsApi.md#gettenant) | **GET** /v1/tenants/{tenant_id} | Get Tenant |
 | [**listTenantUsers**](TenantsApi.md#listtenantusers) | **GET** /v1/tenants/{tenant_id}/users | List Tenant Users |
 | [**listTenants**](TenantsApi.md#listtenants) | **GET** /v1/tenants | List Tenants |
 | [**updateTenant**](TenantsApi.md#updatetenantoperation) | **PATCH** /v1/tenants/{tenant_id} | Update Tenant |
 | [**updateTenantUser**](TenantsApi.md#updatetenantuser) | **PATCH** /v1/tenants/{tenant_id}/users/{user_id} | Update Tenant User |
+| [**uploadTenantLogo**](TenantsApi.md#uploadtenantlogo) | **POST** /v1/tenants/{tenant_id}/branding/logo | Upload Tenant Logo |
 
 
 
@@ -163,6 +165,83 @@ 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)
 
 
+## deleteTenantLogo
+
+> TenantResponse deleteTenantLogo(tenantId, logoType, authorization, ksUat)
+
+Delete Tenant Logo
+
+Delete a branding logo.  Requires OWNER or ADMIN role.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { DeleteTenantLogoRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // BrandingLogoType (optional)
+    logoType: ...,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+  } satisfies DeleteTenantLogoRequest;
+
+  try {
+    const data = await api.deleteTenantLogo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **logoType** | `BrandingLogoType` |  | [Optional] [Defaults to `undefined`] [Enum: logo, logo_dark, favicon] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+
+### Return type
+
+[**TenantResponse**](TenantResponse.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+
 ## deleteTenantUser
 
 > deleteTenantUser(tenantId, userId, authorization, ksUat)
@@ -627,3 +706,83 @@ 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)
 
+
+## uploadTenantLogo
+
+> TenantResponse uploadTenantLogo(tenantId, file, authorization, ksUat, logoType)
+
+Upload Tenant Logo
+
+Upload a branding logo (primary, dark-mode variant, or favicon).  Requires OWNER or ADMIN role. Accepted image types: PNG, JPEG, SVG, WebP, ICO. Max 2 MB.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  TenantsApi,
+} from '@knowledge-stack/ksapi';
+import type { UploadTenantLogoRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const api = new TenantsApi();
+
+  const body = {
+    // string
+    tenantId: 38400000-8cf0-11bd-b23e-10b96e4ef00d,
+    // Blob
+    file: BINARY_DATA_HERE,
+    // string (optional)
+    authorization: authorization_example,
+    // string (optional)
+    ksUat: ksUat_example,
+    // BrandingLogoType (optional)
+    logoType: ...,
+  } satisfies UploadTenantLogoRequest;
+
+  try {
+    const data = await api.uploadTenantLogo(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **tenantId** | `string` |  | [Defaults to `undefined`] |
+| **file** | `Blob` |  | [Defaults to `undefined`] |
+| **authorization** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
+| **logoType** | `BrandingLogoType` |  | [Optional] [Defaults to `undefined`] [Enum: logo, logo_dark, favicon] |
+
+### Return type
+
+[**TenantResponse**](TenantResponse.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** | Successful Response |  -  |
+| **422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.49.0",
+  "version": "1.51.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {