@knowledge-stack/ksapi 1.95.4 → 1.96.0

package/dist/esm/apis/ChunksApi.js

@@ -37,8 +37,12 @@ export class ChunksApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
-            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/chunks`;
             return {
@@ -81,8 +85,12 @@ export class ChunksApi 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/chunks/{chunk_id}`;
             urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
@@ -127,8 +135,12 @@ export class ChunksApi extends runtime.BaseAPI {
                 queryParameters['with_document'] = requestParameters['withDocument'];
             }
             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/chunks/{chunk_id}`;
             urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
@@ -183,8 +195,12 @@ export class ChunksApi extends runtime.BaseAPI {
                 queryParameters['within_section'] = requestParameters['withinSection'];
             }
             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/chunks/{chunk_id}/neighbors`;
             urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
@@ -227,8 +243,12 @@ export class ChunksApi extends runtime.BaseAPI {
                 queryParameters['chunk_ids'] = requestParameters['chunkIds'];
             }
             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/chunks/bulk`;
             return {
@@ -273,8 +293,12 @@ export class ChunksApi extends runtime.BaseAPI {
                 queryParameters['document_version_id'] = requestParameters['documentVersionId'];
             }
             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/chunks/version-chunk-ids`;
             return {
@@ -317,8 +341,12 @@ export class ChunksApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
-            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/chunks/search`;
             return {
@@ -365,8 +393,12 @@ export class ChunksApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
-            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/chunks/{chunk_id}/content`;
             urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));
@@ -414,8 +446,12 @@ export class ChunksApi extends runtime.BaseAPI {
             const queryParameters = {};
             const headerParameters = {};
             headerParameters['Content-Type'] = 'application/json';
-            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/chunks/{chunk_id}`;
             urlPath = urlPath.replace(`{${"chunk_id"}}`, encodeURIComponent(String(requestParameters['chunkId'])));

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

@@ -0,0 +1,304 @@
+/**
+ * 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 * as runtime from '../runtime';
+import type { CreateDataSourceRequest, DataSourceCatalogResponse, DataSourceDetailResponse, DataSourceQueryRequest, DataSourceQueryResponse, DataSourceResponse, DataSourceTableResponse, ModelTableRequest, UpdateTableRequest } from '../models/index';
+export interface CreateDataSourceOperationRequest {
+    createDataSourceRequest: CreateDataSourceRequest;
+}
+export interface GetDataSourceRequest {
+    dataSourceId: string;
+}
+export interface GetDataSourceCatalogRequest {
+    dataSourceId: string;
+}
+export interface ModelDataSourceTableRequest {
+    dataSourceId: string;
+    modelTableRequest: ModelTableRequest;
+}
+export interface QueryDataSourceRequest {
+    dataSourceId: string;
+    dataSourceQueryRequest: DataSourceQueryRequest;
+}
+export interface TestDataSourceConnectionRequest {
+    dataSourceId: string;
+}
+export interface UpdateDataSourceTableRequest {
+    dataSourceId: string;
+    tableId: string;
+    updateTableRequest: UpdateTableRequest;
+}
+/**
+ * DataSourcesApi - interface
+ *
+ * @export
+ * @interface DataSourcesApiInterface
+ */
+export interface DataSourcesApiInterface {
+    /**
+     * Creates request options for createDataSource without sending the request
+     * @param {CreateDataSourceRequest} createDataSourceRequest
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    createDataSourceRequestOpts(requestParameters: CreateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a connector under a writable folder; test the connection first.
+     * @summary Create Data Source Handler
+     * @param {CreateDataSourceRequest} createDataSourceRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    createDataSourceRaw(requestParameters: CreateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
+    /**
+     * Create a connector under a writable folder; test the connection first.
+     * Create Data Source Handler
+     */
+    createDataSource(requestParameters: CreateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
+    /**
+     * Creates request options for getDataSource without sending the request
+     * @param {string} dataSourceId
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    getDataSourceRequestOpts(requestParameters: GetDataSourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Describe a connector + the modeled tables the caller can read.
+     * @summary Get Data Source Handler
+     * @param {string} dataSourceId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    getDataSourceRaw(requestParameters: GetDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceDetailResponse>>;
+    /**
+     * Describe a connector + the modeled tables the caller can read.
+     * Get Data Source Handler
+     */
+    getDataSource(requestParameters: GetDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceDetailResponse>;
+    /**
+     * Creates request options for getDataSourceCatalog without sending the request
+     * @param {string} dataSourceId
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    getDataSourceCatalogRequestOpts(requestParameters: GetDataSourceCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Live-introspect the external DB so an admin can pick tables to model.
+     * @summary Get Data Source Catalog Handler
+     * @param {string} dataSourceId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    getDataSourceCatalogRaw(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceCatalogResponse>>;
+    /**
+     * Live-introspect the external DB so an admin can pick tables to model.
+     * Get Data Source Catalog Handler
+     */
+    getDataSourceCatalog(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceCatalogResponse>;
+    /**
+     * Creates request options for modelDataSourceTable without sending the request
+     * @param {string} dataSourceId
+     * @param {ModelTableRequest} modelTableRequest
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    modelDataSourceTableRequestOpts(requestParameters: ModelDataSourceTableRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Model a table as a queryable PathPart child; auto-introspect columns.
+     * @summary Model Data Source Table Handler
+     * @param {string} dataSourceId
+     * @param {ModelTableRequest} modelTableRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    modelDataSourceTableRaw(requestParameters: ModelDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceTableResponse>>;
+    /**
+     * Model a table as a queryable PathPart child; auto-introspect columns.
+     * Model Data Source Table Handler
+     */
+    modelDataSourceTable(requestParameters: ModelDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceTableResponse>;
+    /**
+     * Creates request options for queryDataSource without sending the request
+     * @param {string} dataSourceId
+     * @param {DataSourceQueryRequest} dataSourceQueryRequest
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    queryDataSourceRequestOpts(requestParameters: QueryDataSourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Run a read-only SQL query, gated by per-table path permissions.
+     * @summary Query Data Source Handler
+     * @param {string} dataSourceId
+     * @param {DataSourceQueryRequest} dataSourceQueryRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    queryDataSourceRaw(requestParameters: QueryDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceQueryResponse>>;
+    /**
+     * Run a read-only SQL query, gated by per-table path permissions.
+     * Query Data Source Handler
+     */
+    queryDataSource(requestParameters: QueryDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceQueryResponse>;
+    /**
+     * Creates request options for testDataSourceConnection without sending the request
+     * @param {string} dataSourceId
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    testDataSourceConnectionRequestOpts(requestParameters: TestDataSourceConnectionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Re-test a saved connector\'s connection.
+     * @summary Test Data Source Connection Handler
+     * @param {string} dataSourceId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    testDataSourceConnectionRaw(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Re-test a saved connector\'s connection.
+     * Test Data Source Connection Handler
+     */
+    testDataSourceConnection(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateDataSourceTable without sending the request
+     * @param {string} dataSourceId
+     * @param {string} tableId
+     * @param {UpdateTableRequest} updateTableRequest
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    updateDataSourceTableRequestOpts(requestParameters: UpdateDataSourceTableRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Field-modeling: update the table\'s description / column allowlist.
+     * @summary Update Data Source Table Handler
+     * @param {string} dataSourceId
+     * @param {string} tableId
+     * @param {UpdateTableRequest} updateTableRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof DataSourcesApiInterface
+     */
+    updateDataSourceTableRaw(requestParameters: UpdateDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceTableResponse>>;
+    /**
+     * Field-modeling: update the table\'s description / column allowlist.
+     * Update Data Source Table Handler
+     */
+    updateDataSourceTable(requestParameters: UpdateDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceTableResponse>;
+}
+/**
+ *
+ */
+export declare class DataSourcesApi extends runtime.BaseAPI implements DataSourcesApiInterface {
+    /**
+     * Creates request options for createDataSource without sending the request
+     */
+    createDataSourceRequestOpts(requestParameters: CreateDataSourceOperationRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Create a connector under a writable folder; test the connection first.
+     * Create Data Source Handler
+     */
+    createDataSourceRaw(requestParameters: CreateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceResponse>>;
+    /**
+     * Create a connector under a writable folder; test the connection first.
+     * Create Data Source Handler
+     */
+    createDataSource(requestParameters: CreateDataSourceOperationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceResponse>;
+    /**
+     * Creates request options for getDataSource without sending the request
+     */
+    getDataSourceRequestOpts(requestParameters: GetDataSourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Describe a connector + the modeled tables the caller can read.
+     * Get Data Source Handler
+     */
+    getDataSourceRaw(requestParameters: GetDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceDetailResponse>>;
+    /**
+     * Describe a connector + the modeled tables the caller can read.
+     * Get Data Source Handler
+     */
+    getDataSource(requestParameters: GetDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceDetailResponse>;
+    /**
+     * Creates request options for getDataSourceCatalog without sending the request
+     */
+    getDataSourceCatalogRequestOpts(requestParameters: GetDataSourceCatalogRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Live-introspect the external DB so an admin can pick tables to model.
+     * Get Data Source Catalog Handler
+     */
+    getDataSourceCatalogRaw(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceCatalogResponse>>;
+    /**
+     * Live-introspect the external DB so an admin can pick tables to model.
+     * Get Data Source Catalog Handler
+     */
+    getDataSourceCatalog(requestParameters: GetDataSourceCatalogRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceCatalogResponse>;
+    /**
+     * Creates request options for modelDataSourceTable without sending the request
+     */
+    modelDataSourceTableRequestOpts(requestParameters: ModelDataSourceTableRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Model a table as a queryable PathPart child; auto-introspect columns.
+     * Model Data Source Table Handler
+     */
+    modelDataSourceTableRaw(requestParameters: ModelDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceTableResponse>>;
+    /**
+     * Model a table as a queryable PathPart child; auto-introspect columns.
+     * Model Data Source Table Handler
+     */
+    modelDataSourceTable(requestParameters: ModelDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceTableResponse>;
+    /**
+     * Creates request options for queryDataSource without sending the request
+     */
+    queryDataSourceRequestOpts(requestParameters: QueryDataSourceRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Run a read-only SQL query, gated by per-table path permissions.
+     * Query Data Source Handler
+     */
+    queryDataSourceRaw(requestParameters: QueryDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceQueryResponse>>;
+    /**
+     * Run a read-only SQL query, gated by per-table path permissions.
+     * Query Data Source Handler
+     */
+    queryDataSource(requestParameters: QueryDataSourceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceQueryResponse>;
+    /**
+     * Creates request options for testDataSourceConnection without sending the request
+     */
+    testDataSourceConnectionRequestOpts(requestParameters: TestDataSourceConnectionRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Re-test a saved connector\'s connection.
+     * Test Data Source Connection Handler
+     */
+    testDataSourceConnectionRaw(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Re-test a saved connector\'s connection.
+     * Test Data Source Connection Handler
+     */
+    testDataSourceConnection(requestParameters: TestDataSourceConnectionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Creates request options for updateDataSourceTable without sending the request
+     */
+    updateDataSourceTableRequestOpts(requestParameters: UpdateDataSourceTableRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Field-modeling: update the table\'s description / column allowlist.
+     * Update Data Source Table Handler
+     */
+    updateDataSourceTableRaw(requestParameters: UpdateDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DataSourceTableResponse>>;
+    /**
+     * Field-modeling: update the table\'s description / column allowlist.
+     * Update Data Source Table Handler
+     */
+    updateDataSourceTable(requestParameters: UpdateDataSourceTableRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DataSourceTableResponse>;
+}