@knowledge-stack/ksapi 1.118.0 → 1.119.0

package/dist/models/CellDiff.d.ts

@@ -10,6 +10,7 @@
  * Do not edit the class manually.
  */
 import type { CellChange } from './CellChange';
+import type { SheetVisibilityChange } from './SheetVisibilityChange';
 /**
  * A cell-level diff of two spreadsheet versions.
  * @export
@@ -46,6 +47,12 @@ export interface CellDiff {
      * @memberof CellDiff
      */
     truncated: boolean;
+    /**
+     *
+     * @type {Array<SheetVisibilityChange>}
+     * @memberof CellDiff
+     */
+    sheetVisibilityChanges: Array<SheetVisibilityChange>;
 }
 export declare const CellDiffPropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/CellDiff.js

@@ -20,6 +20,7 @@ exports.CellDiffFromJSONTyped = CellDiffFromJSONTyped;
 exports.CellDiffToJSON = CellDiffToJSON;
 exports.CellDiffToJSONTyped = CellDiffToJSONTyped;
 const CellChange_1 = require("./CellChange");
+const SheetVisibilityChange_1 = require("./SheetVisibilityChange");
 exports.CellDiffPropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the CellDiff interface.
@@ -35,6 +36,8 @@ function instanceOfCellDiff(value) {
         return false;
     if (!('truncated' in value) || value['truncated'] === undefined)
         return false;
+    if (!('sheetVisibilityChanges' in value) || value['sheetVisibilityChanges'] === undefined)
+        return false;
     return true;
 }
 function CellDiffFromJSON(json) {
@@ -50,6 +53,7 @@ function CellDiffFromJSONTyped(json, ignoreDiscriminator) {
         'removed': json['removed'],
         'modified': json['modified'],
         'truncated': json['truncated'],
+        'sheetVisibilityChanges': (json['sheet_visibility_changes'].map(SheetVisibilityChange_1.SheetVisibilityChangeFromJSON)),
     };
 }
 function CellDiffToJSON(json) {
@@ -65,5 +69,6 @@ function CellDiffToJSONTyped(value, ignoreDiscriminator = false) {
         'removed': value['removed'],
         'modified': value['modified'],
         'truncated': value['truncated'],
+        'sheet_visibility_changes': (value['sheetVisibilityChanges'].map(SheetVisibilityChange_1.SheetVisibilityChangeToJSON)),
     };
 }

package/dist/models/ChangeClass.d.ts

@@ -0,0 +1,29 @@
+/**
+ * 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 declare const ChangeClass: {
+    readonly Text: "text";
+    readonly Numeric: "numeric";
+    readonly Formatting: "formatting";
+    readonly Structural: "structural";
+    readonly Image: "image";
+    readonly Revision: "revision";
+};
+export type ChangeClass = typeof ChangeClass[keyof typeof ChangeClass];
+export declare function instanceOfChangeClass(value: any): boolean;
+export declare function ChangeClassFromJSON(json: any): ChangeClass;
+export declare function ChangeClassFromJSONTyped(json: any, ignoreDiscriminator: boolean): ChangeClass;
+export declare function ChangeClassToJSON(value?: ChangeClass | null): any;
+export declare function ChangeClassToJSONTyped(value: any, ignoreDiscriminator: boolean): ChangeClass;

package/dist/models/ChangeClass.js

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

package/dist/models/DataSourceDescriptionResponse.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * 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 declare 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 declare function instanceOfDataSourceDescriptionResponse(value: object): value is DataSourceDescriptionResponse;
+export declare function DataSourceDescriptionResponseFromJSON(json: any): DataSourceDescriptionResponse;
+export declare function DataSourceDescriptionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceDescriptionResponse;
+export declare function DataSourceDescriptionResponseToJSON(json: any): DataSourceDescriptionResponse;
+export declare function DataSourceDescriptionResponseToJSONTyped(value?: DataSourceDescriptionResponse | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DataSourceDescriptionResponse.js

@@ -0,0 +1,56 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataSourceDescriptionResponsePropertyValidationAttributesMap = void 0;
+exports.instanceOfDataSourceDescriptionResponse = instanceOfDataSourceDescriptionResponse;
+exports.DataSourceDescriptionResponseFromJSON = DataSourceDescriptionResponseFromJSON;
+exports.DataSourceDescriptionResponseFromJSONTyped = DataSourceDescriptionResponseFromJSONTyped;
+exports.DataSourceDescriptionResponseToJSON = DataSourceDescriptionResponseToJSON;
+exports.DataSourceDescriptionResponseToJSONTyped = DataSourceDescriptionResponseToJSONTyped;
+exports.DataSourceDescriptionResponsePropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DataSourceDescriptionResponse interface.
+ */
+function instanceOfDataSourceDescriptionResponse(value) {
+    if (!('dataSourceId' in value) || value['dataSourceId'] === undefined)
+        return false;
+    if (!('descriptionDocumentId' in value) || value['descriptionDocumentId'] === undefined)
+        return false;
+    return true;
+}
+function DataSourceDescriptionResponseFromJSON(json) {
+    return DataSourceDescriptionResponseFromJSONTyped(json, false);
+}
+function DataSourceDescriptionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'dataSourceId': json['data_source_id'],
+        'descriptionDocumentId': json['description_document_id'],
+    };
+}
+function DataSourceDescriptionResponseToJSON(json) {
+    return DataSourceDescriptionResponseToJSONTyped(json, false);
+}
+function DataSourceDescriptionResponseToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'data_source_id': value['dataSourceId'],
+        'description_document_id': value['descriptionDocumentId'],
+    };
+}

package/dist/models/DataSourceDetailResponse.d.ts

@@ -9,10 +9,13 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
 import type { DataSourceResponse } from './DataSourceResponse';
-import type { DataSourceTableResponse } 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
  */
@@ -25,10 +28,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 declare const DataSourceDetailResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/DataSourceDetailResponse.js

@@ -19,8 +19,8 @@ exports.DataSourceDetailResponseFromJSON = DataSourceDetailResponseFromJSON;
 exports.DataSourceDetailResponseFromJSONTyped = DataSourceDetailResponseFromJSONTyped;
 exports.DataSourceDetailResponseToJSON = DataSourceDetailResponseToJSON;
 exports.DataSourceDetailResponseToJSONTyped = DataSourceDetailResponseToJSONTyped;
+const DataSourceSchemaResponse_1 = require("./DataSourceSchemaResponse");
 const DataSourceResponse_1 = require("./DataSourceResponse");
-const DataSourceTableResponse_1 = require("./DataSourceTableResponse");
 exports.DataSourceDetailResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the DataSourceDetailResponse interface.
@@ -28,7 +28,7 @@ exports.DataSourceDetailResponsePropertyValidationAttributesMap = {};
 function instanceOfDataSourceDetailResponse(value) {
     if (!('dataSource' in value) || value['dataSource'] === undefined)
         return false;
-    if (!('tables' in value) || value['tables'] === undefined)
+    if (!('schemas' in value) || value['schemas'] === undefined)
         return false;
     return true;
 }
@@ -41,7 +41,8 @@ function DataSourceDetailResponseFromJSONTyped(json, ignoreDiscriminator) {
     }
     return {
         'dataSource': (0, DataSourceResponse_1.DataSourceResponseFromJSON)(json['data_source']),
-        'tables': (json['tables'].map(DataSourceTableResponse_1.DataSourceTableResponseFromJSON)),
+        'schemas': (json['schemas'].map(DataSourceSchemaResponse_1.DataSourceSchemaResponseFromJSON)),
+        'descriptionDocumentId': json['description_document_id'] == null ? undefined : json['description_document_id'],
     };
 }
 function DataSourceDetailResponseToJSON(json) {
@@ -53,6 +54,7 @@ function DataSourceDetailResponseToJSONTyped(value, ignoreDiscriminator = false)
     }
     return {
         'data_source': (0, DataSourceResponse_1.DataSourceResponseToJSON)(value['dataSource']),
-        'tables': (value['tables'].map(DataSourceTableResponse_1.DataSourceTableResponseToJSON)),
+        'schemas': (value['schemas'].map(DataSourceSchemaResponse_1.DataSourceSchemaResponseToJSON)),
+        'description_document_id': value['descriptionDocumentId'],
     };
 }

package/dist/models/DataSourceSchemaListItem.d.ts

@@ -0,0 +1,53 @@
+/**
+ * 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.
+ */
+/**
+ * A namespace discovered by live introspection (not a persisted PDO).
+ * @export
+ * @interface DataSourceSchemaListItem
+ */
+export interface DataSourceSchemaListItem {
+    /**
+     *
+     * @type {string}
+     * @memberof DataSourceSchemaListItem
+     */
+    name: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof DataSourceSchemaListItem
+     */
+    isDefault: boolean;
+}
+export declare const DataSourceSchemaListItemPropertyValidationAttributesMap: {
+    [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 DataSourceSchemaListItem interface.
+ */
+export declare function instanceOfDataSourceSchemaListItem(value: object): value is DataSourceSchemaListItem;
+export declare function DataSourceSchemaListItemFromJSON(json: any): DataSourceSchemaListItem;
+export declare function DataSourceSchemaListItemFromJSONTyped(json: any, ignoreDiscriminator: boolean): DataSourceSchemaListItem;
+export declare function DataSourceSchemaListItemToJSON(json: any): DataSourceSchemaListItem;
+export declare function DataSourceSchemaListItemToJSONTyped(value?: DataSourceSchemaListItem | null, ignoreDiscriminator?: boolean): any;

package/dist/models/DataSourceSchemaListItem.js

@@ -0,0 +1,56 @@
+"use strict";
+/* 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.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.DataSourceSchemaListItemPropertyValidationAttributesMap = void 0;
+exports.instanceOfDataSourceSchemaListItem = instanceOfDataSourceSchemaListItem;
+exports.DataSourceSchemaListItemFromJSON = DataSourceSchemaListItemFromJSON;
+exports.DataSourceSchemaListItemFromJSONTyped = DataSourceSchemaListItemFromJSONTyped;
+exports.DataSourceSchemaListItemToJSON = DataSourceSchemaListItemToJSON;
+exports.DataSourceSchemaListItemToJSONTyped = DataSourceSchemaListItemToJSONTyped;
+exports.DataSourceSchemaListItemPropertyValidationAttributesMap = {};
+/**
+ * Check if a given object implements the DataSourceSchemaListItem interface.
+ */
+function instanceOfDataSourceSchemaListItem(value) {
+    if (!('name' in value) || value['name'] === undefined)
+        return false;
+    if (!('isDefault' in value) || value['isDefault'] === undefined)
+        return false;
+    return true;
+}
+function DataSourceSchemaListItemFromJSON(json) {
+    return DataSourceSchemaListItemFromJSONTyped(json, false);
+}
+function DataSourceSchemaListItemFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'name': json['name'],
+        'isDefault': json['is_default'],
+    };
+}
+function DataSourceSchemaListItemToJSON(json) {
+    return DataSourceSchemaListItemToJSONTyped(json, false);
+}
+function DataSourceSchemaListItemToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'name': value['name'],
+        'is_default': value['isDefault'],
+    };
+}

package/dist/models/DataSourceSchemaListResponse.d.ts

@@ -9,7 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
-import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
+import type { DataSourceSchemaListItem } from './DataSourceSchemaListItem';
 /**
  * The source's user namespaces (PG schemas / MySQL databases).
  * @export
@@ -18,10 +18,10 @@ import type { DataSourceSchemaResponse } from './DataSourceSchemaResponse';
 export interface DataSourceSchemaListResponse {
     /**
      *
-     * @type {Array<DataSourceSchemaResponse>}
+     * @type {Array<DataSourceSchemaListItem>}
      * @memberof DataSourceSchemaListResponse
      */
-    schemas: Array<DataSourceSchemaResponse>;
+    schemas: Array<DataSourceSchemaListItem>;
 }
 export declare const DataSourceSchemaListResponsePropertyValidationAttributesMap: {
     [property: string]: {

package/dist/models/DataSourceSchemaListResponse.js

@@ -19,7 +19,7 @@ exports.DataSourceSchemaListResponseFromJSON = DataSourceSchemaListResponseFromJ
 exports.DataSourceSchemaListResponseFromJSONTyped = DataSourceSchemaListResponseFromJSONTyped;
 exports.DataSourceSchemaListResponseToJSON = DataSourceSchemaListResponseToJSON;
 exports.DataSourceSchemaListResponseToJSONTyped = DataSourceSchemaListResponseToJSONTyped;
-const DataSourceSchemaResponse_1 = require("./DataSourceSchemaResponse");
+const DataSourceSchemaListItem_1 = require("./DataSourceSchemaListItem");
 exports.DataSourceSchemaListResponsePropertyValidationAttributesMap = {};
 /**
  * Check if a given object implements the DataSourceSchemaListResponse interface.
@@ -37,7 +37,7 @@ function DataSourceSchemaListResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
-        'schemas': (json['schemas'].map(DataSourceSchemaResponse_1.DataSourceSchemaResponseFromJSON)),
+        'schemas': (json['schemas'].map(DataSourceSchemaListItem_1.DataSourceSchemaListItemFromJSON)),
     };
 }
 function DataSourceSchemaListResponseToJSON(json) {
@@ -48,6 +48,6 @@ function DataSourceSchemaListResponseToJSONTyped(value, ignoreDiscriminator = fa
         return value;
     }
     return {
-        'schemas': (value['schemas'].map(DataSourceSchemaResponse_1.DataSourceSchemaResponseToJSON)),
+        'schemas': (value['schemas'].map(DataSourceSchemaListItem_1.DataSourceSchemaListItemToJSON)),
     };
 }

package/dist/models/DataSourceSchemaResponse.d.ts

@@ -9,12 +9,51 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import type { ItemPermissions } from './ItemPermissions';
+import type { PathPartApprovalState } from './PathPartApprovalState';
+import type { DataSourceTableResponse } from './DataSourceTableResponse';
 /**
- *
+ * A schema PDO under a connector, with the readable tables it contains.
  * @export
  * @interface DataSourceSchemaResponse
  */
 export interface DataSourceSchemaResponse {
+    /**
+     * Path part type
+     * @type {DataSourceSchemaResponsePartTypeEnum}
+     * @memberof DataSourceSchemaResponse
+     */
+    partType?: DataSourceSchemaResponsePartTypeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    id: string;
+    /**
+     * DATA_SOURCE_SCHEMA path_part of this schema
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    pathPartId: string;
+    /**
+     * DATA_SOURCE path_part of the parent connector
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    parentPathPartId: string | null;
+    /**
+     * Full materialized path from root
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    materializedPath: string;
+    /**
+     *
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    tenantId: string;
     /**
      *
      * @type {string}
@@ -23,11 +62,66 @@ export interface DataSourceSchemaResponse {
     name: string;
     /**
      *
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    dataSourceId: string;
+    /**
+     * Real namespace in the external DB
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    schemaName: string;
+    /**
+     * True for the connection's default namespace
      * @type {boolean}
      * @memberof DataSourceSchemaResponse
      */
     isDefault: boolean;
+    /**
+     *
+     * @type {string}
+     * @memberof DataSourceSchemaResponse
+     */
+    description: string | null;
+    /**
+     *
+     * @type {PathPartApprovalState}
+     * @memberof DataSourceSchemaResponse
+     */
+    approvalState: PathPartApprovalState;
+    /**
+     *
+     * @type {ItemPermissions}
+     * @memberof DataSourceSchemaResponse
+     */
+    permissions: ItemPermissions;
+    /**
+     *
+     * @type {Date}
+     * @memberof DataSourceSchemaResponse
+     */
+    createdAt: Date;
+    /**
+     *
+     * @type {Date}
+     * @memberof DataSourceSchemaResponse
+     */
+    updatedAt: Date;
+    /**
+     * Readable modeled tables in this schema
+     * @type {Array<DataSourceTableResponse>}
+     * @memberof DataSourceSchemaResponse
+     */
+    tables?: Array<DataSourceTableResponse>;
 }
+/**
+ * @export
+ */
+export declare const DataSourceSchemaResponsePartTypeEnum: {
+    readonly DataSourceSchema: "DATA_SOURCE_SCHEMA";
+};
+export type DataSourceSchemaResponsePartTypeEnum = typeof DataSourceSchemaResponsePartTypeEnum[keyof typeof DataSourceSchemaResponsePartTypeEnum];
 export declare const DataSourceSchemaResponsePropertyValidationAttributesMap: {
     [property: string]: {
         maxLength?: number;