@openfilz-sdk/typescript-ee 1.9.0 → 1.9.2

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.
@@ -19,6 +19,7 @@ api/esign-enterprise-api.ts
19
19
  api/esign-public-api.ts
20
20
  api/esign-templates-api.ts
21
21
  api/favorites-api.ts
22
+ api/feature-entitlements-api.ts
22
23
  api/file-controller-api.ts
23
24
  api/folder-controller-api.ts
24
25
  api/mcp-discovery-controller-api.ts
@@ -95,6 +96,8 @@ docs/EmbedUrlResponse.md
95
96
  docs/EnrichedAuditLog.md
96
97
  docs/EnrichedAuditLogDetails.md
97
98
  docs/FavoritesApi.md
99
+ docs/FeatureEntitlement.md
100
+ docs/FeatureEntitlementsApi.md
98
101
  docs/FileControllerApi.md
99
102
  docs/FileTypeStats.md
100
103
  docs/FilterInput.md
@@ -119,6 +122,7 @@ docs/PublicSignatureView.md
119
122
  docs/RenameAudit.md
120
123
  docs/RenameRequest.md
121
124
  docs/ReplaceAudit.md
125
+ docs/Response.md
122
126
  docs/RestoreVersionAudit.md
123
127
  docs/RestoreVersionResponse.md
124
128
  docs/RoleBinding.md
@@ -221,6 +225,7 @@ models/element-info.ts
221
225
  models/embed-url-response.ts
222
226
  models/enriched-audit-log-details.ts
223
227
  models/enriched-audit-log.ts
228
+ models/feature-entitlement.ts
224
229
  models/file-type-stats.ts
225
230
  models/filter-input.ts
226
231
  models/folder-element-info.ts
@@ -241,6 +246,7 @@ models/public-signature-view.ts
241
246
  models/rename-audit.ts
242
247
  models/rename-request.ts
243
248
  models/replace-audit.ts
249
+ models/response.ts
244
250
  models/restore-version-audit.ts
245
251
  models/restore-version-response.ts
246
252
  models/role-binding.ts
@@ -1 +1 @@
1
- c7267a9408e2fba2d28d99bee0c5fd3cd1a93bebf7dd913dbefc6b2caea1c1a0
1
+ 822a5a42414374c5dd3f67a85dbfa61aa94ed830f9595da1e2ca14902b924f6f
package/README.md CHANGED
@@ -1,4 +1,4 @@
1
- ## @openfilz-sdk/typescript-ee@1.9.0
1
+ ## @openfilz-sdk/typescript-ee@1.9.2
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.9.0 --save
39
+ npm install @openfilz-sdk/typescript-ee@1.9.2 --save
40
40
  ```
41
41
 
42
42
  _unPublished (not recommended):_
@@ -141,6 +141,7 @@ Class | Method | HTTP request | Description
141
141
  *FavoritesApi* | [**isFavorite**](docs/FavoritesApi.md#isfavorite) | **GET** /api/v1/favorites/{documentId}/is-favorite | Check favorite status
142
142
  *FavoritesApi* | [**removeFavorite**](docs/FavoritesApi.md#removefavorite) | **DELETE** /api/v1/favorites/{documentId} | Remove document from favorites
143
143
  *FavoritesApi* | [**toggleFavorite**](docs/FavoritesApi.md#togglefavorite) | **PUT** /api/v1/favorites/{documentId}/toggle | Toggle favorite status
144
+ *FeatureEntitlementsApi* | [**getFeatureEntitlements**](docs/FeatureEntitlementsApi.md#getfeatureentitlements) | **GET** /api/v1/admin/features | Deployment + licence state per optional feature
144
145
  *FileControllerApi* | [**copyFiles**](docs/FileControllerApi.md#copyfiles) | **POST** /api/v1/files/copy | Copy files
145
146
  *FileControllerApi* | [**deleteFiles**](docs/FileControllerApi.md#deletefiles) | **DELETE** /api/v1/files | Delete files
146
147
  *FileControllerApi* | [**moveFiles**](docs/FileControllerApi.md#movefiles) | **POST** /api/v1/files/move | Move files
@@ -244,6 +245,7 @@ Class | Method | HTTP request | Description
244
245
  - [EmbedUrlResponse](docs/EmbedUrlResponse.md)
245
246
  - [EnrichedAuditLog](docs/EnrichedAuditLog.md)
246
247
  - [EnrichedAuditLogDetails](docs/EnrichedAuditLogDetails.md)
248
+ - [FeatureEntitlement](docs/FeatureEntitlement.md)
247
249
  - [FileTypeStats](docs/FileTypeStats.md)
248
250
  - [FilterInput](docs/FilterInput.md)
249
251
  - [FolderElementInfo](docs/FolderElementInfo.md)
@@ -263,6 +265,7 @@ Class | Method | HTTP request | Description
263
265
  - [RenameAudit](docs/RenameAudit.md)
264
266
  - [RenameRequest](docs/RenameRequest.md)
265
267
  - [ReplaceAudit](docs/ReplaceAudit.md)
268
+ - [Response](docs/Response.md)
266
269
  - [RestoreVersionAudit](docs/RestoreVersionAudit.md)
267
270
  - [RestoreVersionResponse](docs/RestoreVersionResponse.md)
268
271
  - [RoleBinding](docs/RoleBinding.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 { Response } from '../models';
26
+ /**
27
+ * FeatureEntitlementsApi - axios parameter creator
28
+ */
29
+ export const FeatureEntitlementsApiAxiosParamCreator = function (configuration?: Configuration) {
30
+ return {
31
+ /**
32
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
33
+ * @summary Deployment + licence state per optional feature
34
+ * @param {*} [options] Override http request option.
35
+ * @throws {RequiredError}
36
+ */
37
+ getFeatureEntitlements: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
38
+ const localVarPath = `/api/v1/admin/features`;
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
+ * FeatureEntitlementsApi - functional programming interface
70
+ */
71
+ export const FeatureEntitlementsApiFp = function(configuration?: Configuration) {
72
+ const localVarAxiosParamCreator = FeatureEntitlementsApiAxiosParamCreator(configuration)
73
+ return {
74
+ /**
75
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
76
+ * @summary Deployment + licence state per optional feature
77
+ * @param {*} [options] Override http request option.
78
+ * @throws {RequiredError}
79
+ */
80
+ async getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Response>> {
81
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getFeatureEntitlements(options);
82
+ const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
83
+ const localVarOperationServerBasePath = operationServerMap['FeatureEntitlementsApi.getFeatureEntitlements']?.[localVarOperationServerIndex]?.url;
84
+ return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
85
+ },
86
+ }
87
+ };
88
+
89
+ /**
90
+ * FeatureEntitlementsApi - factory interface
91
+ */
92
+ export const FeatureEntitlementsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
93
+ const localVarFp = FeatureEntitlementsApiFp(configuration)
94
+ return {
95
+ /**
96
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
97
+ * @summary Deployment + licence state per optional feature
98
+ * @param {*} [options] Override http request option.
99
+ * @throws {RequiredError}
100
+ */
101
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): AxiosPromise<Response> {
102
+ return localVarFp.getFeatureEntitlements(options).then((request) => request(axios, basePath));
103
+ },
104
+ };
105
+ };
106
+
107
+ /**
108
+ * FeatureEntitlementsApi - object-oriented interface
109
+ */
110
+ export class FeatureEntitlementsApi extends BaseAPI {
111
+ /**
112
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
113
+ * @summary Deployment + licence state per optional feature
114
+ * @param {*} [options] Override http request option.
115
+ * @throws {RequiredError}
116
+ */
117
+ public getFeatureEntitlements(options?: RawAxiosRequestConfig) {
118
+ return FeatureEntitlementsApiFp(this.configuration).getFeatureEntitlements(options).then((request) => request(this.axios, this.basePath));
119
+ }
120
+ }
121
+
package/api.ts CHANGED
@@ -30,6 +30,7 @@ export * from './api/esign-enterprise-api';
30
30
  export * from './api/esign-public-api';
31
31
  export * from './api/esign-templates-api';
32
32
  export * from './api/favorites-api';
33
+ export * from './api/feature-entitlements-api';
33
34
  export * from './api/file-controller-api';
34
35
  export * from './api/folder-controller-api';
35
36
  export * from './api/mcp-discovery-controller-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 { Response } from '../models';
16
+ /**
17
+ * FeatureEntitlementsApi - axios parameter creator
18
+ */
19
+ export declare const FeatureEntitlementsApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
22
+ * @summary Deployment + licence state per optional feature
23
+ * @param {*} [options] Override http request option.
24
+ * @throws {RequiredError}
25
+ */
26
+ getFeatureEntitlements: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27
+ };
28
+ /**
29
+ * FeatureEntitlementsApi - functional programming interface
30
+ */
31
+ export declare const FeatureEntitlementsApiFp: (configuration?: Configuration) => {
32
+ /**
33
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
34
+ * @summary Deployment + licence state per optional feature
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Response>>;
39
+ };
40
+ /**
41
+ * FeatureEntitlementsApi - factory interface
42
+ */
43
+ export declare const FeatureEntitlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
44
+ /**
45
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
46
+ * @summary Deployment + licence state per optional feature
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): AxiosPromise<Response>;
51
+ };
52
+ /**
53
+ * FeatureEntitlementsApi - object-oriented interface
54
+ */
55
+ export declare class FeatureEntitlementsApi extends BaseAPI {
56
+ /**
57
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
58
+ * @summary Deployment + licence state per optional feature
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Response, 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.FeatureEntitlementsApi = exports.FeatureEntitlementsApiFactory = exports.FeatureEntitlementsApiFp = exports.FeatureEntitlementsApiAxiosParamCreator = 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
+ * FeatureEntitlementsApi - axios parameter creator
34
+ */
35
+ const FeatureEntitlementsApiAxiosParamCreator = function (configuration) {
36
+ return {
37
+ /**
38
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
39
+ * @summary Deployment + licence state per optional feature
40
+ * @param {*} [options] Override http request option.
41
+ * @throws {RequiredError}
42
+ */
43
+ getFeatureEntitlements: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
44
+ const localVarPath = `/api/v1/admin/features`;
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.FeatureEntitlementsApiAxiosParamCreator = FeatureEntitlementsApiAxiosParamCreator;
69
+ /**
70
+ * FeatureEntitlementsApi - functional programming interface
71
+ */
72
+ const FeatureEntitlementsApiFp = function (configuration) {
73
+ const localVarAxiosParamCreator = (0, exports.FeatureEntitlementsApiAxiosParamCreator)(configuration);
74
+ return {
75
+ /**
76
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
77
+ * @summary Deployment + licence state per optional feature
78
+ * @param {*} [options] Override http request option.
79
+ * @throws {RequiredError}
80
+ */
81
+ getFeatureEntitlements(options) {
82
+ return __awaiter(this, void 0, void 0, function* () {
83
+ var _a, _b, _c;
84
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getFeatureEntitlements(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['FeatureEntitlementsApi.getFeatureEntitlements']) === 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.FeatureEntitlementsApiFp = FeatureEntitlementsApiFp;
93
+ /**
94
+ * FeatureEntitlementsApi - factory interface
95
+ */
96
+ const FeatureEntitlementsApiFactory = function (configuration, basePath, axios) {
97
+ const localVarFp = (0, exports.FeatureEntitlementsApiFp)(configuration);
98
+ return {
99
+ /**
100
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
101
+ * @summary Deployment + licence state per optional feature
102
+ * @param {*} [options] Override http request option.
103
+ * @throws {RequiredError}
104
+ */
105
+ getFeatureEntitlements(options) {
106
+ return localVarFp.getFeatureEntitlements(options).then((request) => request(axios, basePath));
107
+ },
108
+ };
109
+ };
110
+ exports.FeatureEntitlementsApiFactory = FeatureEntitlementsApiFactory;
111
+ /**
112
+ * FeatureEntitlementsApi - object-oriented interface
113
+ */
114
+ class FeatureEntitlementsApi extends base_1.BaseAPI {
115
+ /**
116
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
117
+ * @summary Deployment + licence state per optional feature
118
+ * @param {*} [options] Override http request option.
119
+ * @throws {RequiredError}
120
+ */
121
+ getFeatureEntitlements(options) {
122
+ return (0, exports.FeatureEntitlementsApiFp)(this.configuration).getFeatureEntitlements(options).then((request) => request(this.axios, this.basePath));
123
+ }
124
+ }
125
+ exports.FeatureEntitlementsApi = FeatureEntitlementsApi;
package/dist/api.d.ts CHANGED
@@ -25,6 +25,7 @@ export * from './api/esign-enterprise-api';
25
25
  export * from './api/esign-public-api';
26
26
  export * from './api/esign-templates-api';
27
27
  export * from './api/favorites-api';
28
+ export * from './api/feature-entitlements-api';
28
29
  export * from './api/file-controller-api';
29
30
  export * from './api/folder-controller-api';
30
31
  export * from './api/mcp-discovery-controller-api';
package/dist/api.js CHANGED
@@ -43,6 +43,7 @@ __exportStar(require("./api/esign-enterprise-api"), exports);
43
43
  __exportStar(require("./api/esign-public-api"), exports);
44
44
  __exportStar(require("./api/esign-templates-api"), exports);
45
45
  __exportStar(require("./api/favorites-api"), exports);
46
+ __exportStar(require("./api/feature-entitlements-api"), exports);
46
47
  __exportStar(require("./api/file-controller-api"), exports);
47
48
  __exportStar(require("./api/folder-controller-api"), exports);
48
49
  __exportStar(require("./api/mcp-discovery-controller-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 { Response } from '../models';
16
+ /**
17
+ * FeatureEntitlementsApi - axios parameter creator
18
+ */
19
+ export declare const FeatureEntitlementsApiAxiosParamCreator: (configuration?: Configuration) => {
20
+ /**
21
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
22
+ * @summary Deployment + licence state per optional feature
23
+ * @param {*} [options] Override http request option.
24
+ * @throws {RequiredError}
25
+ */
26
+ getFeatureEntitlements: (options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
27
+ };
28
+ /**
29
+ * FeatureEntitlementsApi - functional programming interface
30
+ */
31
+ export declare const FeatureEntitlementsApiFp: (configuration?: Configuration) => {
32
+ /**
33
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
34
+ * @summary Deployment + licence state per optional feature
35
+ * @param {*} [options] Override http request option.
36
+ * @throws {RequiredError}
37
+ */
38
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Response>>;
39
+ };
40
+ /**
41
+ * FeatureEntitlementsApi - factory interface
42
+ */
43
+ export declare const FeatureEntitlementsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
44
+ /**
45
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
46
+ * @summary Deployment + licence state per optional feature
47
+ * @param {*} [options] Override http request option.
48
+ * @throws {RequiredError}
49
+ */
50
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): AxiosPromise<Response>;
51
+ };
52
+ /**
53
+ * FeatureEntitlementsApi - object-oriented interface
54
+ */
55
+ export declare class FeatureEntitlementsApi extends BaseAPI {
56
+ /**
57
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
58
+ * @summary Deployment + licence state per optional feature
59
+ * @param {*} [options] Override http request option.
60
+ * @throws {RequiredError}
61
+ */
62
+ getFeatureEntitlements(options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Response, 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
+ * FeatureEntitlementsApi - axios parameter creator
31
+ */
32
+ export const FeatureEntitlementsApiAxiosParamCreator = function (configuration) {
33
+ return {
34
+ /**
35
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
36
+ * @summary Deployment + licence state per optional feature
37
+ * @param {*} [options] Override http request option.
38
+ * @throws {RequiredError}
39
+ */
40
+ getFeatureEntitlements: (...args_1) => __awaiter(this, [...args_1], void 0, function* (options = {}) {
41
+ const localVarPath = `/api/v1/admin/features`;
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
+ * FeatureEntitlementsApi - functional programming interface
67
+ */
68
+ export const FeatureEntitlementsApiFp = function (configuration) {
69
+ const localVarAxiosParamCreator = FeatureEntitlementsApiAxiosParamCreator(configuration);
70
+ return {
71
+ /**
72
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
73
+ * @summary Deployment + licence state per optional feature
74
+ * @param {*} [options] Override http request option.
75
+ * @throws {RequiredError}
76
+ */
77
+ getFeatureEntitlements(options) {
78
+ return __awaiter(this, void 0, void 0, function* () {
79
+ var _a, _b, _c;
80
+ const localVarAxiosArgs = yield localVarAxiosParamCreator.getFeatureEntitlements(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['FeatureEntitlementsApi.getFeatureEntitlements']) === 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
+ * FeatureEntitlementsApi - factory interface
90
+ */
91
+ export const FeatureEntitlementsApiFactory = function (configuration, basePath, axios) {
92
+ const localVarFp = FeatureEntitlementsApiFp(configuration);
93
+ return {
94
+ /**
95
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
96
+ * @summary Deployment + licence state per optional feature
97
+ * @param {*} [options] Override http request option.
98
+ * @throws {RequiredError}
99
+ */
100
+ getFeatureEntitlements(options) {
101
+ return localVarFp.getFeatureEntitlements(options).then((request) => request(axios, basePath));
102
+ },
103
+ };
104
+ };
105
+ /**
106
+ * FeatureEntitlementsApi - object-oriented interface
107
+ */
108
+ export class FeatureEntitlementsApi extends BaseAPI {
109
+ /**
110
+ * Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
111
+ * @summary Deployment + licence state per optional feature
112
+ * @param {*} [options] Override http request option.
113
+ * @throws {RequiredError}
114
+ */
115
+ getFeatureEntitlements(options) {
116
+ return FeatureEntitlementsApiFp(this.configuration).getFeatureEntitlements(options).then((request) => request(this.axios, this.basePath));
117
+ }
118
+ }
package/dist/esm/api.d.ts CHANGED
@@ -25,6 +25,7 @@ export * from './api/esign-enterprise-api';
25
25
  export * from './api/esign-public-api';
26
26
  export * from './api/esign-templates-api';
27
27
  export * from './api/favorites-api';
28
+ export * from './api/feature-entitlements-api';
28
29
  export * from './api/file-controller-api';
29
30
  export * from './api/folder-controller-api';
30
31
  export * from './api/mcp-discovery-controller-api';
package/dist/esm/api.js CHANGED
@@ -27,6 +27,7 @@ export * from './api/esign-enterprise-api';
27
27
  export * from './api/esign-public-api';
28
28
  export * from './api/esign-templates-api';
29
29
  export * from './api/favorites-api';
30
+ export * from './api/feature-entitlements-api';
30
31
  export * from './api/file-controller-api';
31
32
  export * from './api/folder-controller-api';
32
33
  export * from './api/mcp-discovery-controller-api';
@@ -0,0 +1,16 @@
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
+ export interface FeatureEntitlement {
13
+ 'feature'?: string;
14
+ 'deployed'?: boolean;
15
+ 'licensed'?: boolean;
16
+ }
@@ -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 {};
@@ -42,6 +42,7 @@ export * from './element-info';
42
42
  export * from './embed-url-response';
43
43
  export * from './enriched-audit-log';
44
44
  export * from './enriched-audit-log-details';
45
+ export * from './feature-entitlement';
45
46
  export * from './file-type-stats';
46
47
  export * from './filter-input';
47
48
  export * from './folder-element-info';
@@ -61,6 +62,7 @@ export * from './public-signature-view';
61
62
  export * from './rename-audit';
62
63
  export * from './rename-request';
63
64
  export * from './replace-audit';
65
+ export * from './response';
64
66
  export * from './restore-version-audit';
65
67
  export * from './restore-version-response';
66
68
  export * from './role-binding';
@@ -42,6 +42,7 @@ export * from './element-info';
42
42
  export * from './embed-url-response';
43
43
  export * from './enriched-audit-log';
44
44
  export * from './enriched-audit-log-details';
45
+ export * from './feature-entitlement';
45
46
  export * from './file-type-stats';
46
47
  export * from './filter-input';
47
48
  export * from './folder-element-info';
@@ -61,6 +62,7 @@ export * from './public-signature-view';
61
62
  export * from './rename-audit';
62
63
  export * from './rename-request';
63
64
  export * from './replace-audit';
65
+ export * from './response';
64
66
  export * from './restore-version-audit';
65
67
  export * from './restore-version-response';
66
68
  export * from './role-binding';
@@ -0,0 +1,15 @@
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 { FeatureEntitlement } from './feature-entitlement';
13
+ export interface Response {
14
+ 'features'?: Array<FeatureEntitlement>;
15
+ }
@@ -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 {};
@@ -0,0 +1,16 @@
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
+ export interface FeatureEntitlement {
13
+ 'feature'?: string;
14
+ 'deployed'?: boolean;
15
+ 'licensed'?: boolean;
16
+ }
@@ -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 });
@@ -42,6 +42,7 @@ export * from './element-info';
42
42
  export * from './embed-url-response';
43
43
  export * from './enriched-audit-log';
44
44
  export * from './enriched-audit-log-details';
45
+ export * from './feature-entitlement';
45
46
  export * from './file-type-stats';
46
47
  export * from './filter-input';
47
48
  export * from './folder-element-info';
@@ -61,6 +62,7 @@ export * from './public-signature-view';
61
62
  export * from './rename-audit';
62
63
  export * from './rename-request';
63
64
  export * from './replace-audit';
65
+ export * from './response';
64
66
  export * from './restore-version-audit';
65
67
  export * from './restore-version-response';
66
68
  export * from './role-binding';
@@ -58,6 +58,7 @@ __exportStar(require("./element-info"), exports);
58
58
  __exportStar(require("./embed-url-response"), exports);
59
59
  __exportStar(require("./enriched-audit-log"), exports);
60
60
  __exportStar(require("./enriched-audit-log-details"), exports);
61
+ __exportStar(require("./feature-entitlement"), exports);
61
62
  __exportStar(require("./file-type-stats"), exports);
62
63
  __exportStar(require("./filter-input"), exports);
63
64
  __exportStar(require("./folder-element-info"), exports);
@@ -77,6 +78,7 @@ __exportStar(require("./public-signature-view"), exports);
77
78
  __exportStar(require("./rename-audit"), exports);
78
79
  __exportStar(require("./rename-request"), exports);
79
80
  __exportStar(require("./replace-audit"), exports);
81
+ __exportStar(require("./response"), exports);
80
82
  __exportStar(require("./restore-version-audit"), exports);
81
83
  __exportStar(require("./restore-version-response"), exports);
82
84
  __exportStar(require("./role-binding"), exports);
@@ -0,0 +1,15 @@
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 { FeatureEntitlement } from './feature-entitlement';
13
+ export interface Response {
14
+ 'features'?: Array<FeatureEntitlement>;
15
+ }
@@ -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 });
@@ -0,0 +1,24 @@
1
+ # FeatureEntitlement
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **feature** | **string** | | [optional] [default to undefined]
9
+ **deployed** | **boolean** | | [optional] [default to undefined]
10
+ **licensed** | **boolean** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { FeatureEntitlement } from '@openfilz-sdk/typescript-ee';
16
+
17
+ const instance: FeatureEntitlement = {
18
+ feature,
19
+ deployed,
20
+ licensed,
21
+ };
22
+ ```
23
+
24
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,52 @@
1
+ # FeatureEntitlementsApi
2
+
3
+ All URIs are relative to *http://localhost:8081*
4
+
5
+ |Method | HTTP request | Description|
6
+ |------------- | ------------- | -------------|
7
+ |[**getFeatureEntitlements**](#getfeatureentitlements) | **GET** /api/v1/admin/features | Deployment + licence state per optional feature|
8
+
9
+ # **getFeatureEntitlements**
10
+ > Response getFeatureEntitlements()
11
+
12
+ Lets the admin UI distinguish \'service not deployed\' from \'licence does not entitle this feature\', so the latter can prompt a licence upgrade instead of failing on the first API call. Exposes feature names only — no licence internals.
13
+
14
+ ### Example
15
+
16
+ ```typescript
17
+ import {
18
+ FeatureEntitlementsApi,
19
+ Configuration
20
+ } from '@openfilz-sdk/typescript-ee';
21
+
22
+ const configuration = new Configuration();
23
+ const apiInstance = new FeatureEntitlementsApi(configuration);
24
+
25
+ const { status, data } = await apiInstance.getFeatureEntitlements();
26
+ ```
27
+
28
+ ### Parameters
29
+ This endpoint does not have any parameters.
30
+
31
+
32
+ ### Return type
33
+
34
+ **Response**
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,20 @@
1
+ # Response
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **features** | [**Array&lt;FeatureEntitlement&gt;**](FeatureEntitlement.md) | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { Response } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: Response = {
16
+ features,
17
+ };
18
+ ```
19
+
20
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -0,0 +1,22 @@
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
+ export interface FeatureEntitlement {
18
+ 'feature'?: string;
19
+ 'deployed'?: boolean;
20
+ 'licensed'?: boolean;
21
+ }
22
+
package/models/index.ts CHANGED
@@ -42,6 +42,7 @@ export * from './element-info';
42
42
  export * from './embed-url-response';
43
43
  export * from './enriched-audit-log';
44
44
  export * from './enriched-audit-log-details';
45
+ export * from './feature-entitlement';
45
46
  export * from './file-type-stats';
46
47
  export * from './filter-input';
47
48
  export * from './folder-element-info';
@@ -61,6 +62,7 @@ export * from './public-signature-view';
61
62
  export * from './rename-audit';
62
63
  export * from './rename-request';
63
64
  export * from './replace-audit';
65
+ export * from './response';
64
66
  export * from './restore-version-audit';
65
67
  export * from './restore-version-response';
66
68
  export * from './role-binding';
@@ -0,0 +1,23 @@
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
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { FeatureEntitlement } from './feature-entitlement';
19
+
20
+ export interface Response {
21
+ 'features'?: Array<FeatureEntitlement>;
22
+ }
23
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfilz-sdk/typescript-ee",
3
- "version": "1.9.0",
3
+ "version": "1.9.2",
4
4
  "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {