@knowledge-stack/ksapi 1.95.4 → 1.97.0

package/src/models/ColumnConfig.ts

@@ -0,0 +1,115 @@
+/* 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';
+/**
+ * A modeled column. Only ``exposed`` columns are surfaced to the agent.
+ * @export
+ * @interface ColumnConfig
+ */
+export interface ColumnConfig {
+    /**
+     * 
+     * @type {string}
+     * @memberof ColumnConfig
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ColumnConfig
+     */
+    dataType?: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ColumnConfig
+     */
+    comment?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ColumnConfig
+     */
+    isPk?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof ColumnConfig
+     */
+    exposed?: boolean;
+}
+export const ColumnConfigPropertyValidationAttributesMap: {
+    [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 ColumnConfig interface.
+ */
+export function instanceOfColumnConfig(value: object): value is ColumnConfig {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    return true;
+}
+
+export function ColumnConfigFromJSON(json: any): ColumnConfig {
+    return ColumnConfigFromJSONTyped(json, false);
+}
+
+export function ColumnConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ColumnConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'dataType': json['data_type'] == null ? undefined : json['data_type'],
+        'comment': json['comment'] == null ? undefined : json['comment'],
+        'isPk': json['is_pk'] == null ? undefined : json['is_pk'],
+        'exposed': json['exposed'] == null ? undefined : json['exposed'],
+    };
+}
+
+export function ColumnConfigToJSON(json: any): ColumnConfig {
+    return ColumnConfigToJSONTyped(json, false);
+}
+
+export function ColumnConfigToJSONTyped(value?: ColumnConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'data_type': value['dataType'],
+        'comment': value['comment'],
+        'is_pk': value['isPk'],
+        'exposed': value['exposed'],
+    };
+}
+

package/src/models/ConnectionConfig.ts

@@ -0,0 +1,118 @@
+/* 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';
+/**
+ * Connector connection parameters. ``password`` is write-only.
+ * @export
+ * @interface ConnectionConfig
+ */
+export interface ConnectionConfig {
+    /**
+     * 
+     * @type {string}
+     * @memberof ConnectionConfig
+     */
+    host: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof ConnectionConfig
+     */
+    port?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConnectionConfig
+     */
+    database: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConnectionConfig
+     */
+    username: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof ConnectionConfig
+     */
+    password: string;
+}
+export const ConnectionConfigPropertyValidationAttributesMap: {
+    [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 ConnectionConfig interface.
+ */
+export function instanceOfConnectionConfig(value: object): value is ConnectionConfig {
+    if (!('host' in value) || value['host'] === undefined) return false;
+    if (!('database' in value) || value['database'] === undefined) return false;
+    if (!('username' in value) || value['username'] === undefined) return false;
+    if (!('password' in value) || value['password'] === undefined) return false;
+    return true;
+}
+
+export function ConnectionConfigFromJSON(json: any): ConnectionConfig {
+    return ConnectionConfigFromJSONTyped(json, false);
+}
+
+export function ConnectionConfigFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConnectionConfig {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'host': json['host'],
+        'port': json['port'] == null ? undefined : json['port'],
+        'database': json['database'],
+        'username': json['username'],
+        'password': json['password'],
+    };
+}
+
+export function ConnectionConfigToJSON(json: any): ConnectionConfig {
+    return ConnectionConfigToJSONTyped(json, false);
+}
+
+export function ConnectionConfigToJSONTyped(value?: ConnectionConfig | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'host': value['host'],
+        'port': value['port'],
+        'database': value['database'],
+        'username': value['username'],
+        'password': value['password'],
+    };
+}
+

package/src/models/CreateDataSourceRequest.ts

@@ -0,0 +1,130 @@
+/* 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 { ConnectionConfig } from './ConnectionConfig';
+import {
+    ConnectionConfigFromJSON,
+    ConnectionConfigFromJSONTyped,
+    ConnectionConfigToJSON,
+    ConnectionConfigToJSONTyped,
+} from './ConnectionConfig';
+import type { DataSourceEngine } from './DataSourceEngine';
+import {
+    DataSourceEngineFromJSON,
+    DataSourceEngineFromJSONTyped,
+    DataSourceEngineToJSON,
+    DataSourceEngineToJSONTyped,
+} from './DataSourceEngine';
+
+/**
+ * Create a connector under a folder the caller can write to.
+ * @export
+ * @interface CreateDataSourceRequest
+ */
+export interface CreateDataSourceRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDataSourceRequest
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof CreateDataSourceRequest
+     */
+    parentPathPartId: string;
+    /**
+     * 
+     * @type {DataSourceEngine}
+     * @memberof CreateDataSourceRequest
+     */
+    engine: DataSourceEngine;
+    /**
+     * 
+     * @type {ConnectionConfig}
+     * @memberof CreateDataSourceRequest
+     */
+    connectionConfig: ConnectionConfig;
+}
+
+
+export const CreateDataSourceRequestPropertyValidationAttributesMap: {
+    [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,
+    },
+}
+
+
+/**
+ * Check if a given object implements the CreateDataSourceRequest interface.
+ */
+export function instanceOfCreateDataSourceRequest(value: object): value is CreateDataSourceRequest {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
+    if (!('engine' in value) || value['engine'] === undefined) return false;
+    if (!('connectionConfig' in value) || value['connectionConfig'] === undefined) return false;
+    return true;
+}
+
+export function CreateDataSourceRequestFromJSON(json: any): CreateDataSourceRequest {
+    return CreateDataSourceRequestFromJSONTyped(json, false);
+}
+
+export function CreateDataSourceRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): CreateDataSourceRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'engine': DataSourceEngineFromJSON(json['engine']),
+        'connectionConfig': ConnectionConfigFromJSON(json['connection_config']),
+    };
+}
+
+export function CreateDataSourceRequestToJSON(json: any): CreateDataSourceRequest {
+    return CreateDataSourceRequestToJSONTyped(json, false);
+}
+
+export function CreateDataSourceRequestToJSONTyped(value?: CreateDataSourceRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'engine': DataSourceEngineToJSON(value['engine']),
+        'connection_config': ConnectionConfigToJSON(value['connectionConfig']),
+    };
+}
+

package/src/models/CreateGroupPermissionRequest.ts

@@ -39,6 +39,12 @@ export interface CreateGroupPermissionRequest {
      * @memberof CreateGroupPermissionRequest
      */
     capability: PermissionCapability;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreateGroupPermissionRequest
+     */
+    canApprove?: boolean;
 }
 
 
@@ -81,6 +87,7 @@ export function CreateGroupPermissionRequestFromJSONTyped(json: any, ignoreDiscr
         
         'pathPartId': json['path_part_id'],
         'capability': PermissionCapabilityFromJSON(json['capability']),
+        'canApprove': json['can_approve'] == null ? undefined : json['can_approve'],
     };
 }
 
@@ -97,6 +104,7 @@ export function CreateGroupPermissionRequestToJSONTyped(value?: CreateGroupPermi
         
         'path_part_id': value['pathPartId'],
         'capability': PermissionCapabilityToJSON(value['capability']),
+        'can_approve': value['canApprove'],
     };
 }
 

package/src/models/CreatePermissionRequest.ts

@@ -51,6 +51,12 @@ export interface CreatePermissionRequest {
      * @memberof CreatePermissionRequest
      */
     capability: PermissionCapability;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CreatePermissionRequest
+     */
+    canApprove?: boolean;
 }
 
 
@@ -97,6 +103,7 @@ export function CreatePermissionRequestFromJSONTyped(json: any, ignoreDiscrimina
         'userId': json['user_id'],
         'pathPartId': json['path_part_id'],
         'capability': PermissionCapabilityFromJSON(json['capability']),
+        'canApprove': json['can_approve'] == null ? undefined : json['can_approve'],
     };
 }
 
@@ -115,6 +122,7 @@ export function CreatePermissionRequestToJSONTyped(value?: CreatePermissionReque
         'user_id': value['userId'],
         'path_part_id': value['pathPartId'],
         'capability': PermissionCapabilityToJSON(value['capability']),
+        'can_approve': value['canApprove'],
     };
 }
 

package/src/models/CreateWorkflowDefinitionRequest.ts

@@ -41,6 +41,12 @@ export interface CreateWorkflowDefinitionRequest {
      * @memberof CreateWorkflowDefinitionRequest
      */
     maxRunDurationSeconds?: number;
+    /**
+     * The ``path_part_id`` of the folder the workflow is created under (the folder's PathPart id, not the Folder PDO id). The caller needs write access to it; the workflow may live anywhere in the path tree.
+     * @type {string}
+     * @memberof CreateWorkflowDefinitionRequest
+     */
+    parentPathPartId: string;
     /**
      * DOCUMENT path_part of the instruction document. Omit (or pass null) to have the server auto-create an empty instruction.md.
      * @type {string}
@@ -86,6 +92,7 @@ export const CreateWorkflowDefinitionRequestPropertyValidationAttributesMap: {
  */
 export function instanceOfCreateWorkflowDefinitionRequest(value: object): value is CreateWorkflowDefinitionRequest {
     if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
     if (!('approvalRequired' in value) || value['approvalRequired'] === undefined) return false;
     return true;
 }
@@ -103,6 +110,7 @@ export function CreateWorkflowDefinitionRequestFromJSONTyped(json: any, ignoreDi
         'name': json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'maxRunDurationSeconds': json['max_run_duration_seconds'] == null ? undefined : json['max_run_duration_seconds'],
+        'parentPathPartId': json['parent_path_part_id'],
         'instructionPathPartId': json['instruction_path_part_id'] == null ? undefined : json['instruction_path_part_id'],
         'approvalRequired': json['approval_required'],
     };
@@ -122,6 +130,7 @@ export function CreateWorkflowDefinitionRequestToJSONTyped(value?: CreateWorkflo
         'name': value['name'],
         'description': value['description'],
         'max_run_duration_seconds': value['maxRunDurationSeconds'],
+        'parent_path_part_id': value['parentPathPartId'],
         'instruction_path_part_id': value['instructionPathPartId'],
         'approval_required': value['approvalRequired'],
     };

package/src/models/DataSourceCatalogResponse.ts

@@ -0,0 +1,91 @@
+/* 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 { CatalogTableResponse } from './CatalogTableResponse';
+import {
+    CatalogTableResponseFromJSON,
+    CatalogTableResponseFromJSONTyped,
+    CatalogTableResponseToJSON,
+    CatalogTableResponseToJSONTyped,
+} from './CatalogTableResponse';
+
+/**
+ * Live introspection of the external DB (pick tables to model from here).
+ * @export
+ * @interface DataSourceCatalogResponse
+ */
+export interface DataSourceCatalogResponse {
+    /**
+     * 
+     * @type {Array<CatalogTableResponse>}
+     * @memberof DataSourceCatalogResponse
+     */
+    tables: Array<CatalogTableResponse>;
+}
+export const DataSourceCatalogResponsePropertyValidationAttributesMap: {
+    [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 DataSourceCatalogResponse interface.
+ */
+export function instanceOfDataSourceCatalogResponse(value: object): value is DataSourceCatalogResponse {
+    if (!('tables' in value) || value['tables'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceCatalogResponseFromJSON(json: any): DataSourceCatalogResponse {
+    return DataSourceCatalogResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceCatalogResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceCatalogResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tables': ((json['tables'] as Array<any>).map(CatalogTableResponseFromJSON)),
+    };
+}
+
+export function DataSourceCatalogResponseToJSON(json: any): DataSourceCatalogResponse {
+    return DataSourceCatalogResponseToJSONTyped(json, false);
+}
+
+export function DataSourceCatalogResponseToJSONTyped(value?: DataSourceCatalogResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tables': ((value['tables'] as Array<any>).map(CatalogTableResponseToJSON)),
+    };
+}
+

package/src/models/DataSourceDetailResponse.ts

@@ -0,0 +1,107 @@
+/* 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 { DataSourceResponse } from './DataSourceResponse';
+import {
+    DataSourceResponseFromJSON,
+    DataSourceResponseFromJSONTyped,
+    DataSourceResponseToJSON,
+    DataSourceResponseToJSONTyped,
+} from './DataSourceResponse';
+import type { DataSourceTableResponse } from './DataSourceTableResponse';
+import {
+    DataSourceTableResponseFromJSON,
+    DataSourceTableResponseFromJSONTyped,
+    DataSourceTableResponseToJSON,
+    DataSourceTableResponseToJSONTyped,
+} from './DataSourceTableResponse';
+
+/**
+ * A connector plus the modeled tables the caller can read (describe).
+ * @export
+ * @interface DataSourceDetailResponse
+ */
+export interface DataSourceDetailResponse {
+    /**
+     * 
+     * @type {DataSourceResponse}
+     * @memberof DataSourceDetailResponse
+     */
+    dataSource: DataSourceResponse;
+    /**
+     * 
+     * @type {Array<DataSourceTableResponse>}
+     * @memberof DataSourceDetailResponse
+     */
+    tables: Array<DataSourceTableResponse>;
+}
+export const DataSourceDetailResponsePropertyValidationAttributesMap: {
+    [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 DataSourceDetailResponse interface.
+ */
+export function instanceOfDataSourceDetailResponse(value: object): value is DataSourceDetailResponse {
+    if (!('dataSource' in value) || value['dataSource'] === undefined) return false;
+    if (!('tables' in value) || value['tables'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceDetailResponseFromJSON(json: any): DataSourceDetailResponse {
+    return DataSourceDetailResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceDetailResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceDetailResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'dataSource': DataSourceResponseFromJSON(json['data_source']),
+        'tables': ((json['tables'] as Array<any>).map(DataSourceTableResponseFromJSON)),
+    };
+}
+
+export function DataSourceDetailResponseToJSON(json: any): DataSourceDetailResponse {
+    return DataSourceDetailResponseToJSONTyped(json, false);
+}
+
+export function DataSourceDetailResponseToJSONTyped(value?: DataSourceDetailResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data_source': DataSourceResponseToJSON(value['dataSource']),
+        'tables': ((value['tables'] as Array<any>).map(DataSourceTableResponseToJSON)),
+    };
+}
+