@knowledge-stack/ksapi 1.111.1 → 1.112.0

package/src/models/DataSourceSchemaResponse.ts

@@ -0,0 +1,92 @@
+/* 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';
+/**
+ * 
+ * @export
+ * @interface DataSourceSchemaResponse
+ */
+export interface DataSourceSchemaResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    name: string;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof DataSourceSchemaResponse
+     */
+    isDefault: boolean;
+}
+export const DataSourceSchemaResponsePropertyValidationAttributesMap: {
+    [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 DataSourceSchemaResponse interface.
+ */
+export function instanceOfDataSourceSchemaResponse(value: object): value is DataSourceSchemaResponse {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('isDefault' in value) || value['isDefault'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceSchemaResponseFromJSON(json: any): DataSourceSchemaResponse {
+    return DataSourceSchemaResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceSchemaResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceSchemaResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'isDefault': json['is_default'],
+    };
+}
+
+export function DataSourceSchemaResponseToJSON(json: any): DataSourceSchemaResponse {
+    return DataSourceSchemaResponseToJSONTyped(json, false);
+}
+
+export function DataSourceSchemaResponseToJSONTyped(value?: DataSourceSchemaResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'is_default': value['isDefault'],
+    };
+}
+

package/src/models/DataSourceTableResponse.ts

@@ -88,6 +88,12 @@ export interface DataSourceTableResponse {
      * @memberof DataSourceTableResponse
      */
     tableName: string;
+    /**
+     * Schema/namespace in the external DB; null = default schema
+     * @type {string}
+     * @memberof DataSourceTableResponse
+     */
+    schemaName?: string | null;
     /**
      * 
      * @type {string}
@@ -193,6 +199,7 @@ export function DataSourceTableResponseFromJSONTyped(json: any, ignoreDiscrimina
         'name': json['name'],
         'dataSourceId': json['data_source_id'],
         'tableName': json['table_name'],
+        'schemaName': json['schema_name'] == null ? undefined : json['schema_name'],
         'description': json['description'],
         'columnConfig': json['column_config'],
         'approvalState': PathPartApprovalStateFromJSON(json['approval_state']),
@@ -222,6 +229,7 @@ export function DataSourceTableResponseToJSONTyped(value?: DataSourceTableRespon
         'name': value['name'],
         'data_source_id': value['dataSourceId'],
         'table_name': value['tableName'],
+        'schema_name': value['schemaName'],
         'description': value['description'],
         'column_config': value['columnConfig'],
         'approval_state': PathPartApprovalStateToJSON(value['approvalState']),

package/src/models/ModelTableRequest.ts

@@ -33,6 +33,12 @@ export interface ModelTableRequest {
      * @memberof ModelTableRequest
      */
     tableName: string;
+    /**
+     * Schema/namespace of the table; omit for the default schema
+     * @type {string}
+     * @memberof ModelTableRequest
+     */
+    schemaName?: string | null;
     /**
      * Display name; defaults to table_name
      * @type {string}
@@ -89,6 +95,7 @@ export function ModelTableRequestFromJSONTyped(json: any, ignoreDiscriminator: b
     return {
         
         'tableName': json['table_name'],
+        'schemaName': json['schema_name'] == null ? undefined : json['schema_name'],
         'name': json['name'] == null ? undefined : json['name'],
         'description': json['description'] == null ? undefined : json['description'],
         'columnConfig': json['column_config'] == null ? undefined : ((json['column_config'] as Array<any>).map(ColumnConfigFromJSON)),
@@ -107,6 +114,7 @@ export function ModelTableRequestToJSONTyped(value?: ModelTableRequest | null, i
     return {
         
         'table_name': value['tableName'],
+        'schema_name': value['schemaName'],
         'name': value['name'],
         'description': value['description'],
         'column_config': value['columnConfig'] == null ? undefined : ((value['columnConfig'] as Array<any>).map(ColumnConfigToJSON)),

package/src/models/UpdateWorkflowRunRequest.ts

@@ -36,6 +36,18 @@ export interface UpdateWorkflowRunRequest {
      * @memberof UpdateWorkflowRunRequest
      */
     name?: string | null;
+    /**
+     * Arm (or disarm) auto-start on a draft run. When set true, the run dispatches itself once its ``inputs/`` uploads finish ingesting (see ``CreateWorkflowRunRequest.auto_start``). Arm a PENDING run after queuing all uploads to avoid a partial-input start. ``null`` leaves the current setting unchanged.
+     * @type {boolean}
+     * @memberof UpdateWorkflowRunRequest
+     */
+    autoStart?: boolean | null;
+    /**
+     * Set the note applied when this run auto-starts (see ``CreateWorkflowRunRequest.user_message``). ``null`` leaves the stored message unchanged; send an empty string to clear it.
+     * @type {string}
+     * @memberof UpdateWorkflowRunRequest
+     */
+    userMessage?: string | null;
 }
 export const UpdateWorkflowRunRequestPropertyValidationAttributesMap: {
     [property: string]: {
@@ -60,6 +72,9 @@ export const UpdateWorkflowRunRequestPropertyValidationAttributesMap: {
         maxLength: 255,
         minLength: 1,
     },
+    userMessage: {
+        maxLength: 4000,
+    },
 }
 
 
@@ -82,6 +97,8 @@ export function UpdateWorkflowRunRequestFromJSONTyped(json: any, ignoreDiscrimin
         
         'inputScope': json['input_scope'] == null ? undefined : json['input_scope'],
         'name': json['name'] == null ? undefined : json['name'],
+        'autoStart': json['auto_start'] == null ? undefined : json['auto_start'],
+        'userMessage': json['user_message'] == null ? undefined : json['user_message'],
     };
 }
 
@@ -98,6 +115,8 @@ export function UpdateWorkflowRunRequestToJSONTyped(value?: UpdateWorkflowRunReq
         
         'input_scope': value['inputScope'],
         'name': value['name'],
+        'auto_start': value['autoStart'],
+        'user_message': value['userMessage'],
     };
 }
 

package/src/models/WorkflowRunResponse.ts

@@ -155,6 +155,18 @@ export interface WorkflowRunResponse {
      * @memberof WorkflowRunResponse
      */
     error: string | null;
+    /**
+     * Whether the run dispatches itself once its ``inputs/`` uploads finish ingesting, with no separate Start call.
+     * @type {boolean}
+     * @memberof WorkflowRunResponse
+     */
+    autoStart: boolean;
+    /**
+     * The note applied when this run auto-starts (set via create / PATCH ``user_message``); null when none was supplied.
+     * @type {string}
+     * @memberof WorkflowRunResponse
+     */
+    autoStartUserMessage?: string | null;
     /**
      * FOLDER path_part of the run's ``inputs/`` subfolder
      * @type {string}
@@ -262,6 +274,7 @@ export function instanceOfWorkflowRunResponse(value: object): value is WorkflowR
     if (!('completedAt' in value) || value['completedAt'] === undefined) return false;
     if (!('runSnapshot' in value) || value['runSnapshot'] === undefined) return false;
     if (!('error' in value) || value['error'] === undefined) return false;
+    if (!('autoStart' in value) || value['autoStart'] === undefined) return false;
     if (!('inputsPathPartId' in value) || value['inputsPathPartId'] === undefined) return false;
     if (!('outputsPathPartId' in value) || value['outputsPathPartId'] === undefined) return false;
     if (!('discussionsPathPartId' in value) || value['discussionsPathPartId'] === undefined) return false;
@@ -296,6 +309,8 @@ export function WorkflowRunResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'completedAt': (json['completed_at'] == null ? null : new Date(json['completed_at'])),
         'runSnapshot': WorkflowRunSnapshotFromJSON(json['run_snapshot']),
         'error': json['error'],
+        'autoStart': json['auto_start'],
+        'autoStartUserMessage': json['auto_start_user_message'] == null ? undefined : json['auto_start_user_message'],
         'inputsPathPartId': json['inputs_path_part_id'],
         'outputsPathPartId': json['outputs_path_part_id'],
         'discussionsPathPartId': json['discussions_path_part_id'],
@@ -335,6 +350,8 @@ export function WorkflowRunResponseToJSONTyped(value?: WorkflowRunResponse | nul
         'completed_at': value['completedAt'] == null ? value['completedAt'] : value['completedAt'].toISOString(),
         'run_snapshot': WorkflowRunSnapshotToJSON(value['runSnapshot']),
         'error': value['error'],
+        'auto_start': value['autoStart'],
+        'auto_start_user_message': value['autoStartUserMessage'],
         'inputs_path_part_id': value['inputsPathPartId'],
         'outputs_path_part_id': value['outputsPathPartId'],
         'discussions_path_part_id': value['discussionsPathPartId'],

package/src/models/index.ts

@@ -40,6 +40,7 @@ export * from './CitedChunk';
 export * from './ClearVersionContentsResponse';
 export * from './CloneWorkflowRunRequest';
 export * from './ColumnConfig';
+export * from './ColumnReference';
 export * from './ConnectionConfig';
 export * from './CreateApiConnectionRequest';
 export * from './CreateApiKeyRequest';
@@ -65,6 +66,8 @@ export * from './DataSourceEngine';
 export * from './DataSourceQueryRequest';
 export * from './DataSourceQueryResponse';
 export * from './DataSourceResponse';
+export * from './DataSourceSchemaListResponse';
+export * from './DataSourceSchemaResponse';
 export * from './DataSourceTableResponse';
 export * from './DiffFormat';
 export * from './DiffRow';