@knowledge-stack/ksapi 1.49.0 → 1.51.0

package/src/apis/TenantsApi.ts

@@ -15,6 +15,7 @@
 
 import * as runtime from '../runtime';
 import type {
+  BrandingLogoType,
   CreateTenantRequest,
   HTTPValidationError,
   PaginatedResponseTenantResponse,
@@ -25,6 +26,8 @@ import type {
   UpdateTenantRequest,
 } from '../models/index';
 import {
+    BrandingLogoTypeFromJSON,
+    BrandingLogoTypeToJSON,
     CreateTenantRequestFromJSON,
     CreateTenantRequestToJSON,
     HTTPValidationErrorFromJSON,
@@ -55,6 +58,13 @@ export interface DeleteTenantRequest {
     ksUat?: string | null;
 }
 
+export interface DeleteTenantLogoRequest {
+    tenantId: string;
+    logoType?: BrandingLogoType;
+    authorization?: string | null;
+    ksUat?: string | null;
+}
+
 export interface DeleteTenantUserRequest {
     tenantId: string;
     userId: string;
@@ -98,6 +108,14 @@ export interface UpdateTenantUserRequest {
     ksUat?: string | null;
 }
 
+export interface UploadTenantLogoRequest {
+    tenantId: string;
+    file: Blob;
+    authorization?: string | null;
+    ksUat?: string | null;
+    logoType?: BrandingLogoType;
+}
+
 /**
  * TenantsApi - interface
  * 
@@ -161,6 +179,36 @@ export interface TenantsApiInterface {
      */
     deleteTenant(requestParameters: DeleteTenantRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
 
+    /**
+     * Creates request options for deleteTenantLogo without sending the request
+     * @param {string} tenantId 
+     * @param {BrandingLogoType} [logoType] 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @throws {RequiredError}
+     * @memberof TenantsApiInterface
+     */
+    deleteTenantLogoRequestOpts(requestParameters: DeleteTenantLogoRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Delete a branding logo.  Requires OWNER or ADMIN role.
+     * @summary Delete Tenant Logo
+     * @param {string} tenantId 
+     * @param {BrandingLogoType} [logoType] 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TenantsApiInterface
+     */
+    deleteTenantLogoRaw(requestParameters: DeleteTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantResponse>>;
+
+    /**
+     * Delete a branding logo.  Requires OWNER or ADMIN role.
+     * Delete Tenant Logo
+     */
+    deleteTenantLogo(requestParameters: DeleteTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse>;
+
     /**
      * Creates request options for deleteTenantUser without sending the request
      * @param {string} tenantId 
@@ -343,6 +391,38 @@ export interface TenantsApiInterface {
      */
     updateTenantUser(requestParameters: UpdateTenantUserRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantUserResponse>;
 
+    /**
+     * Creates request options for uploadTenantLogo without sending the request
+     * @param {string} tenantId 
+     * @param {Blob} file 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {BrandingLogoType} [logoType] 
+     * @throws {RequiredError}
+     * @memberof TenantsApiInterface
+     */
+    uploadTenantLogoRequestOpts(requestParameters: UploadTenantLogoRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * 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.
+     * @summary Upload Tenant Logo
+     * @param {string} tenantId 
+     * @param {Blob} file 
+     * @param {string} [authorization] 
+     * @param {string} [ksUat] 
+     * @param {BrandingLogoType} [logoType] 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof TenantsApiInterface
+     */
+    uploadTenantLogoRaw(requestParameters: UploadTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantResponse>>;
+
+    /**
+     * 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.
+     * Upload Tenant Logo
+     */
+    uploadTenantLogo(requestParameters: UploadTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse>;
+
 }
 
 /**
@@ -453,6 +533,61 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
         await this.deleteTenantRaw(requestParameters, initOverrides);
     }
 
+    /**
+     * Creates request options for deleteTenantLogo without sending the request
+     */
+    async deleteTenantLogoRequestOpts(requestParameters: DeleteTenantLogoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling deleteTenantLogo().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters['logoType'] != null) {
+            queryParameters['logo_type'] = requestParameters['logoType'];
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+
+        let urlPath = `/v1/tenants/{tenant_id}/branding/logo`;
+        urlPath = urlPath.replace(`{${"tenant_id"}}`, encodeURIComponent(String(requestParameters['tenantId'])));
+
+        return {
+            path: urlPath,
+            method: 'DELETE',
+            headers: headerParameters,
+            query: queryParameters,
+        };
+    }
+
+    /**
+     * Delete a branding logo.  Requires OWNER or ADMIN role.
+     * Delete Tenant Logo
+     */
+    async deleteTenantLogoRaw(requestParameters: DeleteTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantResponse>> {
+        const requestOptions = await this.deleteTenantLogoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TenantResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Delete a branding logo.  Requires OWNER or ADMIN role.
+     * Delete Tenant Logo
+     */
+    async deleteTenantLogo(requestParameters: DeleteTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse> {
+        const response = await this.deleteTenantLogoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Creates request options for deleteTenantUser without sending the request
      */
@@ -802,4 +937,87 @@ export class TenantsApi extends runtime.BaseAPI implements TenantsApiInterface {
         return await response.value();
     }
 
+    /**
+     * Creates request options for uploadTenantLogo without sending the request
+     */
+    async uploadTenantLogoRequestOpts(requestParameters: UploadTenantLogoRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['tenantId'] == null) {
+            throw new runtime.RequiredError(
+                'tenantId',
+                'Required parameter "tenantId" was null or undefined when calling uploadTenantLogo().'
+            );
+        }
+
+        if (requestParameters['file'] == null) {
+            throw new runtime.RequiredError(
+                'file',
+                'Required parameter "file" was null or undefined when calling uploadTenantLogo().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (requestParameters['authorization'] != null) {
+            headerParameters['authorization'] = String(requestParameters['authorization']);
+        }
+
+        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);
+        }
+
+        if (requestParameters['logoType'] != null) {
+            formParams.append('logo_type', requestParameters['logoType'] as any);
+        }
+
+
+        let urlPath = `/v1/tenants/{tenant_id}/branding/logo`;
+        urlPath = urlPath.replace(`{${"tenant_id"}}`, encodeURIComponent(String(requestParameters['tenantId'])));
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: formParams,
+        };
+    }
+
+    /**
+     * 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.
+     * Upload Tenant Logo
+     */
+    async uploadTenantLogoRaw(requestParameters: UploadTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<TenantResponse>> {
+        const requestOptions = await this.uploadTenantLogoRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => TenantResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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.
+     * Upload Tenant Logo
+     */
+    async uploadTenantLogo(requestParameters: UploadTenantLogoRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<TenantResponse> {
+        const response = await this.uploadTenantLogoRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
 }

package/src/models/BrandingLogoType.ts

@@ -0,0 +1,54 @@
+/* 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.
+ */
+
+
+/**
+ * Types of branding logos that can be uploaded.
+ * @export
+ */
+export const BrandingLogoType = {
+    Logo: 'logo',
+    LogoDark: 'logo_dark',
+    Favicon: 'favicon'
+} as const;
+export type BrandingLogoType = typeof BrandingLogoType[keyof typeof BrandingLogoType];
+
+
+export function instanceOfBrandingLogoType(value: any): boolean {
+    for (const key in BrandingLogoType) {
+        if (Object.prototype.hasOwnProperty.call(BrandingLogoType, key)) {
+            if (BrandingLogoType[key as keyof typeof BrandingLogoType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BrandingLogoTypeFromJSON(json: any): BrandingLogoType {
+    return BrandingLogoTypeFromJSONTyped(json, false);
+}
+
+export function BrandingLogoTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): BrandingLogoType {
+    return json as BrandingLogoType;
+}
+
+export function BrandingLogoTypeToJSON(value?: BrandingLogoType | null): any {
+    return value as any;
+}
+
+export function BrandingLogoTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): BrandingLogoType {
+    return value as BrandingLogoType;
+}
+

package/src/models/TenantBrandingResponse.ts

@@ -0,0 +1,122 @@
+/* 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.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * Resolved branding with presigned URLs instead of internal S3 URIs.
+ * @export
+ * @interface TenantBrandingResponse
+ */
+export interface TenantBrandingResponse {
+    /**
+     * Custom brand name for logo
+     * @type {string}
+     * @memberof TenantBrandingResponse
+     */
+    brandName?: string | null;
+    /**
+     * Primary brand hex color
+     * @type {string}
+     * @memberof TenantBrandingResponse
+     */
+    brandColor?: string | null;
+    /**
+     * Presigned URL for primary logo
+     * @type {string}
+     * @memberof TenantBrandingResponse
+     */
+    logoUrl?: string | null;
+    /**
+     * Presigned URL for dark-mode logo
+     * @type {string}
+     * @memberof TenantBrandingResponse
+     */
+    logoDarkUrl?: string | null;
+    /**
+     * Presigned URL for favicon
+     * @type {string}
+     * @memberof TenantBrandingResponse
+     */
+    faviconUrl?: string | null;
+    /**
+     * Custom CSS variable overrides
+     * @type {{ [key: string]: string; }}
+     * @memberof TenantBrandingResponse
+     */
+    themeOverrides?: { [key: string]: string; } | null;
+}
+
+/**
+ * Check if a given object implements the TenantBrandingResponse interface.
+ */
+export function instanceOfTenantBrandingResponse(value: object): value is TenantBrandingResponse {
+    return true;
+}
+
+export function TenantBrandingResponseFromJSON(json: any): TenantBrandingResponse {
+    return TenantBrandingResponseFromJSONTyped(json, false);
+}
+
+export function TenantBrandingResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantBrandingResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'brandName': json['brand_name'] == null ? undefined : json['brand_name'],
+        'brandColor': json['brand_color'] == null ? undefined : json['brand_color'],
+        'logoUrl': json['logo_url'] == null ? undefined : json['logo_url'],
+        'logoDarkUrl': json['logo_dark_url'] == null ? undefined : json['logo_dark_url'],
+        'faviconUrl': json['favicon_url'] == null ? undefined : json['favicon_url'],
+        'themeOverrides': json['theme_overrides'] == null ? undefined : json['theme_overrides'],
+    };
+}
+
+export function TenantBrandingResponseToJSON(json: any): TenantBrandingResponse {
+    return TenantBrandingResponseToJSONTyped(json, false);
+}
+
+export function TenantBrandingResponseToJSONTyped(value?: TenantBrandingResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'brand_name': value['brandName'],
+        'brand_color': value['brandColor'],
+        'logo_url': value['logoUrl'],
+        'logo_dark_url': value['logoDarkUrl'],
+        'favicon_url': value['faviconUrl'],
+        'theme_overrides': value['themeOverrides'],
+    };
+}
+
+export const TenantBrandingResponsePropertyValidationAttributesMap: {
+    [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/src/models/TenantResponse.ts

@@ -13,13 +13,20 @@
  */
 
 import { mapValues } from '../runtime';
-import type { TenantSettings } from './TenantSettings';
+import type { TenantBrandingResponse } from './TenantBrandingResponse';
 import {
-    TenantSettingsFromJSON,
-    TenantSettingsFromJSONTyped,
-    TenantSettingsToJSON,
-    TenantSettingsToJSONTyped,
-} from './TenantSettings';
+    TenantBrandingResponseFromJSON,
+    TenantBrandingResponseFromJSONTyped,
+    TenantBrandingResponseToJSON,
+    TenantBrandingResponseToJSONTyped,
+} from './TenantBrandingResponse';
+import type { TenantSettingsResponse } from './TenantSettingsResponse';
+import {
+    TenantSettingsResponseFromJSON,
+    TenantSettingsResponseFromJSONTyped,
+    TenantSettingsResponseToJSON,
+    TenantSettingsResponseToJSONTyped,
+} from './TenantSettingsResponse';
 
 /**
  * Tenant response model.
@@ -47,10 +54,16 @@ export interface TenantResponse {
     idpConfig?: { [key: string]: string; } | null;
     /**
      * 
-     * @type {TenantSettings}
+     * @type {TenantSettingsResponse}
+     * @memberof TenantResponse
+     */
+    settings: TenantSettingsResponse;
+    /**
+     * 
+     * @type {TenantBrandingResponse}
      * @memberof TenantResponse
      */
-    settings: TenantSettings;
+    branding?: TenantBrandingResponse;
 }
 
 /**
@@ -76,7 +89,8 @@ export function TenantResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'id': json['id'],
         'name': json['name'],
         'idpConfig': json['idp_config'] == null ? undefined : json['idp_config'],
-        'settings': TenantSettingsFromJSON(json['settings']),
+        'settings': TenantSettingsResponseFromJSON(json['settings']),
+        'branding': json['branding'] == null ? undefined : TenantBrandingResponseFromJSON(json['branding']),
     };
 }
 
@@ -94,7 +108,8 @@ export function TenantResponseToJSONTyped(value?: TenantResponse | null, ignoreD
         'id': value['id'],
         'name': value['name'],
         'idp_config': value['idpConfig'],
-        'settings': TenantSettingsToJSON(value['settings']),
+        'settings': TenantSettingsResponseToJSON(value['settings']),
+        'branding': TenantBrandingResponseToJSON(value['branding']),
     };
 }
 

package/src/models/{TenantSettings.ts → TenantSettingsResponse.ts}

@@ -22,54 +22,56 @@ import {
 } from './SupportedLanguage';
 
 /**
- * 
+ * Tenant settings as exposed via API (no internal S3 URIs).
  * @export
- * @interface TenantSettings
+ * @interface TenantSettingsResponse
  */
-export interface TenantSettings {
+export interface TenantSettingsResponse {
     /**
      * 
      * @type {SupportedLanguage}
-     * @memberof TenantSettings
+     * @memberof TenantSettingsResponse
      */
-    language?: SupportedLanguage;
+    language: SupportedLanguage;
     /**
      * Tenant description
      * @type {string}
-     * @memberof TenantSettings
+     * @memberof TenantSettingsResponse
      */
-    description?: string;
+    description: string;
 }
 
 
 
 /**
- * Check if a given object implements the TenantSettings interface.
+ * Check if a given object implements the TenantSettingsResponse interface.
  */
-export function instanceOfTenantSettings(value: object): value is TenantSettings {
+export function instanceOfTenantSettingsResponse(value: object): value is TenantSettingsResponse {
+    if (!('language' in value) || value['language'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
     return true;
 }
 
-export function TenantSettingsFromJSON(json: any): TenantSettings {
-    return TenantSettingsFromJSONTyped(json, false);
+export function TenantSettingsResponseFromJSON(json: any): TenantSettingsResponse {
+    return TenantSettingsResponseFromJSONTyped(json, false);
 }
 
-export function TenantSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantSettings {
+export function TenantSettingsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): TenantSettingsResponse {
     if (json == null) {
         return json;
     }
     return {
         
-        'language': json['language'] == null ? undefined : SupportedLanguageFromJSON(json['language']),
-        'description': json['description'] == null ? undefined : json['description'],
+        'language': SupportedLanguageFromJSON(json['language']),
+        'description': json['description'],
     };
 }
 
-export function TenantSettingsToJSON(json: any): TenantSettings {
-    return TenantSettingsToJSONTyped(json, false);
+export function TenantSettingsResponseToJSON(json: any): TenantSettingsResponse {
+    return TenantSettingsResponseToJSONTyped(json, false);
 }
 
-export function TenantSettingsToJSONTyped(value?: TenantSettings | null, ignoreDiscriminator: boolean = false): any {
+export function TenantSettingsResponseToJSONTyped(value?: TenantSettingsResponse | null, ignoreDiscriminator: boolean = false): any {
     if (value == null) {
         return value;
     }
@@ -81,7 +83,7 @@ export function TenantSettingsToJSONTyped(value?: TenantSettings | null, ignoreD
     };
 }
 
-export const TenantSettingsPropertyValidationAttributesMap: {
+export const TenantSettingsResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number,
         minLength?: number,

package/src/models/TenantSettingsUpdate.ts

@@ -39,6 +39,24 @@ 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;
 }
 
 
@@ -62,6 +80,9 @@ export function TenantSettingsUpdateFromJSONTyped(json: any, ignoreDiscriminator
         
         'language': json['language'] == null ? undefined : 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'],
     };
 }
 
@@ -78,6 +99,9 @@ export function TenantSettingsUpdateToJSONTyped(value?: TenantSettingsUpdate | n
         
         'language': SupportedLanguageToJSON(value['language']),
         'description': value['description'],
+        'brand_name': value['brandName'],
+        'brand_color': value['brandColor'],
+        'theme_overrides': value['themeOverrides'],
     };
 }
 

package/src/models/index.ts

@@ -3,6 +3,7 @@
 export * from './AcceptInviteResponse';
 export * from './ApiKeyResponse';
 export * from './Args';
+export * from './BrandingLogoType';
 export * from './BulkTagRequest';
 export * from './ChunkBulkResponse';
 export * from './ChunkContentItem';
@@ -99,8 +100,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';