@openfilz-sdk/typescript 1.3.48 → 1.3.49

package/.openapi-generator/FILES

@@ -19,6 +19,7 @@ api/favorites-api.ts
 api/file-controller-api.ts
 api/folder-controller-api.ts
 api/mcp-discovery-controller-api.ts
+api/metadata-key-controller-api.ts
 api/pdftools-api.ts
 api/quota-administration-api.ts
 api/quotas-api.ts
@@ -106,6 +107,8 @@ docs/ListAiModelsRequest.md
 docs/McpDiscoveryControllerApi.md
 docs/MergeRequest.md
 docs/MergeSource.md
+docs/MetadataKeyControllerApi.md
+docs/MetadataKeySuggestion.md
 docs/MoveAudit.md
 docs/MoveRequest.md
 docs/MyStorageQuota.md
@@ -263,6 +266,7 @@ models/item.ts
 models/list-ai-models-request.ts
 models/merge-request.ts
 models/merge-source.ts
+models/metadata-key-suggestion.ts
 models/move-audit.ts
 models/move-request.ts
 models/my-storage-quota.ts

package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256

@@ -1 +1 @@
-f376e78727406f6fec09b4af2fa032bb557b19fc0812d3f29bee801e11cef00c
+bd85dc61415dec2701c4754195e4dec927f8ad32cf849bbc005cd60c945e24ca

package/README.md

@@ -1,4 +1,4 @@
-## @openfilz-sdk/typescript@1.3.48
+## @openfilz-sdk/typescript@1.3.49
 
 This generator creates TypeScript/JavaScript client that utilizes [axios](https://github.com/axios/axios). The generated Node module can be used in the following environments:
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
 _published:_
 
 ```
-npm install @openfilz-sdk/typescript@1.3.48 --save
+npm install @openfilz-sdk/typescript@1.3.49 --save
 ```
 
 _unPublished (not recommended):_
@@ -137,6 +137,7 @@ Class | Method | HTTP request | Description
 *FolderControllerApi* | [**renameFolder**](docs/FolderControllerApi.md#renamefolder) | **PUT** /api/v1/folders/{folderId}/rename | Rename a folder
 *McpDiscoveryControllerApi* | [**authorizationServerMetadata**](docs/McpDiscoveryControllerApi.md#authorizationservermetadata) | **GET** /.well-known/oauth-authorization-server | 
 *McpDiscoveryControllerApi* | [**protectedResourceMetadata**](docs/McpDiscoveryControllerApi.md#protectedresourcemetadata) | **GET** /.well-known/oauth-protected-resource | 
+*MetadataKeyControllerApi* | [**listMetadataKeys**](docs/MetadataKeyControllerApi.md#listmetadatakeys) | **GET** /api/v1/documents/metadata-keys | List metadata keys
 *PDFToolsApi* | [**info**](docs/PDFToolsApi.md#info) | **GET** /api/v1/pdf/{documentId}/info | Describe a stored PDF
 *PDFToolsApi* | [**merge**](docs/PDFToolsApi.md#merge) | **POST** /api/v1/pdf/merge | Merge PDFs
 *PDFToolsApi* | [**organize**](docs/PDFToolsApi.md#organize) | **POST** /api/v1/pdf/organize | Reorganise the pages of a PDF
@@ -247,6 +248,7 @@ Class | Method | HTTP request | Description
  - [ListAiModelsRequest](docs/ListAiModelsRequest.md)
  - [MergeRequest](docs/MergeRequest.md)
  - [MergeSource](docs/MergeSource.md)
+ - [MetadataKeySuggestion](docs/MetadataKeySuggestion.md)
  - [MoveAudit](docs/MoveAudit.md)
  - [MoveRequest](docs/MoveRequest.md)
  - [MyStorageQuota](docs/MyStorageQuota.md)

package/api/metadata-key-controller-api.ts

@@ -0,0 +1,121 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
+// @ts-ignore
+import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
+// @ts-ignore
+import type { MetadataKeySuggestion } from '../models';
+/**
+ * MetadataKeyControllerApi - axios parameter creator
+ */
+export const MetadataKeyControllerApiAxiosParamCreator = function (configuration?: Configuration) {
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
+            const localVarPath = `/api/v1/documents/metadata-keys`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+
+            const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
+            const localVarHeaderParameter = {} as any;
+            const localVarQueryParameter = {} as any;
+
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            await setBearerAuthToObject(localVarHeaderParameter, configuration)
+
+            localVarHeaderParameter['Accept'] = '*/*';
+
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
+
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        },
+    }
+};
+
+/**
+ * MetadataKeyControllerApi - functional programming interface
+ */
+export const MetadataKeyControllerApiFp = function(configuration?: Configuration) {
+    const localVarAxiosParamCreator = MetadataKeyControllerApiAxiosParamCreator(configuration)
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        async listMetadataKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataKeySuggestion>>> {
+            const localVarAxiosArgs = await localVarAxiosParamCreator.listMetadataKeys(options);
+            const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
+            const localVarOperationServerBasePath = operationServerMap['MetadataKeyControllerApi.listMetadataKeys']?.[localVarOperationServerIndex]?.url;
+            return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+        },
+    }
+};
+
+/**
+ * MetadataKeyControllerApi - factory interface
+ */
+export const MetadataKeyControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
+    const localVarFp = MetadataKeyControllerApiFp(configuration)
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<MetadataKeySuggestion>> {
+            return localVarFp.listMetadataKeys(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+
+/**
+ * MetadataKeyControllerApi - object-oriented interface
+ */
+export class MetadataKeyControllerApi extends BaseAPI {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    public listMetadataKeys(options?: RawAxiosRequestConfig) {
+        return MetadataKeyControllerApiFp(this.configuration).listMetadataKeys(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+

package/api.ts

@@ -30,6 +30,7 @@ export * from './api/favorites-api';
 export * from './api/file-controller-api';
 export * from './api/folder-controller-api';
 export * from './api/mcp-discovery-controller-api';
+export * from './api/metadata-key-controller-api';
 export * from './api/pdftools-api';
 export * from './api/quota-administration-api';
 export * from './api/quotas-api';

package/dist/api/metadata-key-controller-api.d.ts

@@ -0,0 +1,63 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { MetadataKeySuggestion } from '../models';
+/**
+ * MetadataKeyControllerApi - axios parameter creator
+ */
+export declare const MetadataKeyControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetadataKeyControllerApi - functional programming interface
+ */
+export declare const MetadataKeyControllerApiFp: (configuration?: Configuration) => {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataKeySuggestion>>>;
+};
+/**
+ * MetadataKeyControllerApi - factory interface
+ */
+export declare const MetadataKeyControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<MetadataKeySuggestion>>;
+};
+/**
+ * MetadataKeyControllerApi - object-oriented interface
+ */
+export declare class MetadataKeyControllerApi extends BaseAPI {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataKeySuggestion[], any, {}>>;
+}

package/dist/api/metadata-key-controller-api.js

@@ -0,0 +1,125 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.MetadataKeyControllerApi = exports.MetadataKeyControllerApiFactory = exports.MetadataKeyControllerApiFp = exports.MetadataKeyControllerApiAxiosParamCreator = void 0;
+const axios_1 = require("axios");
+// Some imports not used depending on template conditions
+// @ts-ignore
+const common_1 = require("../common");
+// @ts-ignore
+const base_1 = require("../base");
+/**
+ * MetadataKeyControllerApi - axios parameter creator
+ */
+const MetadataKeyControllerApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v1/documents/metadata-keys`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: (0, common_1.toPathString)(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+exports.MetadataKeyControllerApiAxiosParamCreator = MetadataKeyControllerApiAxiosParamCreator;
+/**
+ * MetadataKeyControllerApi - functional programming interface
+ */
+const MetadataKeyControllerApiFp = function (configuration) {
+    const localVarAxiosParamCreator = (0, exports.MetadataKeyControllerApiAxiosParamCreator)(configuration);
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listMetadataKeys(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['MetadataKeyControllerApi.listMetadataKeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+exports.MetadataKeyControllerApiFp = MetadataKeyControllerApiFp;
+/**
+ * MetadataKeyControllerApi - factory interface
+ */
+const MetadataKeyControllerApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = (0, exports.MetadataKeyControllerApiFp)(configuration);
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys(options) {
+            return localVarFp.listMetadataKeys(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+exports.MetadataKeyControllerApiFactory = MetadataKeyControllerApiFactory;
+/**
+ * MetadataKeyControllerApi - object-oriented interface
+ */
+class MetadataKeyControllerApi extends base_1.BaseAPI {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options) {
+        return (0, exports.MetadataKeyControllerApiFp)(this.configuration).listMetadataKeys(options).then((request) => request(this.axios, this.basePath));
+    }
+}
+exports.MetadataKeyControllerApi = MetadataKeyControllerApi;

package/dist/api.d.ts

@@ -25,6 +25,7 @@ export * from './api/favorites-api';
 export * from './api/file-controller-api';
 export * from './api/folder-controller-api';
 export * from './api/mcp-discovery-controller-api';
+export * from './api/metadata-key-controller-api';
 export * from './api/pdftools-api';
 export * from './api/quota-administration-api';
 export * from './api/quotas-api';

package/dist/api.js

@@ -43,6 +43,7 @@ __exportStar(require("./api/favorites-api"), exports);
 __exportStar(require("./api/file-controller-api"), exports);
 __exportStar(require("./api/folder-controller-api"), exports);
 __exportStar(require("./api/mcp-discovery-controller-api"), exports);
+__exportStar(require("./api/metadata-key-controller-api"), exports);
 __exportStar(require("./api/pdftools-api"), exports);
 __exportStar(require("./api/quota-administration-api"), exports);
 __exportStar(require("./api/quotas-api"), exports);

package/dist/esm/api/metadata-key-controller-api.d.ts

@@ -0,0 +1,63 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 type { Configuration } from '../configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import { type RequestArgs, BaseAPI } from '../base';
+import type { MetadataKeySuggestion } from '../models';
+/**
+ * MetadataKeyControllerApi - axios parameter creator
+ */
+export declare const MetadataKeyControllerApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * MetadataKeyControllerApi - functional programming interface
+ */
+export declare const MetadataKeyControllerApiFp: (configuration?: Configuration) => {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataKeySuggestion>>>;
+};
+/**
+ * MetadataKeyControllerApi - factory interface
+ */
+export declare const MetadataKeyControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<MetadataKeySuggestion>>;
+};
+/**
+ * MetadataKeyControllerApi - object-oriented interface
+ */
+export declare class MetadataKeyControllerApi extends BaseAPI {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataKeySuggestion[], any, {}>>;
+}

package/dist/esm/api/metadata-key-controller-api.js

@@ -0,0 +1,118 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 globalAxios from 'axios';
+// Some imports not used depending on template conditions
+// @ts-ignore
+import { DUMMY_BASE_URL, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
+// @ts-ignore
+import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
+/**
+ * MetadataKeyControllerApi - axios parameter creator
+ */
+export const MetadataKeyControllerApiAxiosParamCreator = function (configuration) {
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
+            const localVarPath = `/api/v1/documents/metadata-keys`;
+            // use dummy base URL string because the URL constructor only accepts absolute URLs.
+            const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
+            let baseOptions;
+            if (configuration) {
+                baseOptions = configuration.baseOptions;
+            }
+            const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
+            const localVarHeaderParameter = {};
+            const localVarQueryParameter = {};
+            // authentication keycloak_auth required
+            // http bearer authentication required
+            yield setBearerAuthToObject(localVarHeaderParameter, configuration);
+            localVarHeaderParameter['Accept'] = '*/*';
+            setSearchParams(localVarUrlObj, localVarQueryParameter);
+            let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
+            localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
+            return {
+                url: toPathString(localVarUrlObj),
+                options: localVarRequestOptions,
+            };
+        }),
+    };
+};
+/**
+ * MetadataKeyControllerApi - functional programming interface
+ */
+export const MetadataKeyControllerApiFp = function (configuration) {
+    const localVarAxiosParamCreator = MetadataKeyControllerApiAxiosParamCreator(configuration);
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys(options) {
+            return __awaiter(this, void 0, void 0, function* () {
+                var _a, _b, _c;
+                const localVarAxiosArgs = yield localVarAxiosParamCreator.listMetadataKeys(options);
+                const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
+                const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetadataKeyControllerApi.listMetadataKeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
+                return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
+            });
+        },
+    };
+};
+/**
+ * MetadataKeyControllerApi - factory interface
+ */
+export const MetadataKeyControllerApiFactory = function (configuration, basePath, axios) {
+    const localVarFp = MetadataKeyControllerApiFp(configuration);
+    return {
+        /**
+         * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+         * @summary List metadata keys
+         * @param {*} [options] Override http request option.
+         * @throws {RequiredError}
+         */
+        listMetadataKeys(options) {
+            return localVarFp.listMetadataKeys(options).then((request) => request(axios, basePath));
+        },
+    };
+};
+/**
+ * MetadataKeyControllerApi - object-oriented interface
+ */
+export class MetadataKeyControllerApi extends BaseAPI {
+    /**
+     * Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+     * @summary List metadata keys
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    listMetadataKeys(options) {
+        return MetadataKeyControllerApiFp(this.configuration).listMetadataKeys(options).then((request) => request(this.axios, this.basePath));
+    }
+}

package/dist/esm/api.d.ts

@@ -25,6 +25,7 @@ export * from './api/favorites-api';
 export * from './api/file-controller-api';
 export * from './api/folder-controller-api';
 export * from './api/mcp-discovery-controller-api';
+export * from './api/metadata-key-controller-api';
 export * from './api/pdftools-api';
 export * from './api/quota-administration-api';
 export * from './api/quotas-api';

package/dist/esm/api.js

@@ -27,6 +27,7 @@ export * from './api/favorites-api';
 export * from './api/file-controller-api';
 export * from './api/folder-controller-api';
 export * from './api/mcp-discovery-controller-api';
+export * from './api/metadata-key-controller-api';
 export * from './api/pdftools-api';
 export * from './api/quota-administration-api';
 export * from './api/quotas-api';

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

@@ -59,6 +59,7 @@ export * from './item-result';
 export * from './list-ai-models-request';
 export * from './merge-request';
 export * from './merge-source';
+export * from './metadata-key-suggestion';
 export * from './move-audit';
 export * from './move-request';
 export * from './my-storage-quota';

package/dist/esm/models/index.js

@@ -59,6 +59,7 @@ export * from './item-result';
 export * from './list-ai-models-request';
 export * from './merge-request';
 export * from './merge-source';
+export * from './metadata-key-suggestion';
 export * from './move-audit';
 export * from './move-request';
 export * from './my-storage-quota';

package/dist/esm/models/metadata-key-suggestion.d.ts

@@ -0,0 +1,24 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 metadata key found on the documents visible to the caller
+ */
+export interface MetadataKeySuggestion {
+    /**
+     * The metadata key
+     */
+    'key'?: string;
+    /**
+     * Number of visible documents carrying the key
+     */
+    'count'?: number;
+}

package/dist/esm/models/metadata-key-suggestion.js

@@ -0,0 +1,14 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 {};

package/dist/esm/models/search-by-metadata-request.d.ts

@@ -30,7 +30,7 @@ export interface SearchByMetadataRequest {
      */
     'rootOnly'?: boolean;
     /**
-     * Metadata key-value pairs to search for
+     * Metadata key-value pairs to search for. A string value containing % or * is a case-insensitive pattern: % or * = any characters, ? = exactly one character, _ and \\ are literal, a bare % = the key is set whatever its value (e.g. {\"project\": \"beta%\"}). Any other value is matched exactly (case-sensitive). At most 10 criteria, keys up to 100 characters, patterns up to 200.
      */
     'metadataCriteria'?: {
         [key: string]: any;

package/dist/models/index.d.ts

@@ -59,6 +59,7 @@ export * from './item-result';
 export * from './list-ai-models-request';
 export * from './merge-request';
 export * from './merge-source';
+export * from './metadata-key-suggestion';
 export * from './move-audit';
 export * from './move-request';
 export * from './my-storage-quota';

package/dist/models/index.js

@@ -75,6 +75,7 @@ __exportStar(require("./item-result"), exports);
 __exportStar(require("./list-ai-models-request"), exports);
 __exportStar(require("./merge-request"), exports);
 __exportStar(require("./merge-source"), exports);
+__exportStar(require("./metadata-key-suggestion"), exports);
 __exportStar(require("./move-audit"), exports);
 __exportStar(require("./move-request"), exports);
 __exportStar(require("./my-storage-quota"), exports);

package/dist/models/metadata-key-suggestion.d.ts

@@ -0,0 +1,24 @@
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 metadata key found on the documents visible to the caller
+ */
+export interface MetadataKeySuggestion {
+    /**
+     * The metadata key
+     */
+    'key'?: string;
+    /**
+     * Number of visible documents carrying the key
+     */
+    'count'?: number;
+}

package/dist/models/metadata-key-suggestion.js

@@ -0,0 +1,15 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 });

package/dist/models/search-by-metadata-request.d.ts

@@ -30,7 +30,7 @@ export interface SearchByMetadataRequest {
      */
     'rootOnly'?: boolean;
     /**
-     * Metadata key-value pairs to search for
+     * Metadata key-value pairs to search for. A string value containing % or * is a case-insensitive pattern: % or * = any characters, ? = exactly one character, _ and \\ are literal, a bare % = the key is set whatever its value (e.g. {\"project\": \"beta%\"}). Any other value is matched exactly (case-sensitive). At most 10 criteria, keys up to 100 characters, patterns up to 200.
      */
     'metadataCriteria'?: {
         [key: string]: any;

package/docs/MetadataKeyControllerApi.md

@@ -0,0 +1,52 @@
+# MetadataKeyControllerApi
+
+All URIs are relative to *http://localhost:8081*
+
+|Method | HTTP request | Description|
+|------------- | ------------- | -------------|
+|[**listMetadataKeys**](#listmetadatakeys) | **GET** /api/v1/documents/metadata-keys | List metadata keys|
+
+# **listMetadataKeys**
+> Array<MetadataKeySuggestion> listMetadataKeys()
+
+Metadata keys found on the documents the caller can see, most frequent first, with the number of documents carrying each (at most 200). Meant for autocompletion of the metadata search filter: the list is cached for a short time and is empty when it cannot be computed in time. 404 when key suggestions are disabled.
+
+### Example
+
+```typescript
+import {
+    MetadataKeyControllerApi,
+    Configuration
+} from '@openfilz-sdk/typescript';
+
+const configuration = new Configuration();
+const apiInstance = new MetadataKeyControllerApi(configuration);
+
+const { status, data } = await apiInstance.listMetadataKeys();
+```
+
+### Parameters
+This endpoint does not have any parameters.
+
+
+### Return type
+
+**Array<MetadataKeySuggestion>**
+
+### Authorization
+
+[keycloak_auth](../README.md#keycloak_auth)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: */*
+
+
+### HTTP response details
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+|**200** | OK |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

package/docs/MetadataKeySuggestion.md

@@ -0,0 +1,23 @@
+# MetadataKeySuggestion
+
+A metadata key found on the documents visible to the caller
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**key** | **string** | The metadata key | [optional] [default to undefined]
+**count** | **number** | Number of visible documents carrying the key | [optional] [default to undefined]
+
+## Example
+
+```typescript
+import { MetadataKeySuggestion } from '@openfilz-sdk/typescript';
+
+const instance: MetadataKeySuggestion = {
+    key,
+    count,
+};
+```
+
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

package/docs/SearchByMetadataRequest.md

@@ -10,7 +10,7 @@ Name | Type | Description | Notes
 **type** | **string** | Optional : Type of the document to search - if not provided or null : search all types | [optional] [default to undefined]
 **parentFolderId** | **string** | Optional : UUID of the parent folder to search - if not provided or null : search in all folders | [optional] [default to undefined]
 **rootOnly** | **boolean** | Optional : if true : search only at the root level - if not provided or null : search in all folders | [optional] [default to undefined]
-**metadataCriteria** | **{ [key: string]: any; }** | Metadata key-value pairs to search for | [optional] [default to undefined]
+**metadataCriteria** | **{ [key: string]: any; }** | Metadata key-value pairs to search for. A string value containing % or * is a case-insensitive pattern: % or * = any characters, ? = exactly one character, _ and \\ are literal, a bare % = the key is set whatever its value (e.g. {\"project\": \"beta%\"}). Any other value is matched exactly (case-sensitive). At most 10 criteria, keys up to 100 characters, patterns up to 200. | [optional] [default to undefined]
 
 ## Example
 

package/graphql/document.graphqls

@@ -69,7 +69,7 @@ input ListFolderRequest {
     name : String
     "name of the elements to filter (like clause)"
     nameLike : String
-    "metadata of the elements to filter (contains clause)"
+    "metadata of the elements to filter: exact values (contains clause), or case-insensitive patterns for string values containing % or * (any characters), ? = one character, _ and backslash are literal; a bare % means the key exists. At most 10 criteria."
     metadata : JSON
     size : Long
     createdAtAfter : DateTime
@@ -100,7 +100,7 @@ input FavoriteRequest {
     name : String
     "name of the elements to filter (like clause)"
     nameLike : String
-    "metadata of the elements to filter (contains clause)"
+    "metadata of the elements to filter: exact values (contains clause), or case-insensitive patterns for string values containing % or * (any characters), ? = one character, _ and backslash are literal; a bare % means the key exists. At most 10 criteria."
     metadata : JSON
     size : Long
     createdAtAfter : DateTime

package/models/index.ts

@@ -59,6 +59,7 @@ export * from './item-result';
 export * from './list-ai-models-request';
 export * from './merge-request';
 export * from './merge-source';
+export * from './metadata-key-suggestion';
 export * from './move-audit';
 export * from './move-request';
 export * from './my-storage-quota';

package/models/metadata-key-suggestion.ts

@@ -0,0 +1,30 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * openfilz-api
+ * API for Document Management System
+ *
+ * The version of the OpenAPI document: 1.0.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 metadata key found on the documents visible to the caller
+ */
+export interface MetadataKeySuggestion {
+    /**
+     * The metadata key
+     */
+    'key'?: string;
+    /**
+     * Number of visible documents carrying the key
+     */
+    'count'?: number;
+}
+

package/models/search-by-metadata-request.ts

@@ -35,7 +35,7 @@ export interface SearchByMetadataRequest {
      */
     'rootOnly'?: boolean;
     /**
-     * Metadata key-value pairs to search for
+     * Metadata key-value pairs to search for. A string value containing % or * is a case-insensitive pattern: % or * = any characters, ? = exactly one character, _ and \\ are literal, a bare % = the key is set whatever its value (e.g. {\"project\": \"beta%\"}). Any other value is matched exactly (case-sensitive). At most 10 criteria, keys up to 100 characters, patterns up to 200.
      */
     'metadataCriteria'?: { [key: string]: any; };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@openfilz-sdk/typescript",
-  "version": "1.3.48",
+  "version": "1.3.49",
   "description": "OpenAPI client for @openfilz-sdk/typescript",
   "author": "OpenAPI-Generator Contributors",
   "repository": {