@openfilz-sdk/typescript-ee 1.14.0 → 1.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -38,6 +38,7 @@ api/file-controller-api.ts
38
38
  api/folder-controller-api.ts
39
39
  api/mcp-discovery-controller-api.ts
40
40
  api/mcp-token-admin-controller-api.ts
41
+ api/metadata-key-controller-api.ts
41
42
  api/notifications-api.ts
42
43
  api/organisation-settings-api.ts
43
44
  api/ownership-api.ts
@@ -205,6 +206,8 @@ docs/McpDiscoveryControllerApi.md
205
206
  docs/McpTokenAdminControllerApi.md
206
207
  docs/MergeRequest.md
207
208
  docs/MergeSource.md
209
+ docs/MetadataKeyControllerApi.md
210
+ docs/MetadataKeySuggestion.md
208
211
  docs/MintMcpAgentTokenRequest.md
209
212
  docs/MintUploadTokenRequest.md
210
213
  docs/MoveAudit.md
@@ -475,6 +478,7 @@ models/mcp-agent-token-info.ts
475
478
  models/mcp-agent-token-response.ts
476
479
  models/merge-request.ts
477
480
  models/merge-source.ts
481
+ models/metadata-key-suggestion.ts
478
482
  models/mint-mcp-agent-token-request.ts
479
483
  models/mint-upload-token-request.ts
480
484
  models/move-audit.ts
@@ -1 +1 @@
1
- 46495373e5b245c5541c5625f05d6feaae371f7666ff101c5fbbae94badbae7a
1
+ 38a40ba7ea84ede8d33b014326316f70093a04a6fb8ab020eb4f47f10c81b060
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.14.0
1
+ ## @openfilz-sdk/typescript-ee@1.14.1
2
2
 
3
3
  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:
4
4
 
@@ -36,7 +36,7 @@ navigate to the folder of your consuming project and run one of the following co
36
36
  _published:_
37
37
 
38
38
  ```
39
- npm install @openfilz-sdk/typescript-ee@1.14.0 --save
39
+ npm install @openfilz-sdk/typescript-ee@1.14.1 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -221,6 +221,7 @@ Class | Method | HTTP request | Description
221
221
  *McpTokenAdminControllerApi* | [**list2**](docs/McpTokenAdminControllerApi.md#list2) | **GET** /api/v1/admin/mcp/tokens | List minted MCP agent tokens (never returns the credentials)
222
222
  *McpTokenAdminControllerApi* | [**mint**](docs/McpTokenAdminControllerApi.md#mint) | **POST** /api/v1/admin/mcp/tokens | Mint an MCP agent token for a dedicated user (admin only)
223
223
  *McpTokenAdminControllerApi* | [**revoke1**](docs/McpTokenAdminControllerApi.md#revoke1) | **DELETE** /api/v1/admin/mcp/tokens/{jti} | Revoke an MCP agent token
224
+ *MetadataKeyControllerApi* | [**listMetadataKeys**](docs/MetadataKeyControllerApi.md#listmetadatakeys) | **GET** /api/v1/documents/metadata-keys | List metadata keys
224
225
  *NotificationsApi* | [**getNotifications**](docs/NotificationsApi.md#getnotifications) | **GET** /api/v1/notifications | Get all notifications
225
226
  *NotificationsApi* | [**getUnreadCount**](docs/NotificationsApi.md#getunreadcount) | **GET** /api/v1/notifications/unread/count | Get unread notification count
226
227
  *NotificationsApi* | [**markAllAsRead**](docs/NotificationsApi.md#markallasread) | **PUT** /api/v1/notifications/read-all | Mark all notifications as read
@@ -457,6 +458,7 @@ Class | Method | HTTP request | Description
457
458
  - [McpAgentTokenResponse](docs/McpAgentTokenResponse.md)
458
459
  - [MergeRequest](docs/MergeRequest.md)
459
460
  - [MergeSource](docs/MergeSource.md)
461
+ - [MetadataKeySuggestion](docs/MetadataKeySuggestion.md)
460
462
  - [MintMcpAgentTokenRequest](docs/MintMcpAgentTokenRequest.md)
461
463
  - [MintUploadTokenRequest](docs/MintUploadTokenRequest.md)
462
464
  - [MoveAudit](docs/MoveAudit.md)
@@ -0,0 +1,121 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import type { Configuration } from '../configuration';
17
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
18
+ import globalAxios from 'axios';
19
+ // Some imports not used depending on template conditions
20
+ // @ts-ignore
21
+ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
22
+ // @ts-ignore
23
+ import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
24
+ // @ts-ignore
25
+ import type { MetadataKeySuggestion } from '../models';
26
+ /**
27
+ * MetadataKeyControllerApi - axios parameter creator
28
+ */
29
+ export const MetadataKeyControllerApiAxiosParamCreator = function (configuration?: Configuration) {
30
+ return {
31
+ /**
32
+ * 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.
33
+ * @summary List metadata keys
34
+ * @param {*} [options] Override http request option.
35
+ * @throws {RequiredError}
36
+ */
37
+ listMetadataKeys: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
38
+ const localVarPath = `/api/v1/documents/metadata-keys`;
39
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
40
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
41
+ let baseOptions;
42
+ if (configuration) {
43
+ baseOptions = configuration.baseOptions;
44
+ }
45
+
46
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
47
+ const localVarHeaderParameter = {} as any;
48
+ const localVarQueryParameter = {} as any;
49
+
50
+ // authentication keycloak_auth required
51
+ // http bearer authentication required
52
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
53
+
54
+ localVarHeaderParameter['Accept'] = '*/*';
55
+
56
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
57
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
58
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
59
+
60
+ return {
61
+ url: toPathString(localVarUrlObj),
62
+ options: localVarRequestOptions,
63
+ };
64
+ },
65
+ }
66
+ };
67
+
68
+ /**
69
+ * MetadataKeyControllerApi - functional programming interface
70
+ */
71
+ export const MetadataKeyControllerApiFp = function(configuration?: Configuration) {
72
+ const localVarAxiosParamCreator = MetadataKeyControllerApiAxiosParamCreator(configuration)
73
+ return {
74
+ /**
75
+ * 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.
76
+ * @summary List metadata keys
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ async listMetadataKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataKeySuggestion>>> {
81
+ const localVarAxiosArgs = await localVarAxiosParamCreator.listMetadataKeys(options);
82
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
83
+ const localVarOperationServerBasePath = operationServerMap['MetadataKeyControllerApi.listMetadataKeys']?.[localVarOperationServerIndex]?.url;
84
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85
+ },
86
+ }
87
+ };
88
+
89
+ /**
90
+ * MetadataKeyControllerApi - factory interface
91
+ */
92
+ export const MetadataKeyControllerApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
93
+ const localVarFp = MetadataKeyControllerApiFp(configuration)
94
+ return {
95
+ /**
96
+ * 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.
97
+ * @summary List metadata keys
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ listMetadataKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<MetadataKeySuggestion>> {
102
+ return localVarFp.listMetadataKeys(options).then((request) => request(axios, basePath));
103
+ },
104
+ };
105
+ };
106
+
107
+ /**
108
+ * MetadataKeyControllerApi - object-oriented interface
109
+ */
110
+ export class MetadataKeyControllerApi extends BaseAPI {
111
+ /**
112
+ * 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.
113
+ * @summary List metadata keys
114
+ * @param {*} [options] Override http request option.
115
+ * @throws {RequiredError}
116
+ */
117
+ public listMetadataKeys(options?: RawAxiosRequestConfig) {
118
+ return MetadataKeyControllerApiFp(this.configuration).listMetadataKeys(options).then((request) => request(this.axios, this.basePath));
119
+ }
120
+ }
121
+
package/api.ts CHANGED
@@ -49,6 +49,7 @@ export * from './api/file-controller-api';
49
49
  export * from './api/folder-controller-api';
50
50
  export * from './api/mcp-discovery-controller-api';
51
51
  export * from './api/mcp-token-admin-controller-api';
52
+ export * from './api/metadata-key-controller-api';
52
53
  export * from './api/notifications-api';
53
54
  export * from './api/organisation-settings-api';
54
55
  export * from './api/ownership-api';
@@ -0,0 +1,63 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { MetadataKeySuggestion } from '../models';
16
+ /**
17
+ * MetadataKeyControllerApi - axios parameter creator
18
+ */
19
+ export declare const MetadataKeyControllerApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ * 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.
22
+ * @summary List metadata keys
23
+ * @param {*} [options] Override http request option.
24
+ * @throws {RequiredError}
25
+ */
26
+ listMetadataKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27
+ };
28
+ /**
29
+ * MetadataKeyControllerApi - functional programming interface
30
+ */
31
+ export declare const MetadataKeyControllerApiFp: (configuration?: Configuration) => {
32
+ /**
33
+ * 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.
34
+ * @summary List metadata keys
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ listMetadataKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataKeySuggestion>>>;
39
+ };
40
+ /**
41
+ * MetadataKeyControllerApi - factory interface
42
+ */
43
+ export declare const MetadataKeyControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
44
+ /**
45
+ * 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.
46
+ * @summary List metadata keys
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ listMetadataKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<MetadataKeySuggestion>>;
51
+ };
52
+ /**
53
+ * MetadataKeyControllerApi - object-oriented interface
54
+ */
55
+ export declare class MetadataKeyControllerApi extends BaseAPI {
56
+ /**
57
+ * 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.
58
+ * @summary List metadata keys
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ listMetadataKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataKeySuggestion[], any, {}, any>>;
63
+ }
@@ -0,0 +1,125 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
16
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
17
+ return new (P || (P = Promise))(function (resolve, reject) {
18
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
19
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
20
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
21
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
22
+ });
23
+ };
24
+ Object.defineProperty(exports, "__esModule", { value: true });
25
+ exports.MetadataKeyControllerApi = exports.MetadataKeyControllerApiFactory = exports.MetadataKeyControllerApiFp = exports.MetadataKeyControllerApiAxiosParamCreator = void 0;
26
+ const axios_1 = require("axios");
27
+ // Some imports not used depending on template conditions
28
+ // @ts-ignore
29
+ const common_1 = require("../common");
30
+ // @ts-ignore
31
+ const base_1 = require("../base");
32
+ /**
33
+ * MetadataKeyControllerApi - axios parameter creator
34
+ */
35
+ const MetadataKeyControllerApiAxiosParamCreator = function (configuration) {
36
+ return {
37
+ /**
38
+ * 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.
39
+ * @summary List metadata keys
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ listMetadataKeys: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
44
+ const localVarPath = `/api/v1/documents/metadata-keys`;
45
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
46
+ const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
47
+ let baseOptions;
48
+ if (configuration) {
49
+ baseOptions = configuration.baseOptions;
50
+ }
51
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
52
+ const localVarHeaderParameter = {};
53
+ const localVarQueryParameter = {};
54
+ // authentication keycloak_auth required
55
+ // http bearer authentication required
56
+ yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
57
+ localVarHeaderParameter['Accept'] = '*/*';
58
+ (0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
59
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
60
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
61
+ return {
62
+ url: (0, common_1.toPathString)(localVarUrlObj),
63
+ options: localVarRequestOptions,
64
+ };
65
+ }),
66
+ };
67
+ };
68
+ exports.MetadataKeyControllerApiAxiosParamCreator = MetadataKeyControllerApiAxiosParamCreator;
69
+ /**
70
+ * MetadataKeyControllerApi - functional programming interface
71
+ */
72
+ const MetadataKeyControllerApiFp = function (configuration) {
73
+ const localVarAxiosParamCreator = (0, exports.MetadataKeyControllerApiAxiosParamCreator)(configuration);
74
+ return {
75
+ /**
76
+ * 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.
77
+ * @summary List metadata keys
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ listMetadataKeys(options) {
82
+ return __awaiter(this, void 0, void 0, function* () {
83
+ var _a, _b, _c;
84
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listMetadataKeys(options);
85
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
86
+ 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;
87
+ return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
88
+ });
89
+ },
90
+ };
91
+ };
92
+ exports.MetadataKeyControllerApiFp = MetadataKeyControllerApiFp;
93
+ /**
94
+ * MetadataKeyControllerApi - factory interface
95
+ */
96
+ const MetadataKeyControllerApiFactory = function (configuration, basePath, axios) {
97
+ const localVarFp = (0, exports.MetadataKeyControllerApiFp)(configuration);
98
+ return {
99
+ /**
100
+ * 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.
101
+ * @summary List metadata keys
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ listMetadataKeys(options) {
106
+ return localVarFp.listMetadataKeys(options).then((request) => request(axios, basePath));
107
+ },
108
+ };
109
+ };
110
+ exports.MetadataKeyControllerApiFactory = MetadataKeyControllerApiFactory;
111
+ /**
112
+ * MetadataKeyControllerApi - object-oriented interface
113
+ */
114
+ class MetadataKeyControllerApi extends base_1.BaseAPI {
115
+ /**
116
+ * 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.
117
+ * @summary List metadata keys
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ listMetadataKeys(options) {
122
+ return (0, exports.MetadataKeyControllerApiFp)(this.configuration).listMetadataKeys(options).then((request) => request(this.axios, this.basePath));
123
+ }
124
+ }
125
+ exports.MetadataKeyControllerApi = MetadataKeyControllerApi;
package/dist/api.d.ts CHANGED
@@ -44,6 +44,7 @@ export * from './api/file-controller-api';
44
44
  export * from './api/folder-controller-api';
45
45
  export * from './api/mcp-discovery-controller-api';
46
46
  export * from './api/mcp-token-admin-controller-api';
47
+ export * from './api/metadata-key-controller-api';
47
48
  export * from './api/notifications-api';
48
49
  export * from './api/organisation-settings-api';
49
50
  export * from './api/ownership-api';
package/dist/api.js CHANGED
@@ -62,6 +62,7 @@ __exportStar(require("./api/file-controller-api"), exports);
62
62
  __exportStar(require("./api/folder-controller-api"), exports);
63
63
  __exportStar(require("./api/mcp-discovery-controller-api"), exports);
64
64
  __exportStar(require("./api/mcp-token-admin-controller-api"), exports);
65
+ __exportStar(require("./api/metadata-key-controller-api"), exports);
65
66
  __exportStar(require("./api/notifications-api"), exports);
66
67
  __exportStar(require("./api/organisation-settings-api"), exports);
67
68
  __exportStar(require("./api/ownership-api"), exports);
@@ -0,0 +1,63 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ import type { Configuration } from '../configuration';
13
+ import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
14
+ import { type RequestArgs, BaseAPI } from '../base';
15
+ import type { MetadataKeySuggestion } from '../models';
16
+ /**
17
+ * MetadataKeyControllerApi - axios parameter creator
18
+ */
19
+ export declare const MetadataKeyControllerApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ * 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.
22
+ * @summary List metadata keys
23
+ * @param {*} [options] Override http request option.
24
+ * @throws {RequiredError}
25
+ */
26
+ listMetadataKeys: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27
+ };
28
+ /**
29
+ * MetadataKeyControllerApi - functional programming interface
30
+ */
31
+ export declare const MetadataKeyControllerApiFp: (configuration?: Configuration) => {
32
+ /**
33
+ * 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.
34
+ * @summary List metadata keys
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ listMetadataKeys(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<MetadataKeySuggestion>>>;
39
+ };
40
+ /**
41
+ * MetadataKeyControllerApi - factory interface
42
+ */
43
+ export declare const MetadataKeyControllerApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
44
+ /**
45
+ * 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.
46
+ * @summary List metadata keys
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ listMetadataKeys(options?: RawAxiosRequestConfig): AxiosPromise<Array<MetadataKeySuggestion>>;
51
+ };
52
+ /**
53
+ * MetadataKeyControllerApi - object-oriented interface
54
+ */
55
+ export declare class MetadataKeyControllerApi extends BaseAPI {
56
+ /**
57
+ * 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.
58
+ * @summary List metadata keys
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ listMetadataKeys(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<MetadataKeySuggestion[], any, {}, any>>;
63
+ }
@@ -0,0 +1,118 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
15
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
16
+ return new (P || (P = Promise))(function (resolve, reject) {
17
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
18
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
19
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
20
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
21
+ });
22
+ };
23
+ import globalAxios from 'axios';
24
+ // Some imports not used depending on template conditions
25
+ // @ts-ignore
26
+ import { DUMMY_BASE_URL, setBearerAuthToObject, setSearchParams, toPathString, createRequestFunction } from '../common';
27
+ // @ts-ignore
28
+ import { BASE_PATH, BaseAPI, operationServerMap } from '../base';
29
+ /**
30
+ * MetadataKeyControllerApi - axios parameter creator
31
+ */
32
+ export const MetadataKeyControllerApiAxiosParamCreator = function (configuration) {
33
+ return {
34
+ /**
35
+ * 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.
36
+ * @summary List metadata keys
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ listMetadataKeys: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
41
+ const localVarPath = `/api/v1/documents/metadata-keys`;
42
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
43
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
44
+ let baseOptions;
45
+ if (configuration) {
46
+ baseOptions = configuration.baseOptions;
47
+ }
48
+ const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
49
+ const localVarHeaderParameter = {};
50
+ const localVarQueryParameter = {};
51
+ // authentication keycloak_auth required
52
+ // http bearer authentication required
53
+ yield setBearerAuthToObject(localVarHeaderParameter, configuration);
54
+ localVarHeaderParameter['Accept'] = '*/*';
55
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
56
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
57
+ localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
58
+ return {
59
+ url: toPathString(localVarUrlObj),
60
+ options: localVarRequestOptions,
61
+ };
62
+ }),
63
+ };
64
+ };
65
+ /**
66
+ * MetadataKeyControllerApi - functional programming interface
67
+ */
68
+ export const MetadataKeyControllerApiFp = function (configuration) {
69
+ const localVarAxiosParamCreator = MetadataKeyControllerApiAxiosParamCreator(configuration);
70
+ return {
71
+ /**
72
+ * 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.
73
+ * @summary List metadata keys
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ listMetadataKeys(options) {
78
+ return __awaiter(this, void 0, void 0, function* () {
79
+ var _a, _b, _c;
80
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.listMetadataKeys(options);
81
+ const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
82
+ const localVarOperationServerBasePath = (_c = (_b = operationServerMap['MetadataKeyControllerApi.listMetadataKeys']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
83
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
84
+ });
85
+ },
86
+ };
87
+ };
88
+ /**
89
+ * MetadataKeyControllerApi - factory interface
90
+ */
91
+ export const MetadataKeyControllerApiFactory = function (configuration, basePath, axios) {
92
+ const localVarFp = MetadataKeyControllerApiFp(configuration);
93
+ return {
94
+ /**
95
+ * 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.
96
+ * @summary List metadata keys
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ listMetadataKeys(options) {
101
+ return localVarFp.listMetadataKeys(options).then((request) => request(axios, basePath));
102
+ },
103
+ };
104
+ };
105
+ /**
106
+ * MetadataKeyControllerApi - object-oriented interface
107
+ */
108
+ export class MetadataKeyControllerApi extends BaseAPI {
109
+ /**
110
+ * 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.
111
+ * @summary List metadata keys
112
+ * @param {*} [options] Override http request option.
113
+ * @throws {RequiredError}
114
+ */
115
+ listMetadataKeys(options) {
116
+ return MetadataKeyControllerApiFp(this.configuration).listMetadataKeys(options).then((request) => request(this.axios, this.basePath));
117
+ }
118
+ }
package/dist/esm/api.d.ts CHANGED
@@ -44,6 +44,7 @@ export * from './api/file-controller-api';
44
44
  export * from './api/folder-controller-api';
45
45
  export * from './api/mcp-discovery-controller-api';
46
46
  export * from './api/mcp-token-admin-controller-api';
47
+ export * from './api/metadata-key-controller-api';
47
48
  export * from './api/notifications-api';
48
49
  export * from './api/organisation-settings-api';
49
50
  export * from './api/ownership-api';
package/dist/esm/api.js CHANGED
@@ -46,6 +46,7 @@ export * from './api/file-controller-api';
46
46
  export * from './api/folder-controller-api';
47
47
  export * from './api/mcp-discovery-controller-api';
48
48
  export * from './api/mcp-token-admin-controller-api';
49
+ export * from './api/metadata-key-controller-api';
49
50
  export * from './api/notifications-api';
50
51
  export * from './api/organisation-settings-api';
51
52
  export * from './api/ownership-api';
@@ -107,6 +107,7 @@ export * from './mcp-agent-token-info';
107
107
  export * from './mcp-agent-token-response';
108
108
  export * from './merge-request';
109
109
  export * from './merge-source';
110
+ export * from './metadata-key-suggestion';
110
111
  export * from './mint-mcp-agent-token-request';
111
112
  export * from './mint-upload-token-request';
112
113
  export * from './move-audit';
@@ -107,6 +107,7 @@ export * from './mcp-agent-token-info';
107
107
  export * from './mcp-agent-token-response';
108
108
  export * from './merge-request';
109
109
  export * from './merge-source';
110
+ export * from './metadata-key-suggestion';
110
111
  export * from './mint-mcp-agent-token-request';
111
112
  export * from './mint-upload-token-request';
112
113
  export * from './move-audit';
@@ -0,0 +1,24 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A metadata key found on the documents visible to the caller
14
+ */
15
+ export interface MetadataKeySuggestion {
16
+ /**
17
+ * The metadata key
18
+ */
19
+ 'key'?: string;
20
+ /**
21
+ * Number of visible documents carrying the key
22
+ */
23
+ 'count'?: number;
24
+ }
@@ -0,0 +1,14 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+ export {};
@@ -30,7 +30,7 @@ export interface SearchByMetadataRequest {
30
30
  */
31
31
  'rootOnly'?: boolean;
32
32
  /**
33
- * Metadata key-value pairs to search for
33
+ * 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.
34
34
  */
35
35
  'metadataCriteria'?: {
36
36
  [key: string]: any;
@@ -107,6 +107,7 @@ export * from './mcp-agent-token-info';
107
107
  export * from './mcp-agent-token-response';
108
108
  export * from './merge-request';
109
109
  export * from './merge-source';
110
+ export * from './metadata-key-suggestion';
110
111
  export * from './mint-mcp-agent-token-request';
111
112
  export * from './mint-upload-token-request';
112
113
  export * from './move-audit';
@@ -123,6 +123,7 @@ __exportStar(require("./mcp-agent-token-info"), exports);
123
123
  __exportStar(require("./mcp-agent-token-response"), exports);
124
124
  __exportStar(require("./merge-request"), exports);
125
125
  __exportStar(require("./merge-source"), exports);
126
+ __exportStar(require("./metadata-key-suggestion"), exports);
126
127
  __exportStar(require("./mint-mcp-agent-token-request"), exports);
127
128
  __exportStar(require("./mint-upload-token-request"), exports);
128
129
  __exportStar(require("./move-audit"), exports);
@@ -0,0 +1,24 @@
1
+ /**
2
+ * openfilz-api
3
+ * API for Document Management System
4
+ *
5
+ * The version of the OpenAPI document: 1.0.0
6
+ *
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ * A metadata key found on the documents visible to the caller
14
+ */
15
+ export interface MetadataKeySuggestion {
16
+ /**
17
+ * The metadata key
18
+ */
19
+ 'key'?: string;
20
+ /**
21
+ * Number of visible documents carrying the key
22
+ */
23
+ 'count'?: number;
24
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * openfilz-api
6
+ * API for Document Management System
7
+ *
8
+ * The version of the OpenAPI document: 1.0.0
9
+ *
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -30,7 +30,7 @@ export interface SearchByMetadataRequest {
30
30
  */
31
31
  'rootOnly'?: boolean;
32
32
  /**
33
- * Metadata key-value pairs to search for
33
+ * 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.
34
34
  */
35
35
  'metadataCriteria'?: {
36
36
  [key: string]: any;
@@ -0,0 +1,52 @@
1
+ # MetadataKeyControllerApi
2
+
3
+ All URIs are relative to *http://localhost:8081*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**listMetadataKeys**](#listmetadatakeys) | **GET** /api/v1/documents/metadata-keys | List metadata keys|
8
+
9
+ # **listMetadataKeys**
10
+ > Array<MetadataKeySuggestion> listMetadataKeys()
11
+
12
+ 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.
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ MetadataKeyControllerApi,
19
+ Configuration
20
+ } from '@openfilz-sdk/typescript-ee';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new MetadataKeyControllerApi(configuration);
24
+
25
+ const { status, data } = await apiInstance.listMetadataKeys();
26
+ ```
27
+
28
+ ### Parameters
29
+ This endpoint does not have any parameters.
30
+
31
+
32
+ ### Return type
33
+
34
+ **Array<MetadataKeySuggestion>**
35
+
36
+ ### Authorization
37
+
38
+ [keycloak_auth](../README.md#keycloak_auth)
39
+
40
+ ### HTTP request headers
41
+
42
+ - **Content-Type**: Not defined
43
+ - **Accept**: */*
44
+
45
+
46
+ ### HTTP response details
47
+ | Status code | Description | Response headers |
48
+ |-------------|-------------|------------------|
49
+ |**200** | OK | - |
50
+
51
+ [[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)
52
+
@@ -0,0 +1,23 @@
1
+ # MetadataKeySuggestion
2
+
3
+ A metadata key found on the documents visible to the caller
4
+
5
+ ## Properties
6
+
7
+ Name | Type | Description | Notes
8
+ ------------ | ------------- | ------------- | -------------
9
+ **key** | **string** | The metadata key | [optional] [default to undefined]
10
+ **count** | **number** | Number of visible documents carrying the key | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { MetadataKeySuggestion } from '@openfilz-sdk/typescript-ee';
16
+
17
+ const instance: MetadataKeySuggestion = {
18
+ key,
19
+ count,
20
+ };
21
+ ```
22
+
23
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -10,7 +10,7 @@ Name | Type | Description | Notes
10
10
  **type** | **string** | Optional : Type of the document to search - if not provided or null : search all types | [optional] [default to undefined]
11
11
  **parentFolderId** | **string** | Optional : UUID of the parent folder to search - if not provided or null : search in all folders | [optional] [default to undefined]
12
12
  **rootOnly** | **boolean** | Optional : if true : search only at the root level - if not provided or null : search in all folders | [optional] [default to undefined]
13
- **metadataCriteria** | **{ [key: string]: any; }** | Metadata key-value pairs to search for | [optional] [default to undefined]
13
+ **metadataCriteria** | **{ [key: string]: any; }** | Metadata key-value pairs to search for. A string value containing % or * is a case-insensitive pattern: % or * &#x3D; any characters, ? &#x3D; exactly one character, _ and \\ are literal, a bare % &#x3D; the key is set whatever its value (e.g. {\&quot;project\&quot;: \&quot;beta%\&quot;}). 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]
14
14
 
15
15
  ## Example
16
16
 
@@ -69,7 +69,7 @@ input ListFolderRequest {
69
69
  name : String
70
70
  "name of the elements to filter (like clause)"
71
71
  nameLike : String
72
- "metadata of the elements to filter (contains clause)"
72
+ "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."
73
73
  metadata : JSON
74
74
  size : Long
75
75
  createdAtAfter : DateTime
@@ -100,7 +100,7 @@ input FavoriteRequest {
100
100
  name : String
101
101
  "name of the elements to filter (like clause)"
102
102
  nameLike : String
103
- "metadata of the elements to filter (contains clause)"
103
+ "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."
104
104
  metadata : JSON
105
105
  size : Long
106
106
  createdAtAfter : DateTime
package/models/index.ts CHANGED
@@ -107,6 +107,7 @@ export * from './mcp-agent-token-info';
107
107
  export * from './mcp-agent-token-response';
108
108
  export * from './merge-request';
109
109
  export * from './merge-source';
110
+ export * from './metadata-key-suggestion';
110
111
  export * from './mint-mcp-agent-token-request';
111
112
  export * from './mint-upload-token-request';
112
113
  export * from './move-audit';
@@ -0,0 +1,30 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * openfilz-api
5
+ * API for Document Management System
6
+ *
7
+ * The version of the OpenAPI document: 1.0.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ * A metadata key found on the documents visible to the caller
19
+ */
20
+ export interface MetadataKeySuggestion {
21
+ /**
22
+ * The metadata key
23
+ */
24
+ 'key'?: string;
25
+ /**
26
+ * Number of visible documents carrying the key
27
+ */
28
+ 'count'?: number;
29
+ }
30
+
@@ -35,7 +35,7 @@ export interface SearchByMetadataRequest {
35
35
  */
36
36
  'rootOnly'?: boolean;
37
37
  /**
38
- * Metadata key-value pairs to search for
38
+ * 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.
39
39
  */
40
40
  'metadataCriteria'?: { [key: string]: any; };
41
41
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfilz-sdk/typescript-ee",
3
- "version": "1.14.0",
3
+ "version": "1.14.1",
4
4
  "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {