@knowledge-stack/ksapi 1.118.0 → 1.119.0

package/src/models/BlockChangeType.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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const BlockChangeType = {
+    Added: 'added',
+    Removed: 'removed',
+    Modified: 'modified'
+} as const;
+export type BlockChangeType = typeof BlockChangeType[keyof typeof BlockChangeType];
+
+
+export function instanceOfBlockChangeType(value: any): boolean {
+    for (const key in BlockChangeType) {
+        if (Object.prototype.hasOwnProperty.call(BlockChangeType, key)) {
+            if (BlockChangeType[key as keyof typeof BlockChangeType] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BlockChangeTypeFromJSON(json: any): BlockChangeType {
+    return BlockChangeTypeFromJSONTyped(json, false);
+}
+
+export function BlockChangeTypeFromJSONTyped(json: any, ignoreDiscriminator: boolean): BlockChangeType {
+    return json as BlockChangeType;
+}
+
+export function BlockChangeTypeToJSON(value?: BlockChangeType | null): any {
+    return value as any;
+}
+
+export function BlockChangeTypeToJSONTyped(value: any, ignoreDiscriminator: boolean): BlockChangeType {
+    return value as BlockChangeType;
+}
+

package/src/models/BlockKind.ts

@@ -0,0 +1,56 @@
+/* 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.
+ */
+
+
+/**
+ * 
+ * @export
+ */
+export const BlockKind = {
+    Paragraph: 'paragraph',
+    Heading: 'heading',
+    ListItem: 'list_item',
+    Table: 'table',
+    Image: 'image'
+} as const;
+export type BlockKind = typeof BlockKind[keyof typeof BlockKind];
+
+
+export function instanceOfBlockKind(value: any): boolean {
+    for (const key in BlockKind) {
+        if (Object.prototype.hasOwnProperty.call(BlockKind, key)) {
+            if (BlockKind[key as keyof typeof BlockKind] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function BlockKindFromJSON(json: any): BlockKind {
+    return BlockKindFromJSONTyped(json, false);
+}
+
+export function BlockKindFromJSONTyped(json: any, ignoreDiscriminator: boolean): BlockKind {
+    return json as BlockKind;
+}
+
+export function BlockKindToJSON(value?: BlockKind | null): any {
+    return value as any;
+}
+
+export function BlockKindToJSONTyped(value: any, ignoreDiscriminator: boolean): BlockKind {
+    return value as BlockKind;
+}
+

package/src/models/BulkModelTablesRequest.ts

@@ -0,0 +1,95 @@
+/* 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 { ModelTableRequest } from './ModelTableRequest';
+import {
+    ModelTableRequestFromJSON,
+    ModelTableRequestFromJSONTyped,
+    ModelTableRequestToJSON,
+    ModelTableRequestToJSONTyped,
+} from './ModelTableRequest';
+
+/**
+ * Import several tables (across one or more schemas) in one call.
+ * @export
+ * @interface BulkModelTablesRequest
+ */
+export interface BulkModelTablesRequest {
+    /**
+     * 
+     * @type {Array<ModelTableRequest>}
+     * @memberof BulkModelTablesRequest
+     */
+    tables: Array<ModelTableRequest>;
+}
+export const BulkModelTablesRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    tables: {
+        minItems: 1,
+        uniqueItems: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the BulkModelTablesRequest interface.
+ */
+export function instanceOfBulkModelTablesRequest(value: object): value is BulkModelTablesRequest {
+    if (!('tables' in value) || value['tables'] === undefined) return false;
+    return true;
+}
+
+export function BulkModelTablesRequestFromJSON(json: any): BulkModelTablesRequest {
+    return BulkModelTablesRequestFromJSONTyped(json, false);
+}
+
+export function BulkModelTablesRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkModelTablesRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tables': ((json['tables'] as Array<any>).map(ModelTableRequestFromJSON)),
+    };
+}
+
+export function BulkModelTablesRequestToJSON(json: any): BulkModelTablesRequest {
+    return BulkModelTablesRequestToJSONTyped(json, false);
+}
+
+export function BulkModelTablesRequestToJSONTyped(value?: BulkModelTablesRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tables': ((value['tables'] as Array<any>).map(ModelTableRequestToJSON)),
+    };
+}
+

package/src/models/BulkModelTablesResponse.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 { ModelTableResult } from './ModelTableResult';
+import {
+    ModelTableResultFromJSON,
+    ModelTableResultFromJSONTyped,
+    ModelTableResultToJSON,
+    ModelTableResultToJSONTyped,
+} from './ModelTableResult';
+
+/**
+ * Per-item results of a bulk import; one entry per requested table.
+ * @export
+ * @interface BulkModelTablesResponse
+ */
+export interface BulkModelTablesResponse {
+    /**
+     * 
+     * @type {Array<ModelTableResult>}
+     * @memberof BulkModelTablesResponse
+     */
+    results: Array<ModelTableResult>;
+}
+export const BulkModelTablesResponsePropertyValidationAttributesMap: {
+    [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 BulkModelTablesResponse interface.
+ */
+export function instanceOfBulkModelTablesResponse(value: object): value is BulkModelTablesResponse {
+    if (!('results' in value) || value['results'] === undefined) return false;
+    return true;
+}
+
+export function BulkModelTablesResponseFromJSON(json: any): BulkModelTablesResponse {
+    return BulkModelTablesResponseFromJSONTyped(json, false);
+}
+
+export function BulkModelTablesResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkModelTablesResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'results': ((json['results'] as Array<any>).map(ModelTableResultFromJSON)),
+    };
+}
+
+export function BulkModelTablesResponseToJSON(json: any): BulkModelTablesResponse {
+    return BulkModelTablesResponseToJSONTyped(json, false);
+}
+
+export function BulkModelTablesResponseToJSONTyped(value?: BulkModelTablesResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'results': ((value['results'] as Array<any>).map(ModelTableResultToJSON)),
+    };
+}
+

package/src/models/CellChange.ts

@@ -23,6 +23,11 @@ import {
 
 /**
  * One changed spreadsheet cell (``old`` is null for added, ``new`` for removed).
+ * 
+ * ``old``/``new`` are the displayed values (cached result for a formula cell);
+ * ``*_formula`` carry the formula text so a formula edit is visible even when the
+ * computed value is unchanged. ``formatting_changed`` flags a bold/colour/
+ * number-format change on an otherwise unchanged cell.
  * @export
  * @interface CellChange
  */
@@ -57,6 +62,48 @@ export interface CellChange {
      * @memberof CellChange
      */
     type: CellChangeType;
+    /**
+     * 
+     * @type {string}
+     * @memberof CellChange
+     */
+    oldFormula?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CellChange
+     */
+    newFormula?: string | null;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CellChange
+     */
+    formulaChanged?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CellChange
+     */
+    formattingChanged?: boolean;
+    /**
+     * 
+     * @type {boolean}
+     * @memberof CellChange
+     */
+    commentChanged?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof CellChange
+     */
+    oldComment?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof CellChange
+     */
+    newComment?: string | null;
 }
 
 
@@ -105,6 +152,13 @@ export function CellChangeFromJSONTyped(json: any, ignoreDiscriminator: boolean)
         'old': json['old'],
         '_new': json['new'],
         'type': CellChangeTypeFromJSON(json['type']),
+        'oldFormula': json['old_formula'] == null ? undefined : json['old_formula'],
+        'newFormula': json['new_formula'] == null ? undefined : json['new_formula'],
+        'formulaChanged': json['formula_changed'] == null ? undefined : json['formula_changed'],
+        'formattingChanged': json['formatting_changed'] == null ? undefined : json['formatting_changed'],
+        'commentChanged': json['comment_changed'] == null ? undefined : json['comment_changed'],
+        'oldComment': json['old_comment'] == null ? undefined : json['old_comment'],
+        'newComment': json['new_comment'] == null ? undefined : json['new_comment'],
     };
 }
 
@@ -124,6 +178,13 @@ export function CellChangeToJSONTyped(value?: CellChange | null, ignoreDiscrimin
         'old': value['old'],
         'new': value['_new'],
         'type': CellChangeTypeToJSON(value['type']),
+        'old_formula': value['oldFormula'],
+        'new_formula': value['newFormula'],
+        'formula_changed': value['formulaChanged'],
+        'formatting_changed': value['formattingChanged'],
+        'comment_changed': value['commentChanged'],
+        'old_comment': value['oldComment'],
+        'new_comment': value['newComment'],
     };
 }
 

package/src/models/CellDiff.ts

@@ -20,6 +20,13 @@ import {
     CellChangeToJSON,
     CellChangeToJSONTyped,
 } from './CellChange';
+import type { SheetVisibilityChange } from './SheetVisibilityChange';
+import {
+    SheetVisibilityChangeFromJSON,
+    SheetVisibilityChangeFromJSONTyped,
+    SheetVisibilityChangeToJSON,
+    SheetVisibilityChangeToJSONTyped,
+} from './SheetVisibilityChange';
 
 /**
  * A cell-level diff of two spreadsheet versions.
@@ -57,6 +64,12 @@ export interface CellDiff {
      * @memberof CellDiff
      */
     truncated: boolean;
+    /**
+     * 
+     * @type {Array<SheetVisibilityChange>}
+     * @memberof CellDiff
+     */
+    sheetVisibilityChanges: Array<SheetVisibilityChange>;
 }
 export const CellDiffPropertyValidationAttributesMap: {
     [property: string]: {
@@ -85,6 +98,7 @@ export function instanceOfCellDiff(value: object): value is CellDiff {
     if (!('removed' in value) || value['removed'] === undefined) return false;
     if (!('modified' in value) || value['modified'] === undefined) return false;
     if (!('truncated' in value) || value['truncated'] === undefined) return false;
+    if (!('sheetVisibilityChanges' in value) || value['sheetVisibilityChanges'] === undefined) return false;
     return true;
 }
 
@@ -103,6 +117,7 @@ export function CellDiffFromJSONTyped(json: any, ignoreDiscriminator: boolean):
         'removed': json['removed'],
         'modified': json['modified'],
         'truncated': json['truncated'],
+        'sheetVisibilityChanges': ((json['sheet_visibility_changes'] as Array<any>).map(SheetVisibilityChangeFromJSON)),
     };
 }
 
@@ -122,6 +137,7 @@ export function CellDiffToJSONTyped(value?: CellDiff | null, ignoreDiscriminator
         'removed': value['removed'],
         'modified': value['modified'],
         'truncated': value['truncated'],
+        'sheet_visibility_changes': ((value['sheetVisibilityChanges'] as Array<any>).map(SheetVisibilityChangeToJSON)),
     };
 }
 

package/src/models/ChangeClass.ts

@@ -0,0 +1,57 @@
+/* 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.
+ */
+
+
+/**
+ * What kind of change this is, so an auditor can filter (numbers move money).
+ * @export
+ */
+export const ChangeClass = {
+    Text: 'text',
+    Numeric: 'numeric',
+    Formatting: 'formatting',
+    Structural: 'structural',
+    Image: 'image',
+    Revision: 'revision'
+} as const;
+export type ChangeClass = typeof ChangeClass[keyof typeof ChangeClass];
+
+
+export function instanceOfChangeClass(value: any): boolean {
+    for (const key in ChangeClass) {
+        if (Object.prototype.hasOwnProperty.call(ChangeClass, key)) {
+            if (ChangeClass[key as keyof typeof ChangeClass] === value) {
+                return true;
+            }
+        }
+    }
+    return false;
+}
+
+export function ChangeClassFromJSON(json: any): ChangeClass {
+    return ChangeClassFromJSONTyped(json, false);
+}
+
+export function ChangeClassFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChangeClass {
+    return json as ChangeClass;
+}
+
+export function ChangeClassToJSON(value?: ChangeClass | null): any {
+    return value as any;
+}
+
+export function ChangeClassToJSONTyped(value: any, ignoreDiscriminator: boolean): ChangeClass {
+    return value as ChangeClass;
+}
+

package/src/models/DataSourceDescriptionResponse.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';
+/**
+ * Result of (re)generating a connector's searchable description Document.
+ * @export
+ * @interface DataSourceDescriptionResponse
+ */
+export interface DataSourceDescriptionResponse {
+    /**
+     * 
+     * @type {string}
+     * @memberof DataSourceDescriptionResponse
+     */
+    dataSourceId: string;
+    /**
+     * PDO id of the generated, ingested 'Database overview' doc
+     * @type {string}
+     * @memberof DataSourceDescriptionResponse
+     */
+    descriptionDocumentId: string;
+}
+export const DataSourceDescriptionResponsePropertyValidationAttributesMap: {
+    [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 DataSourceDescriptionResponse interface.
+ */
+export function instanceOfDataSourceDescriptionResponse(value: object): value is DataSourceDescriptionResponse {
+    if (!('dataSourceId' in value) || value['dataSourceId'] === undefined) return false;
+    if (!('descriptionDocumentId' in value) || value['descriptionDocumentId'] === undefined) return false;
+    return true;
+}
+
+export function DataSourceDescriptionResponseFromJSON(json: any): DataSourceDescriptionResponse {
+    return DataSourceDescriptionResponseFromJSONTyped(json, false);
+}
+
+export function DataSourceDescriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceDescriptionResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'dataSourceId': json['data_source_id'],
+        'descriptionDocumentId': json['description_document_id'],
+    };
+}
+
+export function DataSourceDescriptionResponseToJSON(json: any): DataSourceDescriptionResponse {
+    return DataSourceDescriptionResponseToJSONTyped(json, false);
+}
+
+export function DataSourceDescriptionResponseToJSONTyped(value?: DataSourceDescriptionResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'data_source_id': value['dataSourceId'],
+        'description_document_id': value['descriptionDocumentId'],
+    };
+}
+

package/src/models/DataSourceDetailResponse.ts

@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
+import {
+    DataSourceSchemaResponseFromJSON,
+    DataSourceSchemaResponseFromJSONTyped,
+    DataSourceSchemaResponseToJSON,
+    DataSourceSchemaResponseToJSONTyped,
+} from './DataSourceSchemaResponse';
 import type { DataSourceResponse } from './DataSourceResponse';
 import {
     DataSourceResponseFromJSON,
@@ -20,16 +27,12 @@ import {
     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).
+ * A connector plus the schemas (and their readable tables) the caller sees.
+ * 
+ * ``description_document_id`` points at the connector's generated, ingested
+ * "Database overview" Document (a hidden system file); null until generated.
  * @export
  * @interface DataSourceDetailResponse
  */
@@ -42,10 +45,16 @@ export interface DataSourceDetailResponse {
     dataSource: DataSourceResponse;
     /**
      * 
-     * @type {Array<DataSourceTableResponse>}
+     * @type {Array<DataSourceSchemaResponse>}
+     * @memberof DataSourceDetailResponse
+     */
+    schemas: Array<DataSourceSchemaResponse>;
+    /**
+     * 
+     * @type {string}
      * @memberof DataSourceDetailResponse
      */
-    tables: Array<DataSourceTableResponse>;
+    descriptionDocumentId?: string | null;
 }
 export const DataSourceDetailResponsePropertyValidationAttributesMap: {
     [property: string]: {
@@ -70,7 +79,7 @@ export const DataSourceDetailResponsePropertyValidationAttributesMap: {
  */
 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;
+    if (!('schemas' in value) || value['schemas'] === undefined) return false;
     return true;
 }
 
@@ -85,7 +94,8 @@ export function DataSourceDetailResponseFromJSONTyped(json: any, ignoreDiscrimin
     return {
         
         'dataSource': DataSourceResponseFromJSON(json['data_source']),
-        'tables': ((json['tables'] as Array<any>).map(DataSourceTableResponseFromJSON)),
+        'schemas': ((json['schemas'] as Array<any>).map(DataSourceSchemaResponseFromJSON)),
+        'descriptionDocumentId': json['description_document_id'] == null ? undefined : json['description_document_id'],
     };
 }
 
@@ -101,7 +111,8 @@ export function DataSourceDetailResponseToJSONTyped(value?: DataSourceDetailResp
     return {
         
         'data_source': DataSourceResponseToJSON(value['dataSource']),
-        'tables': ((value['tables'] as Array<any>).map(DataSourceTableResponseToJSON)),
+        'schemas': ((value['schemas'] as Array<any>).map(DataSourceSchemaResponseToJSON)),
+        'description_document_id': value['descriptionDocumentId'],
     };
 }