@knowledge-stack/ksapi 1.112.0 → 1.114.0

package/.openapi-generator/FILES

@@ -23,6 +23,8 @@ docs/AskResponse.md
 docs/AuditEventsApi.md
 docs/AuthApi.md
 docs/BrandingLogoType.md
+docs/BulkDownloadApi.md
+docs/BulkDownloadRequest.md
 docs/BulkTagRequest.md
 docs/CatalogColumnResponse.md
 docs/CatalogTableResponse.md
@@ -337,6 +339,7 @@ src/apis/ApiConnectionsApi.ts
 src/apis/ApiKeysApi.ts
 src/apis/AuditEventsApi.ts
 src/apis/AuthApi.ts
+src/apis/BulkDownloadApi.ts
 src/apis/ChunkLineagesApi.ts
 src/apis/ChunksApi.ts
 src/apis/DataSourcesApi.ts
@@ -384,6 +387,7 @@ src/models/Args.ts
 src/models/AskRequest.ts
 src/models/AskResponse.ts
 src/models/BrandingLogoType.ts
+src/models/BulkDownloadRequest.ts
 src/models/BulkTagRequest.ts
 src/models/CatalogColumnResponse.ts
 src/models/CatalogTableResponse.ts

package/README.md

@@ -1,4 +1,4 @@
-# @knowledge-stack/ksapi@1.112.0
+# @knowledge-stack/ksapi@1.114.0
 
 A TypeScript SDK client for the localhost API.
 
@@ -88,6 +88,7 @@ All URIs are relative to *http://localhost:8000*
 *AuthApi* | [**signout**](docs/AuthApi.md#signout) | **POST** /v1/auth/signout | Signout Handler
 *AuthApi* | [**ssoSignin**](docs/AuthApi.md#ssosignin) | **GET** /v1/auth/sso/{tenant_id}/signin | Sso Login Handler
 *AuthApi* | [**validatePwResetCode**](docs/AuthApi.md#validatepwresetcode) | **POST** /v1/auth/pw/validate_reset_code | Validate Reset Code Handler
+*BulkDownloadApi* | [**startBulkDownload**](docs/BulkDownloadApi.md#startbulkdownload) | **POST** /v1/bulk-download | Start Bulk Download Handler
 *ChunkLineagesApi* | [**createChunkLineage**](docs/ChunkLineagesApi.md#createchunklineageoperation) | **POST** /v1/chunk-lineages | Create Chunk Lineage Handler
 *ChunkLineagesApi* | [**deleteChunkLineage**](docs/ChunkLineagesApi.md#deletechunklineage) | **DELETE** /v1/chunk-lineages | Delete Chunk Lineage Handler
 *ChunkLineagesApi* | [**getChunkLineage**](docs/ChunkLineagesApi.md#getchunklineage) | **GET** /v1/chunk-lineages/{chunk_id} | Get Chunk Lineage Handler
@@ -277,6 +278,7 @@ All URIs are relative to *http://localhost:8000*
 - [AskRequest](docs/AskRequest.md)
 - [AskResponse](docs/AskResponse.md)
 - [BrandingLogoType](docs/BrandingLogoType.md)
+- [BulkDownloadRequest](docs/BulkDownloadRequest.md)
 - [BulkTagRequest](docs/BulkTagRequest.md)
 - [CatalogColumnResponse](docs/CatalogColumnResponse.md)
 - [CatalogTableResponse](docs/CatalogTableResponse.md)
@@ -581,7 +583,7 @@ and is automatically generated by the
 [OpenAPI Generator](https://openapi-generator.tech) project:
 
 - API version: `0.1.0`
-- Package version: `1.112.0`
+- Package version: `1.114.0`
 - Generator version: `7.21.0`
 - Build package: `org.openapitools.codegen.languages.TypeScriptFetchClientCodegen`
 

package/dist/apis/BulkDownloadApi.d.ts

@@ -0,0 +1,64 @@
+/**
+ * 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 { BulkDownloadRequest } from '../models/index';
+export interface StartBulkDownloadRequest {
+    bulkDownloadRequest: BulkDownloadRequest;
+}
+/**
+ * BulkDownloadApi - interface
+ *
+ * @export
+ * @interface BulkDownloadApiInterface
+ */
+export interface BulkDownloadApiInterface {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     * @param {BulkDownloadRequest} bulkDownloadRequest
+     * @throws {RequiredError}
+     * @memberof BulkDownloadApiInterface
+     */
+    startBulkDownloadRequestOpts(requestParameters: StartBulkDownloadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * @summary Start Bulk Download Handler
+     * @param {BulkDownloadRequest} bulkDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkDownloadApiInterface
+     */
+    startBulkDownloadRaw(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+}
+/**
+ *
+ */
+export declare class BulkDownloadApi extends runtime.BaseAPI implements BulkDownloadApiInterface {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     */
+    startBulkDownloadRequestOpts(requestParameters: StartBulkDownloadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownloadRaw(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+}

package/dist/apis/BulkDownloadApi.js

@@ -0,0 +1,115 @@
+"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.
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BulkDownloadApi = void 0;
+const runtime = __importStar(require("../runtime"));
+const index_1 = require("../models/index");
+/**
+ *
+ */
+class BulkDownloadApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     */
+    startBulkDownloadRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['bulkDownloadRequest'] == null) {
+                throw new runtime.RequiredError('bulkDownloadRequest', 'Required parameter "bulkDownloadRequest" was null or undefined when calling startBulkDownload().');
+            }
+            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/bulk-download`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: (0, index_1.BulkDownloadRequestToJSON)(requestParameters['bulkDownloadRequest']),
+            };
+        });
+    }
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownloadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.startBulkDownloadRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.startBulkDownloadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}
+exports.BulkDownloadApi = BulkDownloadApi;

package/dist/apis/index.d.ts

@@ -3,6 +3,7 @@ export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';
 export * from './AuditEventsApi';
 export * from './AuthApi';
+export * from './BulkDownloadApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DataSourcesApi';

package/dist/apis/index.js

@@ -21,6 +21,7 @@ __exportStar(require("./ApiConnectionsApi"), exports);
 __exportStar(require("./ApiKeysApi"), exports);
 __exportStar(require("./AuditEventsApi"), exports);
 __exportStar(require("./AuthApi"), exports);
+__exportStar(require("./BulkDownloadApi"), exports);
 __exportStar(require("./ChunkLineagesApi"), exports);
 __exportStar(require("./ChunksApi"), exports);
 __exportStar(require("./DataSourcesApi"), exports);

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

@@ -0,0 +1,64 @@
+/**
+ * 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 { BulkDownloadRequest } from '../models/index';
+export interface StartBulkDownloadRequest {
+    bulkDownloadRequest: BulkDownloadRequest;
+}
+/**
+ * BulkDownloadApi - interface
+ *
+ * @export
+ * @interface BulkDownloadApiInterface
+ */
+export interface BulkDownloadApiInterface {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     * @param {BulkDownloadRequest} bulkDownloadRequest
+     * @throws {RequiredError}
+     * @memberof BulkDownloadApiInterface
+     */
+    startBulkDownloadRequestOpts(requestParameters: StartBulkDownloadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * @summary Start Bulk Download Handler
+     * @param {BulkDownloadRequest} bulkDownloadRequest
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkDownloadApiInterface
+     */
+    startBulkDownloadRaw(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+}
+/**
+ *
+ */
+export declare class BulkDownloadApi extends runtime.BaseAPI implements BulkDownloadApiInterface {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     */
+    startBulkDownloadRequestOpts(requestParameters: StartBulkDownloadRequest): Promise<runtime.RequestOpts>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownloadRaw(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+}

package/dist/esm/apis/BulkDownloadApi.js

@@ -0,0 +1,78 @@
+/* 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 { BulkDownloadRequestToJSON, } from '../models/index';
+/**
+ *
+ */
+export class BulkDownloadApi extends runtime.BaseAPI {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     */
+    startBulkDownloadRequestOpts(requestParameters) {
+        return __awaiter(this, void 0, void 0, function* () {
+            if (requestParameters['bulkDownloadRequest'] == null) {
+                throw new runtime.RequiredError('bulkDownloadRequest', 'Required parameter "bulkDownloadRequest" was null or undefined when calling startBulkDownload().');
+            }
+            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/bulk-download`;
+            return {
+                path: urlPath,
+                method: 'POST',
+                headers: headerParameters,
+                query: queryParameters,
+                body: BulkDownloadRequestToJSON(requestParameters['bulkDownloadRequest']),
+            };
+        });
+    }
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownloadRaw(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const requestOptions = yield this.startBulkDownloadRequestOpts(requestParameters);
+            const response = yield this.request(requestOptions, initOverrides);
+            return new runtime.BlobApiResponse(response);
+        });
+    }
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function* () {
+            const response = yield this.startBulkDownloadRaw(requestParameters, initOverrides);
+            return yield response.value();
+        });
+    }
+}

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

@@ -3,6 +3,7 @@ export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';
 export * from './AuditEventsApi';
 export * from './AuthApi';
+export * from './BulkDownloadApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DataSourcesApi';

package/dist/esm/apis/index.js

@@ -5,6 +5,7 @@ export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';
 export * from './AuditEventsApi';
 export * from './AuthApi';
+export * from './BulkDownloadApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DataSourcesApi';

package/dist/esm/models/BulkDownloadRequest.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 selection of folders and/or documents to package into one ``.zip``.
+ *
+ * Folder ids and document ids are PDO ids. Folders are enumerated recursively;
+ * documents are included directly. At least one id must be provided.
+ * @export
+ * @interface BulkDownloadRequest
+ */
+export interface BulkDownloadRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkDownloadRequest
+     */
+    folderIds?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkDownloadRequest
+     */
+    documentIds?: Array<string>;
+}
+export declare const BulkDownloadRequestPropertyValidationAttributesMap: {
+    [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 BulkDownloadRequest interface.
+ */
+export declare function instanceOfBulkDownloadRequest(value: object): value is BulkDownloadRequest;
+export declare function BulkDownloadRequestFromJSON(json: any): BulkDownloadRequest;
+export declare function BulkDownloadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkDownloadRequest;
+export declare function BulkDownloadRequestToJSON(json: any): BulkDownloadRequest;
+export declare function BulkDownloadRequestToJSONTyped(value?: BulkDownloadRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/esm/models/BulkDownloadRequest.js

@@ -0,0 +1,53 @@
+/* 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 const BulkDownloadRequestPropertyValidationAttributesMap = {
+    folderIds: {
+        maxItems: 200,
+        uniqueItems: false,
+    },
+    documentIds: {
+        maxItems: 200,
+        uniqueItems: false,
+    },
+};
+/**
+ * Check if a given object implements the BulkDownloadRequest interface.
+ */
+export function instanceOfBulkDownloadRequest(value) {
+    return true;
+}
+export function BulkDownloadRequestFromJSON(json) {
+    return BulkDownloadRequestFromJSONTyped(json, false);
+}
+export function BulkDownloadRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'folderIds': json['folder_ids'] == null ? undefined : json['folder_ids'],
+        'documentIds': json['document_ids'] == null ? undefined : json['document_ids'],
+    };
+}
+export function BulkDownloadRequestToJSON(json) {
+    return BulkDownloadRequestToJSONTyped(json, false);
+}
+export function BulkDownloadRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'folder_ids': value['folderIds'],
+        'document_ids': value['documentIds'],
+    };
+}

package/dist/esm/models/index.d.ts

@@ -14,6 +14,7 @@ export * from './Args';
 export * from './AskRequest';
 export * from './AskResponse';
 export * from './BrandingLogoType';
+export * from './BulkDownloadRequest';
 export * from './BulkTagRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';

package/dist/esm/models/index.js

@@ -16,6 +16,7 @@ export * from './Args';
 export * from './AskRequest';
 export * from './AskResponse';
 export * from './BrandingLogoType';
+export * from './BulkDownloadRequest';
 export * from './BulkTagRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';

package/dist/models/BulkDownloadRequest.d.ts

@@ -0,0 +1,56 @@
+/**
+ * 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 selection of folders and/or documents to package into one ``.zip``.
+ *
+ * Folder ids and document ids are PDO ids. Folders are enumerated recursively;
+ * documents are included directly. At least one id must be provided.
+ * @export
+ * @interface BulkDownloadRequest
+ */
+export interface BulkDownloadRequest {
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkDownloadRequest
+     */
+    folderIds?: Array<string>;
+    /**
+     *
+     * @type {Array<string>}
+     * @memberof BulkDownloadRequest
+     */
+    documentIds?: Array<string>;
+}
+export declare const BulkDownloadRequestPropertyValidationAttributesMap: {
+    [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 BulkDownloadRequest interface.
+ */
+export declare function instanceOfBulkDownloadRequest(value: object): value is BulkDownloadRequest;
+export declare function BulkDownloadRequestFromJSON(json: any): BulkDownloadRequest;
+export declare function BulkDownloadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkDownloadRequest;
+export declare function BulkDownloadRequestToJSON(json: any): BulkDownloadRequest;
+export declare function BulkDownloadRequestToJSONTyped(value?: BulkDownloadRequest | null, ignoreDiscriminator?: boolean): any;

package/dist/models/BulkDownloadRequest.js

@@ -0,0 +1,61 @@
+"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.BulkDownloadRequestPropertyValidationAttributesMap = void 0;
+exports.instanceOfBulkDownloadRequest = instanceOfBulkDownloadRequest;
+exports.BulkDownloadRequestFromJSON = BulkDownloadRequestFromJSON;
+exports.BulkDownloadRequestFromJSONTyped = BulkDownloadRequestFromJSONTyped;
+exports.BulkDownloadRequestToJSON = BulkDownloadRequestToJSON;
+exports.BulkDownloadRequestToJSONTyped = BulkDownloadRequestToJSONTyped;
+exports.BulkDownloadRequestPropertyValidationAttributesMap = {
+    folderIds: {
+        maxItems: 200,
+        uniqueItems: false,
+    },
+    documentIds: {
+        maxItems: 200,
+        uniqueItems: false,
+    },
+};
+/**
+ * Check if a given object implements the BulkDownloadRequest interface.
+ */
+function instanceOfBulkDownloadRequest(value) {
+    return true;
+}
+function BulkDownloadRequestFromJSON(json) {
+    return BulkDownloadRequestFromJSONTyped(json, false);
+}
+function BulkDownloadRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if (json == null) {
+        return json;
+    }
+    return {
+        'folderIds': json['folder_ids'] == null ? undefined : json['folder_ids'],
+        'documentIds': json['document_ids'] == null ? undefined : json['document_ids'],
+    };
+}
+function BulkDownloadRequestToJSON(json) {
+    return BulkDownloadRequestToJSONTyped(json, false);
+}
+function BulkDownloadRequestToJSONTyped(value, ignoreDiscriminator = false) {
+    if (value == null) {
+        return value;
+    }
+    return {
+        'folder_ids': value['folderIds'],
+        'document_ids': value['documentIds'],
+    };
+}

package/dist/models/index.d.ts

@@ -14,6 +14,7 @@ export * from './Args';
 export * from './AskRequest';
 export * from './AskResponse';
 export * from './BrandingLogoType';
+export * from './BulkDownloadRequest';
 export * from './BulkTagRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';

package/dist/models/index.js

@@ -32,6 +32,7 @@ __exportStar(require("./Args"), exports);
 __exportStar(require("./AskRequest"), exports);
 __exportStar(require("./AskResponse"), exports);
 __exportStar(require("./BrandingLogoType"), exports);
+__exportStar(require("./BulkDownloadRequest"), exports);
 __exportStar(require("./BulkTagRequest"), exports);
 __exportStar(require("./CatalogColumnResponse"), exports);
 __exportStar(require("./CatalogTableResponse"), exports);

package/docs/BulkDownloadApi.md

@@ -0,0 +1,84 @@
+# BulkDownloadApi
+
+All URIs are relative to *http://localhost:8000*
+
+| Method | HTTP request | Description |
+|------------- | ------------- | -------------|
+| [**startBulkDownload**](BulkDownloadApi.md#startbulkdownload) | **POST** /v1/bulk-download | Start Bulk Download Handler |
+
+
+
+## startBulkDownload
+
+> Blob startBulkDownload(bulkDownloadRequest)
+
+Start Bulk Download Handler
+
+Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+
+### Example
+
+```ts
+import {
+  Configuration,
+  BulkDownloadApi,
+} from '@knowledge-stack/ksapi';
+import type { StartBulkDownloadRequest } from '@knowledge-stack/ksapi';
+
+async function example() {
+  console.log("🚀 Testing @knowledge-stack/ksapi SDK...");
+  const config = new Configuration({ 
+    // To configure API key authorization: cookieAuth
+    apiKey: "YOUR API KEY",
+    // Configure HTTP bearer authorization: bearerAuth
+    accessToken: "YOUR BEARER TOKEN",
+  });
+  const api = new BulkDownloadApi(config);
+
+  const body = {
+    // BulkDownloadRequest
+    bulkDownloadRequest: ...,
+  } satisfies StartBulkDownloadRequest;
+
+  try {
+    const data = await api.startBulkDownload(body);
+    console.log(data);
+  } catch (error) {
+    console.error(error);
+  }
+}
+
+// Run the test
+example().catch(console.error);
+```
+
+### Parameters
+
+
+| Name | Type | Description  | Notes |
+|------------- | ------------- | ------------- | -------------|
+| **bulkDownloadRequest** | [BulkDownloadRequest](BulkDownloadRequest.md) |  | |
+
+### Return type
+
+**Blob**
+
+### Authorization
+
+[cookieAuth](../README.md#cookieAuth), [bearerAuth](../README.md#bearerAuth)
+
+### HTTP request headers
+
+- **Content-Type**: `application/json`
+- **Accept**: `application/zip`, `application/json`
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+| **200** | A ZIP archive of the selected documents. |  -  |
+| **422** | Validation Error |  -  |
+| **0** | Error response. |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+

package/docs/BulkDownloadRequest.md

@@ -0,0 +1,37 @@
+
+# BulkDownloadRequest
+
+A selection of folders and/or documents to package into one ``.zip``.  Folder ids and document ids are PDO ids. Folders are enumerated recursively; documents are included directly. At least one id must be provided.
+
+## Properties
+
+Name | Type
+------------ | -------------
+`folderIds` | Array<string>
+`documentIds` | Array<string>
+
+## Example
+
+```typescript
+import type { BulkDownloadRequest } from '@knowledge-stack/ksapi'
+
+// TODO: Update the object below with actual values
+const example = {
+  "folderIds": null,
+  "documentIds": null,
+} satisfies BulkDownloadRequest
+
+console.log(example)
+
+// Convert the instance to a JSON string
+const exampleJSON: string = JSON.stringify(example)
+console.log(exampleJSON)
+
+// Parse the JSON string back to an object
+const exampleParsed = JSON.parse(exampleJSON) as BulkDownloadRequest
+console.log(exampleParsed)
+```
+
+[[Back to top]](#) [[Back to API list]](../README.md#api-endpoints) [[Back to Model list]](../README.md#models) [[Back to README]](../README.md)
+
+

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@knowledge-stack/ksapi",
-  "version": "1.112.0",
+  "version": "1.114.0",
   "description": "OpenAPI client for @knowledge-stack/ksapi",
   "author": "OpenAPI-Generator",
   "repository": {

package/src/apis/BulkDownloadApi.ts

@@ -0,0 +1,130 @@
+/* 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 * as runtime from '../runtime';
+import type {
+  BulkDownloadRequest,
+  ErrorResponse,
+  HTTPValidationError,
+} from '../models/index';
+import {
+    BulkDownloadRequestFromJSON,
+    BulkDownloadRequestToJSON,
+    ErrorResponseFromJSON,
+    ErrorResponseToJSON,
+    HTTPValidationErrorFromJSON,
+    HTTPValidationErrorToJSON,
+} from '../models/index';
+
+export interface StartBulkDownloadRequest {
+    bulkDownloadRequest: BulkDownloadRequest;
+}
+
+/**
+ * BulkDownloadApi - interface
+ * 
+ * @export
+ * @interface BulkDownloadApiInterface
+ */
+export interface BulkDownloadApiInterface {
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     * @param {BulkDownloadRequest} bulkDownloadRequest 
+     * @throws {RequiredError}
+     * @memberof BulkDownloadApiInterface
+     */
+    startBulkDownloadRequestOpts(requestParameters: StartBulkDownloadRequest): Promise<runtime.RequestOpts>;
+
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * @summary Start Bulk Download Handler
+     * @param {BulkDownloadRequest} bulkDownloadRequest 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof BulkDownloadApiInterface
+     */
+    startBulkDownloadRaw(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>>;
+
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    startBulkDownload(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob>;
+
+}
+
+/**
+ * 
+ */
+export class BulkDownloadApi extends runtime.BaseAPI implements BulkDownloadApiInterface {
+
+    /**
+     * Creates request options for startBulkDownload without sending the request
+     */
+    async startBulkDownloadRequestOpts(requestParameters: StartBulkDownloadRequest): Promise<runtime.RequestOpts> {
+        if (requestParameters['bulkDownloadRequest'] == null) {
+            throw new runtime.RequiredError(
+                'bulkDownloadRequest',
+                'Required parameter "bulkDownloadRequest" was null or undefined when calling startBulkDownload().'
+            );
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            const token = this.configuration.accessToken;
+            const tokenString = await token("bearerAuth", []);
+
+            if (tokenString) {
+                headerParameters["Authorization"] = `Bearer ${tokenString}`;
+            }
+        }
+
+        let urlPath = `/v1/bulk-download`;
+
+        return {
+            path: urlPath,
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: BulkDownloadRequestToJSON(requestParameters['bulkDownloadRequest']),
+        };
+    }
+
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    async startBulkDownloadRaw(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Blob>> {
+        const requestOptions = await this.startBulkDownloadRequestOpts(requestParameters);
+        const response = await this.request(requestOptions, initOverrides);
+
+        return new runtime.BlobApiResponse(response);
+    }
+
+    /**
+     * Package the selected folders/documents into one ``.zip`` and stream it.  Folders are enumerated recursively; trashed and unreadable items are excluded, and each included file is recorded as a ``document.downloaded`` audit event. The selection is capped — exceeding it returns ``400``. Files that cannot be included (no source, still ingesting) are skipped; the count is returned in the ``X-Bulk-Download-Skipped`` header.
+     * Start Bulk Download Handler
+     */
+    async startBulkDownload(requestParameters: StartBulkDownloadRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Blob> {
+        const response = await this.startBulkDownloadRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
+}

package/src/apis/index.ts

@@ -5,6 +5,7 @@ export * from './ApiConnectionsApi';
 export * from './ApiKeysApi';
 export * from './AuditEventsApi';
 export * from './AuthApi';
+export * from './BulkDownloadApi';
 export * from './ChunkLineagesApi';
 export * from './ChunksApi';
 export * from './DataSourcesApi';

package/src/models/BulkDownloadRequest.ts

@@ -0,0 +1,101 @@
+/* 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';
+/**
+ * A selection of folders and/or documents to package into one ``.zip``.
+ * 
+ * Folder ids and document ids are PDO ids. Folders are enumerated recursively;
+ * documents are included directly. At least one id must be provided.
+ * @export
+ * @interface BulkDownloadRequest
+ */
+export interface BulkDownloadRequest {
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof BulkDownloadRequest
+     */
+    folderIds?: Array<string>;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof BulkDownloadRequest
+     */
+    documentIds?: Array<string>;
+}
+export const BulkDownloadRequestPropertyValidationAttributesMap: {
+    [property: string]: {
+        maxLength?: number,
+        minLength?: number,
+        pattern?: string,
+        maximum?: number,
+        exclusiveMaximum?: boolean,
+        minimum?: number,
+        exclusiveMinimum?: boolean,
+        multipleOf?: number,
+        maxItems?: number,
+        minItems?: number,
+        uniqueItems?: boolean
+    }
+} = {
+    folderIds: {
+        maxItems: 200,
+        uniqueItems: false,
+    },
+    documentIds: {
+        maxItems: 200,
+        uniqueItems: false,
+    },
+}
+
+
+/**
+ * Check if a given object implements the BulkDownloadRequest interface.
+ */
+export function instanceOfBulkDownloadRequest(value: object): value is BulkDownloadRequest {
+    return true;
+}
+
+export function BulkDownloadRequestFromJSON(json: any): BulkDownloadRequest {
+    return BulkDownloadRequestFromJSONTyped(json, false);
+}
+
+export function BulkDownloadRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): BulkDownloadRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'folderIds': json['folder_ids'] == null ? undefined : json['folder_ids'],
+        'documentIds': json['document_ids'] == null ? undefined : json['document_ids'],
+    };
+}
+
+export function BulkDownloadRequestToJSON(json: any): BulkDownloadRequest {
+    return BulkDownloadRequestToJSONTyped(json, false);
+}
+
+export function BulkDownloadRequestToJSONTyped(value?: BulkDownloadRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'folder_ids': value['folderIds'],
+        'document_ids': value['documentIds'],
+    };
+}
+

package/src/models/index.ts

@@ -16,6 +16,7 @@ export * from './Args';
 export * from './AskRequest';
 export * from './AskResponse';
 export * from './BrandingLogoType';
+export * from './BulkDownloadRequest';
 export * from './BulkTagRequest';
 export * from './CatalogColumnResponse';
 export * from './CatalogTableResponse';