@knowledge-stack/ksapi 1.95.3 → 1.96.0

package/dist/esm/apis/DataSourcesApi.js

@@ -0,0 +1,384 @@
+/* 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.
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+import * as runtime from '../runtime';
+import { CreateDataSourceRequestToJSON, DataSourceCatalogResponseFromJSON, DataSourceDetailResponseFromJSON, DataSourceQueryRequestToJSON, DataSourceQueryResponseFromJSON, DataSourceResponseFromJSON, DataSourceTableResponseFromJSON, ModelTableRequestToJSON, UpdateTableRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class DataSourcesApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for createDataSource without sending the request
+     */
+    createDataSourceRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['createDataSourceRequest'] == null) {
+                throw new runtime.RequiredError('createDataSourceRequest', 'Required parameter "createDataSourceRequest" was null or undefined when calling createDataSource().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: CreateDataSourceRequestToJSON(requestParameters['createDataSourceRequest']),
+            };
+        });
+    }
+    /**
+     * Create a connector under a writable folder; test the connection first.
+     * Create Data Source Handler
+     */
+    createDataSourceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.createDataSourceRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Create a connector under a writable folder; test the connection first.
+     * Create Data Source Handler
+     */
+    createDataSource(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.createDataSourceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getDataSource without sending the request
+     */
+    getDataSourceRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dataSourceId'] == null) {
+                throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling getDataSource().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources/{data_source_id}`;
+            urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Describe a connector + the modeled tables the caller can read.
+     * Get Data Source Handler
+     */
+    getDataSourceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDataSourceRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceDetailResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Describe a connector + the modeled tables the caller can read.
+     * Get Data Source Handler
+     */
+    getDataSource(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDataSourceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for getDataSourceCatalog without sending the request
+     */
+    getDataSourceCatalogRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dataSourceId'] == null) {
+                throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling getDataSourceCatalog().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources/{data_source_id}/catalog`;
+            urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
+            return {
+                path: urlPath,
+                method: 'GET',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Live-introspect the external DB so an admin can pick tables to model.
+     * Get Data Source Catalog Handler
+     */
+    getDataSourceCatalogRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.getDataSourceCatalogRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceCatalogResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Live-introspect the external DB so an admin can pick tables to model.
+     * Get Data Source Catalog Handler
+     */
+    getDataSourceCatalog(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.getDataSourceCatalogRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for modelDataSourceTable without sending the request
+     */
+    modelDataSourceTableRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dataSourceId'] == null) {
+                throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling modelDataSourceTable().');
+            }
+            if (requestParameters['modelTableRequest'] == null) {
+                throw new runtime.RequiredError('modelTableRequest', 'Required parameter "modelTableRequest" was null or undefined when calling modelDataSourceTable().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources/{data_source_id}/tables`;
+            urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: ModelTableRequestToJSON(requestParameters['modelTableRequest']),
+            };
+        });
+    }
+    /**
+     * Model a table as a queryable PathPart child; auto-introspect columns.
+     * Model Data Source Table Handler
+     */
+    modelDataSourceTableRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.modelDataSourceTableRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceTableResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Model a table as a queryable PathPart child; auto-introspect columns.
+     * Model Data Source Table Handler
+     */
+    modelDataSourceTable(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.modelDataSourceTableRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for queryDataSource without sending the request
+     */
+    queryDataSourceRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dataSourceId'] == null) {
+                throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling queryDataSource().');
+            }
+            if (requestParameters['dataSourceQueryRequest'] == null) {
+                throw new runtime.RequiredError('dataSourceQueryRequest', 'Required parameter "dataSourceQueryRequest" was null or undefined when calling queryDataSource().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources/{data_source_id}/query`;
+            urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: DataSourceQueryRequestToJSON(requestParameters['dataSourceQueryRequest']),
+            };
+        });
+    }
+    /**
+     * Run a read-only SQL query, gated by per-table path permissions.
+     * Query Data Source Handler
+     */
+    queryDataSourceRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.queryDataSourceRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceQueryResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Run a read-only SQL query, gated by per-table path permissions.
+     * Query Data Source Handler
+     */
+    queryDataSource(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.queryDataSourceRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+    /**
+     * Creates request options for testDataSourceConnection without sending the request
+     */
+    testDataSourceConnectionRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dataSourceId'] == null) {
+                throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling testDataSourceConnection().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources/{data_source_id}/test`;
+            urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+            };
+        });
+    }
+    /**
+     * Re-test a saved connector\'s connection.
+     * Test Data Source Connection Handler
+     */
+    testDataSourceConnectionRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.testDataSourceConnectionRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.VoidApiResponse(response);
+        });
+    }
+    /**
+     * Re-test a saved connector\'s connection.
+     * Test Data Source Connection Handler
+     */
+    testDataSourceConnection(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.testDataSourceConnectionRaw(requestParameters, initOverrides);
+        });
+    }
+    /**
+     * Creates request options for updateDataSourceTable without sending the request
+     */
+    updateDataSourceTableRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['dataSourceId'] == null) {
+                throw new runtime.RequiredError('dataSourceId', 'Required parameter "dataSourceId" was null or undefined when calling updateDataSourceTable().');
+            }
+            if (requestParameters['tableId'] == null) {
+                throw new runtime.RequiredError('tableId', 'Required parameter "tableId" was null or undefined when calling updateDataSourceTable().');
+            }
+            if (requestParameters['updateTableRequest'] == null) {
+                throw new runtime.RequiredError('updateTableRequest', 'Required parameter "updateTableRequest" was null or undefined when calling updateDataSourceTable().');
+            }
+            const queryParameters = {};
+            const headerParameters = {};
+            headerParameters['Content-Type'] = 'application/json';
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
+            }
+            let urlPath = `/v1/data-sources/{data_source_id}/tables/{table_id}`;
+            urlPath = urlPath.replace(`{${"data_source_id"}}`, encodeURIComponent(String(requestParameters['dataSourceId'])));
+            urlPath = urlPath.replace(`{${"table_id"}}`, encodeURIComponent(String(requestParameters['tableId'])));
+            return {
+                path: urlPath,
+                method: 'PATCH',
+                headers: headerParameters,
+                query: queryParameters,
+                body: UpdateTableRequestToJSON(requestParameters['updateTableRequest']),
+            };
+        });
+    }
+    /**
+     * Field-modeling: update the table\'s description / column allowlist.
+     * Update Data Source Table Handler
+     */
+    updateDataSourceTableRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.updateDataSourceTableRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.JSONApiResponse(response, (jsonValue) => DataSourceTableResponseFromJSON(jsonValue));
+        });
+    }
+    /**
+     * Field-modeling: update the table\'s description / column allowlist.
+     * Update Data Source Table Handler
+     */
+    updateDataSourceTable(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.updateDataSourceTableRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

package/dist/esm/apis/DocumentCheckoutApi.d.ts

@@ -14,18 +14,12 @@ import type { DocumentCheckoutResponse } from '../models/index';
 export interface AcquireDocumentCheckoutRequest {
     documentId: string;
     force?: boolean;
-    authorization?: string | null;
-    ksUat?: string | null;
 }
 export interface GetDocumentCheckoutRequest {
     documentId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
 }
 export interface ReleaseDocumentCheckoutRequest {
     documentId: string;
-    authorization?: string | null;
-    ksUat?: string | null;
 }
 /**
  * DocumentCheckoutApi - interface
@@ -38,8 +32,6 @@ export interface DocumentCheckoutApiInterface {
      * Creates request options for acquireDocumentCheckout without sending the request
      * @param {string} documentId Document ID
      * @param {boolean} [force] OWNER/ADMIN only — atomically take the checkout regardless of the current holder. Sealed docs are still refused.
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
      * @throws {RequiredError}
      * @memberof DocumentCheckoutApiInterface
      */
@@ -49,8 +41,6 @@ export interface DocumentCheckoutApiInterface {
      * @summary Acquire Document Checkout Handler
      * @param {string} documentId Document ID
      * @param {boolean} [force] OWNER/ADMIN only — atomically take the checkout regardless of the current holder. Sealed docs are still refused.
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentCheckoutApiInterface
@@ -64,8 +54,6 @@ export interface DocumentCheckoutApiInterface {
     /**
      * Creates request options for getDocumentCheckout without sending the request
      * @param {string} documentId Document ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
      * @throws {RequiredError}
      * @memberof DocumentCheckoutApiInterface
      */
@@ -74,8 +62,6 @@ export interface DocumentCheckoutApiInterface {
      * Get the active checkout for the document.  404 if no active checkout exists. The holder can always GET their own lock regardless of current path permissions (parallel to the release holder-bypass).
      * @summary Get Document Checkout Handler
      * @param {string} documentId Document ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentCheckoutApiInterface
@@ -89,8 +75,6 @@ export interface DocumentCheckoutApiInterface {
     /**
      * Creates request options for releaseDocumentCheckout without sending the request
      * @param {string} documentId Document ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
      * @throws {RequiredError}
      * @memberof DocumentCheckoutApiInterface
      */
@@ -99,8 +83,6 @@ export interface DocumentCheckoutApiInterface {
      * Release the write lock on the document.  Only the holder may release the lock; others receive 403. The holder can always release regardless of current path permissions (in case a folder move relocated the doc to a path the holder can no longer write to).
      * @summary Release Document Checkout Handler
      * @param {string} documentId Document ID
-     * @param {string} [authorization]
-     * @param {string} [ksUat]
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
      * @memberof DocumentCheckoutApiInterface

package/dist/esm/apis/DocumentCheckoutApi.js

@@ -39,8 +39,12 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
                 queryParameters['force'] = requestParameters['force'];
             }
             const headerParameters = {};
-            if (requestParameters['authorization'] != null) {
-                headerParameters['authorization'] = String(requestParameters['authorization']);
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
             }
             let urlPath = `/v1/documents/{document_id}/checkout`;
             urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
@@ -83,8 +87,12 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
-            if (requestParameters['authorization'] != null) {
-                headerParameters['authorization'] = String(requestParameters['authorization']);
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
             }
             let urlPath = `/v1/documents/{document_id}/checkout`;
             urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));
@@ -127,8 +135,12 @@ export class DocumentCheckoutApi extends runtime.BaseAPI {
             }
             const queryParameters = {};
             const headerParameters = {};
-            if (requestParameters['authorization'] != null) {
-                headerParameters['authorization'] = String(requestParameters['authorization']);
+            if (this.configuration && this.configuration.accessToken) {
+                const token = this.configuration.accessToken;
+                const tokenString = yield token("bearerAuth", []);
+                if (tokenString) {
+                    headerParameters["Authorization"] = `Bearer ${tokenString}`;
+                }
             }
             let urlPath = `/v1/documents/{document_id}/checkout`;
             urlPath = urlPath.replace(`{${"document_id"}}`, encodeURIComponent(String(requestParameters['documentId'])));