@knowledge-stack/ksapi 1.48.1 → 1.50.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';
@@ -44,6 +45,7 @@ export * from './FolderResponseOrDocumentResponse';
 export * from './HTTPValidationError';
 export * from './HealthCheckResponse';
 export * from './IdpType';
+export * from './ImageTaxonomy';
 export * from './IngestDocumentResponse';
 export * from './IngestionMode';
 export * from './InviteResponse';
@@ -96,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);
@@ -62,6 +63,7 @@ __exportStar(require("./FolderResponseOrDocumentResponse"), exports);
 __exportStar(require("./HTTPValidationError"), exports);
 __exportStar(require("./HealthCheckResponse"), exports);
 __exportStar(require("./IdpType"), exports);
+__exportStar(require("./ImageTaxonomy"), exports);
 __exportStar(require("./IngestDocumentResponse"), exports);
 __exportStar(require("./IngestionMode"), exports);
 __exportStar(require("./InviteResponse"), exports);
@@ -114,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/ChunkMetadataInput.md

@@ -12,6 +12,7 @@ Name | Type
 `summary` | string
 `ingestionMode` | [IngestionMode](IngestionMode.md)
 `extractedTextS3Uri` | string
+`secondaryTaxonomy` | [ImageTaxonomy](ImageTaxonomy.md)
 `sheetName` | string
 `blockType` | string
 `sourceUri` | string
@@ -34,6 +35,7 @@ const example = {
   "summary": null,
   "ingestionMode": null,
   "extractedTextS3Uri": null,
+  "secondaryTaxonomy": null,
   "sheetName": null,
   "blockType": null,
   "sourceUri": null,

package/docs/ChunkMetadataOutput.md

@@ -12,6 +12,7 @@ Name | Type
 `summary` | string
 `ingestionMode` | [IngestionMode](IngestionMode.md)
 `extractedTextS3Uri` | string
+`secondaryTaxonomy` | [ImageTaxonomy](ImageTaxonomy.md)
 `sheetName` | string
 `blockType` | string
 `sourceUri` | string
@@ -34,6 +35,7 @@ const example = {
   "summary": null,
   "ingestionMode": null,
   "extractedTextS3Uri": null,
+  "secondaryTaxonomy": null,
   "sheetName": null,
   "blockType": null,
   "sourceUri": null,

package/docs/DocumentsApi.md

@@ -241,7 +241,7 @@ No authorization required
 
 ## ingestDocument
 
-> IngestDocumentResponse ingestDocument(file, pathPartId, authorization, ksUat, name, ingestionMode, chunkType, pageDpi)
+> IngestDocumentResponse ingestDocument(file, pathPartId, authorization, ksUat, name, ingestionMode, chunkType, secondaryTaxonomy, pageDpi)
 
 Ingest Document Handler
 
@@ -275,6 +275,8 @@ async function example() {
     ingestionMode: ...,
     // ChunkType (optional)
     chunkType: ...,
+    // ImageTaxonomy (optional)
+    secondaryTaxonomy: ...,
     // number | DPI for PDF page screenshots (default 72, min 36, max 216). (optional)
     pageDpi: 56,
   } satisfies IngestDocumentRequest;
@@ -303,6 +305,7 @@ example().catch(console.error);
 | **name** | `string` | Document name (defaults to filename) | [Optional] [Defaults to `undefined`] |
 | **ingestionMode** | `IngestionMode` |  | [Optional] [Defaults to `undefined`] [Enum: document, single_chunk] |
 | **chunkType** | `ChunkType` |  | [Optional] [Defaults to `undefined`] [Enum: TEXT, TABLE, IMAGE, HTML, UNKNOWN] |
+| **secondaryTaxonomy** | `ImageTaxonomy` |  | [Optional] [Defaults to `undefined`] [Enum: picture, flowchart] |
 | **pageDpi** | `number` | DPI for PDF page screenshots (default 72, min 36, max 216). | [Optional] [Defaults to `72`] |
 
 ### Return type
@@ -330,7 +333,7 @@ No authorization required
 
 ## ingestDocumentVersion
 
-> IngestDocumentResponse ingestDocumentVersion(documentId, file, authorization, ksUat, ingestionMode, chunkType, pageDpi)
+> IngestDocumentResponse ingestDocumentVersion(documentId, file, authorization, ksUat, ingestionMode, chunkType, secondaryTaxonomy, pageDpi)
 
 Ingest Document Version Handler
 
@@ -362,6 +365,8 @@ async function example() {
     ingestionMode: ...,
     // ChunkType (optional)
     chunkType: ...,
+    // ImageTaxonomy (optional)
+    secondaryTaxonomy: ...,
     // number | DPI for PDF page screenshots (default 72, min 36, max 216). (optional)
     pageDpi: 56,
   } satisfies IngestDocumentVersionRequest;
@@ -389,6 +394,7 @@ example().catch(console.error);
 | **ksUat** | `string` |  | [Optional] [Defaults to `undefined`] |
 | **ingestionMode** | `IngestionMode` |  | [Optional] [Defaults to `undefined`] [Enum: document, single_chunk] |
 | **chunkType** | `ChunkType` |  | [Optional] [Defaults to `undefined`] [Enum: TEXT, TABLE, IMAGE, HTML, UNKNOWN] |
+| **secondaryTaxonomy** | `ImageTaxonomy` |  | [Optional] [Defaults to `undefined`] [Enum: picture, flowchart] |
 | **pageDpi** | `number` | DPI for PDF page screenshots (default 72, min 36, max 216). | [Optional] [Defaults to `72`] |
 
 ### Return type

package/docs/ImageTaxonomy.md

@@ -0,0 +1,33 @@
+
+# ImageTaxonomy
+
+Image classification taxonomy with prompt descriptions.
+
+## Properties
+
+Name | Type
+------------ | -------------
+
+## Example
+
+```typescript
+import type { ImageTaxonomy } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+} satisfies ImageTaxonomy
+
+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 ImageTaxonomy
+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)