@knowledge-stack/ksapi 1.101.2 → 1.103.0

package/src/models/ApiKeyResponse.ts

@@ -43,6 +43,18 @@ export interface ApiKeyResponse {
      * @memberof ApiKeyResponse
      */
     createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyResponse
+     */
+    expiresAt: Date | null;
+    /**
+     * 
+     * @type {Date}
+     * @memberof ApiKeyResponse
+     */
+    lastUsedAt: Date | null;
 }
 export const ApiKeyResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -70,6 +82,8 @@ export function instanceOfApiKeyResponse(value: object): value is ApiKeyResponse
     if (!('name' in value) || value['name'] === undefined) return false;
     if (!('keySuffix' in value) || value['keySuffix'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
+    if (!('lastUsedAt' in value) || value['lastUsedAt'] === undefined) return false;
     return true;
 }
 
@@ -87,6 +101,8 @@ export function ApiKeyResponseFromJSONTyped(json: any, ignoreDiscriminator: bool
         'name': json['name'],
         'keySuffix': json['key_suffix'],
         'createdAt': (new Date(json['created_at'])),
+        'expiresAt': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
+        'lastUsedAt': (json['last_used_at'] == null ? null : new Date(json['last_used_at'])),
     };
 }
 
@@ -105,6 +121,8 @@ export function ApiKeyResponseToJSONTyped(value?: ApiKeyResponse | null, ignoreD
         'name': value['name'],
         'key_suffix': value['keySuffix'],
         'created_at': value['createdAt'].toISOString(),
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
+        'last_used_at': value['lastUsedAt'] == null ? value['lastUsedAt'] : value['lastUsedAt'].toISOString(),
     };
 }
 

package/src/models/CreateApiConnectionRequest.ts

@@ -0,0 +1,161 @@
+/* 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';
+import type { NetworkClass } from './NetworkClass';
+import {
+    NetworkClassFromJSON,
+    NetworkClassFromJSONTyped,
+    NetworkClassToJSON,
+    NetworkClassToJSONTyped,
+} from './NetworkClass';
+import type { ApiAuthConfig } from './ApiAuthConfig';
+import {
+    ApiAuthConfigFromJSON,
+    ApiAuthConfigFromJSONTyped,
+    ApiAuthConfigToJSON,
+    ApiAuthConfigToJSONTyped,
+} from './ApiAuthConfig';
+
+/**
+ * Create an API connection under a folder the caller can write to.
+ * @export
+ * @interface CreateApiConnectionRequest
+ */
+export interface CreateApiConnectionRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateApiConnectionRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateApiConnectionRequest
+     */
+    parentPathPartId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateApiConnectionRequest
+     */
+    baseUrl: string;
+    /**
+     * 
+     * @type {NetworkClass}
+     * @memberof CreateApiConnectionRequest
+     */
+    networkClass: NetworkClass;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateApiConnectionRequest
+     */
+    verifyTls?: boolean;
+    /**
+     * 
+     * @type {ApiAuthConfig}
+     * @memberof CreateApiConnectionRequest
+     */
+    authConfig: ApiAuthConfig;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateApiConnectionRequest
+     */
+    apiDocs?: string | null;
+}
+
+
+export const CreateApiConnectionRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    name: {
+        maxLength: 255,
+    },
+    baseUrl: {
+        maxLength: 2048,
+    },
+    apiDocs: {
+        maxLength: 100000,
+    },
+}
+
+
+/**
+ * Check if a given object implements the CreateApiConnectionRequest interface.
+ */
+export function instanceOfCreateApiConnectionRequest(value: object): value is CreateApiConnectionRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
+    if (!('baseUrl' in value) || value['baseUrl'] === undefined) return false;
+    if (!('networkClass' in value) || value['networkClass'] === undefined) return false;
+    if (!('authConfig' in value) || value['authConfig'] === undefined) return false;
+    return true;
+}
+
+export function CreateApiConnectionRequestFromJSON(json: any): CreateApiConnectionRequest {
+    return CreateApiConnectionRequestFromJSONTyped(json, false);
+}
+
+export function CreateApiConnectionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateApiConnectionRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'baseUrl': json['base_url'],
+        'networkClass': NetworkClassFromJSON(json['network_class']),
+        'verifyTls': json['verify_tls'] == null ? undefined : json['verify_tls'],
+        'authConfig': ApiAuthConfigFromJSON(json['auth_config']),
+        'apiDocs': json['api_docs'] == null ? undefined : json['api_docs'],
+    };
+}
+
+export function CreateApiConnectionRequestToJSON(json: any): CreateApiConnectionRequest {
+    return CreateApiConnectionRequestToJSONTyped(json, false);
+}
+
+export function CreateApiConnectionRequestToJSONTyped(value?: CreateApiConnectionRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'base_url': value['baseUrl'],
+        'network_class': NetworkClassToJSON(value['networkClass']),
+        'verify_tls': value['verifyTls'],
+        'auth_config': ApiAuthConfigToJSON(value['authConfig']),
+        'api_docs': value['apiDocs'],
+    };
+}
+

package/src/models/CreateApiKeyRequest.ts

@@ -25,6 +25,12 @@ export interface CreateApiKeyRequest {
      * @memberof CreateApiKeyRequest
      */
     name: string;
+    /**
+     * Optional absolute expiry. Null means the key never expires.
+     * @type {Date}
+     * @memberof CreateApiKeyRequest
+     */
+    expiresAt?: Date | null;
 }
 export const CreateApiKeyRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -67,6 +73,7 @@ export function CreateApiKeyRequestFromJSONTyped(json: any, ignoreDiscriminator:
     return {
         
         'name': json['name'],
+        'expiresAt': json['expires_at'] == null ? undefined : (new Date(json['expires_at'])),
     };
 }
 
@@ -82,6 +89,7 @@ export function CreateApiKeyRequestToJSONTyped(value?: CreateApiKeyRequest | nul
     return {
         
         'name': value['name'],
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
     };
 }
 

package/src/models/CreateApiKeyResponse.ts

@@ -49,6 +49,12 @@ export interface CreateApiKeyResponse {
      * @memberof CreateApiKeyResponse
      */
     createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof CreateApiKeyResponse
+     */
+    expiresAt: Date | null;
 }
 export const CreateApiKeyResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -77,6 +83,7 @@ export function instanceOfCreateApiKeyResponse(value: object): value is CreateAp
     if (!('key' in value) || value['key'] === undefined) return false;
     if (!('keySuffix' in value) || value['keySuffix'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('expiresAt' in value) || value['expiresAt'] === undefined) return false;
     return true;
 }
 
@@ -95,6 +102,7 @@ export function CreateApiKeyResponseFromJSONTyped(json: any, ignoreDiscriminator
         'key': json['key'],
         'keySuffix': json['key_suffix'],
         'createdAt': (new Date(json['created_at'])),
+        'expiresAt': (json['expires_at'] == null ? null : new Date(json['expires_at'])),
     };
 }
 
@@ -114,6 +122,7 @@ export function CreateApiKeyResponseToJSONTyped(value?: CreateApiKeyResponse | n
         'key': value['key'],
         'key_suffix': value['keySuffix'],
         'created_at': value['createdAt'].toISOString(),
+        'expires_at': value['expiresAt'] == null ? value['expiresAt'] : value['expiresAt'].toISOString(),
     };
 }
 

package/src/models/CreateWorkflowDefinitionRequest.ts

@@ -59,6 +59,12 @@ export interface CreateWorkflowDefinitionRequest {
      * @memberof CreateWorkflowDefinitionRequest
      */
     approvalRequired: boolean;
+    /**
+     * Create a non-runnable template. Templates are excluded from the default list and cannot have runs; users instantiate them into their own runnable workflow. Immutable after creation.
+     * @type {boolean}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    isTemplate?: boolean;
 }
 export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -113,6 +119,7 @@ export function CreateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
         'parentPathPartId': json['parent_path_part_id'],
         'instructionPathPartId': json['instruction_path_part_id'] == null ? undefined : json['instruction_path_part_id'],
         'approvalRequired': json['approval_required'],
+        'isTemplate': json['is_template'] == null ? undefined : json['is_template'],
     };
 }
 
@@ -133,6 +140,7 @@ export function CreateWorkflowDefinitionRequestToJSONTyped(value?: CreateWorkflo
         'parent_path_part_id': value['parentPathPartId'],
         'instruction_path_part_id': value['instructionPathPartId'],
         'approval_required': value['approvalRequired'],
+        'is_template': value['isTemplate'],
     };
 }
 

package/src/models/DataSourceQueryRequest.ts

@@ -15,6 +15,9 @@
 import { mapValues } from '../runtime';
 /**
  * A read-only SQL query the caller (or agent) wrote.
+ * 
+ * ``offset`` skips that many leading result rows, so callers can page through
+ * a large result a window of ``max_rows`` at a time.
  * @export
  * @interface DataSourceQueryRequest
  */
@@ -31,6 +34,12 @@ export interface DataSourceQueryRequest {
      * @memberof DataSourceQueryRequest
      */
     maxRows?: number;
+    /**
+     * 
+     * @type {number}
+     * @memberof DataSourceQueryRequest
+     */
+    offset?: number;
 }
 export const DataSourceQueryRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -53,6 +62,10 @@ export const DataSourceQueryRequestPropertyValidationAttributesMap: {
         minimum: 1,
         exclusiveMinimum: false,
     },
+    offset: {
+        minimum: 0,
+        exclusiveMinimum: false,
+    },
 }
 
 
@@ -76,6 +89,7 @@ export function DataSourceQueryRequestFromJSONTyped(json: any, ignoreDiscriminat
         
         'sql': json['sql'],
         'maxRows': json['max_rows'] == null ? undefined : json['max_rows'],
+        'offset': json['offset'] == null ? undefined : json['offset'],
     };
 }
 
@@ -92,6 +106,7 @@ export function DataSourceQueryRequestToJSONTyped(value?: DataSourceQueryRequest
         
         'sql': value['sql'],
         'max_rows': value['maxRows'],
+        'offset': value['offset'],
     };
 }
 

package/src/models/DataSourceQueryResponse.ts

@@ -15,6 +15,10 @@
 import { mapValues } from '../runtime';
 /**
  * Read-only query result. ``generated_sql`` echoes the executed SQL.
+ * 
+ * ``sql_validation_warnings`` lists non-blocking semantic-lint findings (e.g.
+ * aggregate without a filter, fan-out join); empty when the SQL is clean. The
+ * query still runs and returns rows regardless of warnings.
  * @export
  * @interface DataSourceQueryResponse
  */
@@ -49,6 +53,12 @@ export interface DataSourceQueryResponse {
      * @memberof DataSourceQueryResponse
      */
     generatedSql: string;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DataSourceQueryResponse
+     */
+    sqlValidationWarnings?: Array<string>;
 }
 export const DataSourceQueryResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -95,6 +105,7 @@ export function DataSourceQueryResponseFromJSONTyped(json: any, ignoreDiscrimina
         'rowCount': json['row_count'],
         'truncated': json['truncated'],
         'generatedSql': json['generated_sql'],
+        'sqlValidationWarnings': json['sql_validation_warnings'] == null ? undefined : json['sql_validation_warnings'],
     };
 }
 
@@ -114,6 +125,7 @@ export function DataSourceQueryResponseToJSONTyped(value?: DataSourceQueryRespon
         'row_count': value['rowCount'],
         'truncated': value['truncated'],
         'generated_sql': value['generatedSql'],
+        'sql_validation_warnings': value['sqlValidationWarnings'],
     };
 }
 

package/src/models/DataSourceResponse.ts

@@ -20,6 +20,13 @@ import {
     PathPartApprovalStateToJSON,
     PathPartApprovalStateToJSONTyped,
 } from './PathPartApprovalState';
+import type { UserInfo } from './UserInfo';
+import {
+    UserInfoFromJSON,
+    UserInfoFromJSONTyped,
+    UserInfoToJSON,
+    UserInfoToJSONTyped,
+} from './UserInfo';
 import type { DataSourceEngine } from './DataSourceEngine';
 import {
     DataSourceEngineFromJSON,
@@ -91,6 +98,12 @@ export interface DataSourceResponse {
      * @memberof DataSourceResponse
      */
     approvalState: PathPartApprovalState;
+    /**
+     * Current owner (creator) of the connector, or null if unowned.
+     * @type {UserInfo}
+     * @memberof DataSourceResponse
+     */
+    owner?: UserInfo | null;
     /**
      * 
      * @type {Date}
@@ -168,6 +181,7 @@ export function DataSourceResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'name': json['name'],
         'engine': DataSourceEngineFromJSON(json['engine']),
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
+        'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
     };
@@ -193,6 +207,7 @@ export function DataSourceResponseToJSONTyped(value?: DataSourceResponse | null,
         'name': value['name'],
         'engine': DataSourceEngineToJSON(value['engine']),
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
+        'owner': UserInfoToJSON(value['owner']),
         'created_at': value['createdAt'].toISOString(),
         'updated_at': value['updatedAt'].toISOString(),
     };

package/src/models/DocumentResponse.ts

@@ -161,11 +161,11 @@ export interface DocumentResponse {
      */
     tenantId: string;
     /**
-     * 
+     * Current owner (creator) of the document, or null if unowned. Transferable via PATCH by the current owner or an ADMIN/OWNER.
      * @type {UserInfo}
      * @memberof DocumentResponse
      */
-    owner: UserInfo;
+    owner?: UserInfo | null;
     /**
      * Creation timestamp
      * @type {Date}
@@ -243,7 +243,6 @@ export function instanceOfDocumentResponse(value: object): value is DocumentResp
     if (!('approvalState' in value) || value['approvalState'] === undefined) return false;
     if (!('excludeFromQdrant' in value) || value['excludeFromQdrant'] === undefined) return false;
     if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
-    if (!('owner' in value) || value['owner'] === undefined) return false;
     if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
     if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
     return true;
@@ -273,7 +272,7 @@ export function DocumentResponseFromJSONTyped(json: any, ignoreDiscriminator: bo
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
         'excludeFromQdrant': json['exclude_from_qdrant'],
         'tenantId': json['tenant_id'],
-        'owner': UserInfoFromJSON(json['owner']),
+        'owner': json['owner'] == null ? undefined : UserInfoFromJSON(json['owner']),
         'createdAt': (new Date(json['created_at'])),
         'updatedAt': (new Date(json['updated_at'])),
         'tags': json['tags'] == null ? undefined : ((json['tags'] as Array<any>).map(TagResponseFromJSON)),

package/src/models/DocumentVersionOrder.ts

@@ -0,0 +1,53 @@
+/* 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.
+ */
+
+
+/**
+ * Sortable fields for document version listings.
+ * @export
+ */
+export const DocumentVersionOrder = {
+    Version: 'VERSION',
+    CreatedAt: 'CREATED_AT'
+} as const;
+export type DocumentVersionOrder = typeof DocumentVersionOrder[keyof typeof DocumentVersionOrder];
+
+
+export function instanceOfDocumentVersionOrder(value: any): boolean {
+    for (const key in DocumentVersionOrder) {
+        if (Object.prototype.hasOwnProperty.call(DocumentVersionOrder, key)) {
+            if (DocumentVersionOrder[key as keyof typeof DocumentVersionOrder] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DocumentVersionOrderFromJSON(json: any): DocumentVersionOrder {
+    return DocumentVersionOrderFromJSONTyped(json, false);
+}
+
+export function DocumentVersionOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): DocumentVersionOrder {
+    return json as DocumentVersionOrder;
+}
+
+export function DocumentVersionOrderToJSON(value?: DocumentVersionOrder | null): any {
+    return value as any;
+}
+
+export function DocumentVersionOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): DocumentVersionOrder {
+    return value as DocumentVersionOrder;
+}
+

package/src/models/ErrorResponse.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * Standard error body returned for every non-2xx response.
+ * @export
+ * @interface ErrorResponse
+ */
+export interface ErrorResponse {
+    /**
+     * Human-readable explanation of the error.
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    detail: string;
+    /**
+     * Stable, machine-readable error code (e.g. 'not_found').
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    code: string;
+    /**
+     * Correlates to the x-request-id response header; quote it to support.
+     * @type {string}
+     * @memberof ErrorResponse
+     */
+    requestId?: string;
+}
+export const ErrorResponsePropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+}
+
+
+/**
+ * Check if a given object implements the ErrorResponse interface.
+ */
+export function instanceOfErrorResponse(value: object): value is ErrorResponse {
+    if (!('detail' in value) || value['detail'] === undefined) return false;
+    if (!('code' in value) || value['code'] === undefined) return false;
+    return true;
+}
+
+export function ErrorResponseFromJSON(json: any): ErrorResponse {
+    return ErrorResponseFromJSONTyped(json, false);
+}
+
+export function ErrorResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ErrorResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'detail': json['detail'],
+        'code': json['code'],
+        'requestId': json['request_id'] == null ? undefined : json['request_id'],
+    };
+}
+
+export function ErrorResponseToJSON(json: any): ErrorResponse {
+    return ErrorResponseToJSONTyped(json, false);
+}
+
+export function ErrorResponseToJSONTyped(value?: ErrorResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'detail': value['detail'],
+        'code': value['code'],
+        'request_id': value['requestId'],
+    };
+}
+

package/src/models/FeedbackOrder.ts

@@ -0,0 +1,52 @@
+/* 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.
+ */
+
+
+/**
+ * Sortable fields for feedback listings.
+ * @export
+ */
+export const FeedbackOrder = {
+    CreatedAt: 'CREATED_AT'
+} as const;
+export type FeedbackOrder = typeof FeedbackOrder[keyof typeof FeedbackOrder];
+
+
+export function instanceOfFeedbackOrder(value: any): boolean {
+    for (const key in FeedbackOrder) {
+        if (Object.prototype.hasOwnProperty.call(FeedbackOrder, key)) {
+            if (FeedbackOrder[key as keyof typeof FeedbackOrder] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function FeedbackOrderFromJSON(json: any): FeedbackOrder {
+    return FeedbackOrderFromJSONTyped(json, false);
+}
+
+export function FeedbackOrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): FeedbackOrder {
+    return json as FeedbackOrder;
+}
+
+export function FeedbackOrderToJSON(value?: FeedbackOrder | null): any {
+    return value as any;
+}
+
+export function FeedbackOrderToJSONTyped(value: any, ignoreDiscriminator: boolean): FeedbackOrder {
+    return value as FeedbackOrder;
+}
+