@knowledge-stack/ksapi 1.95.3 → 1.96.0

package/src/models/DataSourceEngine.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.
+ */
+
+
+/**
+ * SQL engine backing a data-source connector.
+ * @export
+ */
+export const DataSourceEngine = {
+    Mysql: 'MYSQL',
+    Postgresql: 'POSTGRESQL'
+} as const;
+export type DataSourceEngine = typeof DataSourceEngine[keyof typeof DataSourceEngine];
+
+
+export function instanceOfDataSourceEngine(value: any): boolean {
+    for (const key in DataSourceEngine) {
+        if (Object.prototype.hasOwnProperty.call(DataSourceEngine, key)) {
+            if (DataSourceEngine[key as keyof typeof DataSourceEngine] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function DataSourceEngineFromJSON(json: any): DataSourceEngine {
+    return DataSourceEngineFromJSONTyped(json, false);
+}
+
+export function DataSourceEngineFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceEngine {
+    return json as DataSourceEngine;
+}
+
+export function DataSourceEngineToJSON(value?: DataSourceEngine | null): any {
+    return value as any;
+}
+
+export function DataSourceEngineToJSONTyped(value: any, ignoreDiscriminator: boolean): DataSourceEngine {
+    return value as DataSourceEngine;
+}
+

package/src/models/DataSourceQueryRequest.ts

@@ -0,0 +1,97 @@
+/* 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 read-only SQL query the caller (or agent) wrote.
+ * @export
+ * @interface DataSourceQueryRequest
+ */
+export interface DataSourceQueryRequest {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceQueryRequest
+     */
+    sql: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof DataSourceQueryRequest
+     */
+    maxRows?: number;
+}
+export const DataSourceQueryRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    maxRows: {
+        maximum: 10000,
+        exclusiveMaximum: false,
+        minimum: 1,
+        exclusiveMinimum: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the DataSourceQueryRequest interface.
+ */
+export function instanceOfDataSourceQueryRequest(value: object): value is DataSourceQueryRequest {
+    if (!('sql' in value) || value['sql'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceQueryRequestFromJSON(json: any): DataSourceQueryRequest {
+    return DataSourceQueryRequestFromJSONTyped(json, false);
+}
+
+export function DataSourceQueryRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceQueryRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'sql': json['sql'],
+        'maxRows': json['max_rows'] == null ? undefined : json['max_rows'],
+    };
+}
+
+export function DataSourceQueryRequestToJSON(json: any): DataSourceQueryRequest {
+    return DataSourceQueryRequestToJSONTyped(json, false);
+}
+
+export function DataSourceQueryRequestToJSONTyped(value?: DataSourceQueryRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'sql': value['sql'],
+        'max_rows': value['maxRows'],
+    };
+}
+

package/src/models/DataSourceQueryResponse.ts

@@ -0,0 +1,119 @@
+/* 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';
+/**
+ * Read-only query result. ``generated_sql`` echoes the executed SQL.
+ * @export
+ * @interface DataSourceQueryResponse
+ */
+export interface DataSourceQueryResponse {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof DataSourceQueryResponse
+     */
+    columns: Array<string>;
+    /**
+     * 
+     * @type {Array<Array<any>>}
+     * @memberof DataSourceQueryResponse
+     */
+    rows: Array<Array<any>>;
+    /**
+     * 
+     * @type {number}
+     * @memberof DataSourceQueryResponse
+     */
+    rowCount: number;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DataSourceQueryResponse
+     */
+    truncated: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceQueryResponse
+     */
+    generatedSql: string;
+}
+export const DataSourceQueryResponsePropertyValidationAttributesMap: {
+    [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 DataSourceQueryResponse interface.
+ */
+export function instanceOfDataSourceQueryResponse(value: object): value is DataSourceQueryResponse {
+    if (!('columns' in value) || value['columns'] === undefined) return false;
+    if (!('rows' in value) || value['rows'] === undefined) return false;
+    if (!('rowCount' in value) || value['rowCount'] === undefined) return false;
+    if (!('truncated' in value) || value['truncated'] === undefined) return false;
+    if (!('generatedSql' in value) || value['generatedSql'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceQueryResponseFromJSON(json: any): DataSourceQueryResponse {
+    return DataSourceQueryResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceQueryResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceQueryResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'columns': json['columns'],
+        'rows': json['rows'],
+        'rowCount': json['row_count'],
+        'truncated': json['truncated'],
+        'generatedSql': json['generated_sql'],
+    };
+}
+
+export function DataSourceQueryResponseToJSON(json: any): DataSourceQueryResponse {
+    return DataSourceQueryResponseToJSONTyped(json, false);
+}
+
+export function DataSourceQueryResponseToJSONTyped(value?: DataSourceQueryResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'columns': value['columns'],
+        'rows': value['rows'],
+        'row_count': value['rowCount'],
+        'truncated': value['truncated'],
+        'generated_sql': value['generatedSql'],
+    };
+}
+

package/src/models/DataSourceResponse.ts

@@ -0,0 +1,200 @@
+/* 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 { PathPartApprovalState } from './PathPartApprovalState';
+import {
+    PathPartApprovalStateFromJSON,
+    PathPartApprovalStateFromJSONTyped,
+    PathPartApprovalStateToJSON,
+    PathPartApprovalStateToJSONTyped,
+} from './PathPartApprovalState';
+import type { DataSourceEngine } from './DataSourceEngine';
+import {
+    DataSourceEngineFromJSON,
+    DataSourceEngineFromJSONTyped,
+    DataSourceEngineToJSON,
+    DataSourceEngineToJSONTyped,
+} from './DataSourceEngine';
+
+/**
+ * Connector response; a discriminated-union variant for folder listings.
+ * 
+ * The ``connection_config`` (host/port/credentials) is intentionally
+ * omitted — the password is write-only and never serialized back.
+ * @export
+ * @interface DataSourceResponse
+ */
+export interface DataSourceResponse {
+    /**
+     * Path part type
+     * @type {DataSourceResponsePartTypeEnum}
+     * @memberof DataSourceResponse
+     */
+    partType?: DataSourceResponsePartTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceResponse
+     */
+    id: string;
+    /**
+     * DATA_SOURCE path_part of this connector
+     * @type {string}
+     * @memberof DataSourceResponse
+     */
+    pathPartId: string;
+    /**
+     * path_part of the containing folder
+     * @type {string}
+     * @memberof DataSourceResponse
+     */
+    parentPathPartId: string | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof DataSourceResponse
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceResponse
+     */
+    tenantId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {DataSourceEngine}
+     * @memberof DataSourceResponse
+     */
+    engine: DataSourceEngine;
+    /**
+     * 
+     * @type {PathPartApprovalState}
+     * @memberof DataSourceResponse
+     */
+    approvalState: PathPartApprovalState;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataSourceResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataSourceResponse
+     */
+    updatedAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const DataSourceResponsePartTypeEnum = {
+    DataSource: 'DATA_SOURCE'
+} as const;
+export type DataSourceResponsePartTypeEnum = typeof DataSourceResponsePartTypeEnum[keyof typeof DataSourceResponsePartTypeEnum];
+
+export const DataSourceResponsePropertyValidationAttributesMap: {
+    [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 DataSourceResponse interface.
+ */
+export function instanceOfDataSourceResponse(value: object): value is DataSourceResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('engine' in value) || value['engine'] === undefined) return false;
+    if (!('approvalState' in value) || value['approvalState'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceResponseFromJSON(json: any): DataSourceResponse {
+    return DataSourceResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'partType': json['part_type'] == null ? undefined : json['part_type'],
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'tenantId': json['tenant_id'],
+        'name': json['name'],
+        'engine': DataSourceEngineFromJSON(json['engine']),
+        'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function DataSourceResponseToJSON(json: any): DataSourceResponse {
+    return DataSourceResponseToJSONTyped(json, false);
+}
+
+export function DataSourceResponseToJSONTyped(value?: DataSourceResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'part_type': value['partType'],
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'materialized_path': value['materializedPath'],
+        'tenant_id': value['tenantId'],
+        'name': value['name'],
+        'engine': DataSourceEngineToJSON(value['engine']),
+        'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+

package/src/models/DataSourceTableResponse.ts

@@ -0,0 +1,217 @@
+/* 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 { PathPartApprovalState } from './PathPartApprovalState';
+import {
+    PathPartApprovalStateFromJSON,
+    PathPartApprovalStateFromJSONTyped,
+    PathPartApprovalStateToJSON,
+    PathPartApprovalStateToJSONTyped,
+} from './PathPartApprovalState';
+
+/**
+ * Modeled-table response; a discriminated-union variant for listings.
+ * @export
+ * @interface DataSourceTableResponse
+ */
+export interface DataSourceTableResponse {
+    /**
+     * Path part type
+     * @type {DataSourceTableResponsePartTypeEnum}
+     * @memberof DataSourceTableResponse
+     */
+    partType?: DataSourceTableResponsePartTypeEnum;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    id: string;
+    /**
+     * DATA_SOURCE_TABLE path_part of this table
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    pathPartId: string;
+    /**
+     * DATA_SOURCE path_part of the parent connector
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    parentPathPartId: string | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    materializedPath: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    tenantId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    dataSourceId: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    tableName: string;
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    description: string | null;
+    /**
+     * 
+     * @type {Array<{ [key: string]: any; }>}
+     * @memberof DataSourceTableResponse
+     */
+    columnConfig: Array<{ [key: string]: any; }>;
+    /**
+     * 
+     * @type {PathPartApprovalState}
+     * @memberof DataSourceTableResponse
+     */
+    approvalState: PathPartApprovalState;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataSourceTableResponse
+     */
+    createdAt: Date;
+    /**
+     * 
+     * @type {Date}
+     * @memberof DataSourceTableResponse
+     */
+    updatedAt: Date;
+}
+
+
+/**
+ * @export
+ */
+export const DataSourceTableResponsePartTypeEnum = {
+    DataSourceTable: 'DATA_SOURCE_TABLE'
+} as const;
+export type DataSourceTableResponsePartTypeEnum = typeof DataSourceTableResponsePartTypeEnum[keyof typeof DataSourceTableResponsePartTypeEnum];
+
+export const DataSourceTableResponsePropertyValidationAttributesMap: {
+    [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 DataSourceTableResponse interface.
+ */
+export function instanceOfDataSourceTableResponse(value: object): value is DataSourceTableResponse {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    if (!('pathPartId' in value) || value['pathPartId'] === undefined) return false;
+    if (!('parentPathPartId' in value) || value['parentPathPartId'] === undefined) return false;
+    if (!('materializedPath' in value) || value['materializedPath'] === undefined) return false;
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('dataSourceId' in value) || value['dataSourceId'] === undefined) return false;
+    if (!('tableName' in value) || value['tableName'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('columnConfig' in value) || value['columnConfig'] === undefined) return false;
+    if (!('approvalState' in value) || value['approvalState'] === undefined) return false;
+    if (!('createdAt' in value) || value['createdAt'] === undefined) return false;
+    if (!('updatedAt' in value) || value['updatedAt'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceTableResponseFromJSON(json: any): DataSourceTableResponse {
+    return DataSourceTableResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceTableResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceTableResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'partType': json['part_type'] == null ? undefined : json['part_type'],
+        'id': json['id'],
+        'pathPartId': json['path_part_id'],
+        'parentPathPartId': json['parent_path_part_id'],
+        'materializedPath': json['materialized_path'],
+        'tenantId': json['tenant_id'],
+        'name': json['name'],
+        'dataSourceId': json['data_source_id'],
+        'tableName': json['table_name'],
+        'description': json['description'],
+        'columnConfig': json['column_config'],
+        'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
+        'createdAt': (new Date(json['created_at'])),
+        'updatedAt': (new Date(json['updated_at'])),
+    };
+}
+
+export function DataSourceTableResponseToJSON(json: any): DataSourceTableResponse {
+    return DataSourceTableResponseToJSONTyped(json, false);
+}
+
+export function DataSourceTableResponseToJSONTyped(value?: DataSourceTableResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'part_type': value['partType'],
+        'id': value['id'],
+        'path_part_id': value['pathPartId'],
+        'parent_path_part_id': value['parentPathPartId'],
+        'materialized_path': value['materializedPath'],
+        'tenant_id': value['tenantId'],
+        'name': value['name'],
+        'data_source_id': value['dataSourceId'],
+        'table_name': value['tableName'],
+        'description': value['description'],
+        'column_config': value['columnConfig'],
+        'approval_state': PathPartApprovalStateToJSON(value['approvalState']),
+        'created_at': value['createdAt'].toISOString(),
+        'updated_at': value['updatedAt'].toISOString(),
+    };
+}
+