@openfilz-sdk/typescript-ee 1.9.5 → 1.9.6

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.
Files changed (45) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +10 -2
  4. package/api/aichat-api.ts +228 -0
  5. package/dist/api/aichat-api.d.ts +103 -0
  6. package/dist/api/aichat-api.js +213 -0
  7. package/dist/esm/api/aichat-api.d.ts +103 -0
  8. package/dist/esm/api/aichat-api.js +213 -0
  9. package/dist/esm/models/index.d.ts +5 -0
  10. package/dist/esm/models/index.js +5 -0
  11. package/dist/esm/models/item-result.d.ts +16 -0
  12. package/dist/esm/models/item-result.js +14 -0
  13. package/dist/esm/models/item.d.ts +21 -0
  14. package/dist/esm/models/item.js +14 -0
  15. package/dist/esm/models/reorganization-apply-request.d.ts +14 -0
  16. package/dist/esm/models/reorganization-apply-request.js +14 -0
  17. package/dist/esm/models/reorganization-apply-result.d.ts +22 -0
  18. package/dist/esm/models/reorganization-apply-result.js +14 -0
  19. package/dist/esm/models/reorganization-plan-view.d.ts +28 -0
  20. package/dist/esm/models/reorganization-plan-view.js +14 -0
  21. package/dist/models/index.d.ts +5 -0
  22. package/dist/models/index.js +5 -0
  23. package/dist/models/item-result.d.ts +16 -0
  24. package/dist/models/item-result.js +15 -0
  25. package/dist/models/item.d.ts +21 -0
  26. package/dist/models/item.js +15 -0
  27. package/dist/models/reorganization-apply-request.d.ts +14 -0
  28. package/dist/models/reorganization-apply-request.js +15 -0
  29. package/dist/models/reorganization-apply-result.d.ts +22 -0
  30. package/dist/models/reorganization-apply-result.js +15 -0
  31. package/dist/models/reorganization-plan-view.d.ts +28 -0
  32. package/dist/models/reorganization-plan-view.js +15 -0
  33. package/docs/AIChatApi.md +159 -0
  34. package/docs/Item.md +34 -0
  35. package/docs/ItemResult.md +24 -0
  36. package/docs/ReorganizationApplyRequest.md +20 -0
  37. package/docs/ReorganizationApplyResult.md +34 -0
  38. package/docs/ReorganizationPlanView.md +44 -0
  39. package/models/index.ts +5 -0
  40. package/models/item-result.ts +22 -0
  41. package/models/item.ts +27 -0
  42. package/models/reorganization-apply-request.ts +20 -0
  43. package/models/reorganization-apply-result.ts +30 -0
  44. package/models/reorganization-plan-view.ts +38 -0
  45. package/package.json +1 -1
@@ -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,28 @@
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 { Item } from './item';
13
+ import type { ItemResult } from './item-result';
14
+ export interface ReorganizationPlanView {
15
+ 'id'?: string;
16
+ 'status'?: string;
17
+ 'rootFolderId'?: string;
18
+ 'rootFolderPath'?: string;
19
+ 'rationale'?: string;
20
+ 'items'?: Array<Item>;
21
+ 'foldersToCreate'?: Array<string>;
22
+ 'applicable'?: number;
23
+ 'blocked'?: number;
24
+ 'createdBy'?: string;
25
+ 'createdAt'?: string;
26
+ 'appliedAt'?: string;
27
+ 'results'?: Array<ItemResult>;
28
+ }
@@ -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 });
package/docs/AIChatApi.md CHANGED
@@ -4,11 +4,69 @@ All URIs are relative to *http://localhost:8081*
4
4
 
5
5
  |Method | HTTP request | Description|
6
6
  |------------- | ------------- | -------------|
7
+ |[**apply**](#apply) | **POST** /api/v1/ai/reorganization/{planId}/apply | Apply a proposed reorganisation plan|
7
8
  |[**chat**](#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant|
8
9
  |[**deleteConversation**](#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation|
10
+ |[**discard**](#discard) | **POST** /api/v1/ai/reorganization/{planId}/discard | Discard a proposed reorganisation plan|
11
+ |[**get3**](#get3) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
9
12
  |[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
10
13
  |[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
11
14
 
15
+ # **apply**
16
+ > ReorganizationApplyResult apply()
17
+
18
+ Creates the missing folders and moves the selected items (all applicable items when none is given).
19
+
20
+ ### Example
21
+
22
+ ```typescript
23
+ import {
24
+ AIChatApi,
25
+ Configuration,
26
+ ReorganizationApplyRequest
27
+ } from '@openfilz-sdk/typescript-ee';
28
+
29
+ const configuration = new Configuration();
30
+ const apiInstance = new AIChatApi(configuration);
31
+
32
+ let planId: string; // (default to undefined)
33
+ let reorganizationApplyRequest: ReorganizationApplyRequest; // (optional)
34
+
35
+ const { status, data } = await apiInstance.apply(
36
+ planId,
37
+ reorganizationApplyRequest
38
+ );
39
+ ```
40
+
41
+ ### Parameters
42
+
43
+ |Name | Type | Description | Notes|
44
+ |------------- | ------------- | ------------- | -------------|
45
+ | **reorganizationApplyRequest** | **ReorganizationApplyRequest**| | |
46
+ | **planId** | [**string**] | | defaults to undefined|
47
+
48
+
49
+ ### Return type
50
+
51
+ **ReorganizationApplyResult**
52
+
53
+ ### Authorization
54
+
55
+ [keycloak_auth](../README.md#keycloak_auth)
56
+
57
+ ### HTTP request headers
58
+
59
+ - **Content-Type**: application/json
60
+ - **Accept**: application/json
61
+
62
+
63
+ ### HTTP response details
64
+ | Status code | Description | Response headers |
65
+ |-------------|-------------|------------------|
66
+ |**200** | OK | - |
67
+
68
+ [[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)
69
+
12
70
  # **chat**
13
71
  > Array<AiChatResponse> chat(aiChatRequest)
14
72
 
@@ -105,6 +163,107 @@ void (empty response body)
105
163
  - **Accept**: Not defined
106
164
 
107
165
 
166
+ ### HTTP response details
167
+ | Status code | Description | Response headers |
168
+ |-------------|-------------|------------------|
169
+ |**200** | OK | - |
170
+
171
+ [[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)
172
+
173
+ # **discard**
174
+ > ReorganizationPlanView discard()
175
+
176
+
177
+ ### Example
178
+
179
+ ```typescript
180
+ import {
181
+ AIChatApi,
182
+ Configuration
183
+ } from '@openfilz-sdk/typescript-ee';
184
+
185
+ const configuration = new Configuration();
186
+ const apiInstance = new AIChatApi(configuration);
187
+
188
+ let planId: string; // (default to undefined)
189
+
190
+ const { status, data } = await apiInstance.discard(
191
+ planId
192
+ );
193
+ ```
194
+
195
+ ### Parameters
196
+
197
+ |Name | Type | Description | Notes|
198
+ |------------- | ------------- | ------------- | -------------|
199
+ | **planId** | [**string**] | | defaults to undefined|
200
+
201
+
202
+ ### Return type
203
+
204
+ **ReorganizationPlanView**
205
+
206
+ ### Authorization
207
+
208
+ [keycloak_auth](../README.md#keycloak_auth)
209
+
210
+ ### HTTP request headers
211
+
212
+ - **Content-Type**: Not defined
213
+ - **Accept**: application/json
214
+
215
+
216
+ ### HTTP response details
217
+ | Status code | Description | Response headers |
218
+ |-------------|-------------|------------------|
219
+ |**200** | OK | - |
220
+
221
+ [[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)
222
+
223
+ # **get3**
224
+ > ReorganizationPlanView get3()
225
+
226
+ The plan\'s items (what moves where), which are applicable, and its status.
227
+
228
+ ### Example
229
+
230
+ ```typescript
231
+ import {
232
+ AIChatApi,
233
+ Configuration
234
+ } from '@openfilz-sdk/typescript-ee';
235
+
236
+ const configuration = new Configuration();
237
+ const apiInstance = new AIChatApi(configuration);
238
+
239
+ let planId: string; // (default to undefined)
240
+
241
+ const { status, data } = await apiInstance.get3(
242
+ planId
243
+ );
244
+ ```
245
+
246
+ ### Parameters
247
+
248
+ |Name | Type | Description | Notes|
249
+ |------------- | ------------- | ------------- | -------------|
250
+ | **planId** | [**string**] | | defaults to undefined|
251
+
252
+
253
+ ### Return type
254
+
255
+ **ReorganizationPlanView**
256
+
257
+ ### Authorization
258
+
259
+ [keycloak_auth](../README.md#keycloak_auth)
260
+
261
+ ### HTTP request headers
262
+
263
+ - **Content-Type**: Not defined
264
+ - **Accept**: application/json
265
+
266
+
108
267
  ### HTTP response details
109
268
  | Status code | Description | Response headers |
110
269
  |-------------|-------------|------------------|
package/docs/Item.md ADDED
@@ -0,0 +1,34 @@
1
+ # Item
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentId** | **string** | | [optional] [default to undefined]
9
+ **name** | **string** | | [optional] [default to undefined]
10
+ **type** | **string** | | [optional] [default to undefined]
11
+ **currentPath** | **string** | | [optional] [default to undefined]
12
+ **targetPath** | **string** | | [optional] [default to undefined]
13
+ **targetExists** | **boolean** | | [optional] [default to undefined]
14
+ **applicable** | **boolean** | | [optional] [default to undefined]
15
+ **issue** | **string** | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { Item } from '@openfilz-sdk/typescript-ee';
21
+
22
+ const instance: Item = {
23
+ documentId,
24
+ name,
25
+ type,
26
+ currentPath,
27
+ targetPath,
28
+ targetExists,
29
+ applicable,
30
+ issue,
31
+ };
32
+ ```
33
+
34
+ [[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,24 @@
1
+ # ItemResult
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentId** | **string** | | [optional] [default to undefined]
9
+ **outcome** | **string** | | [optional] [default to undefined]
10
+ **detail** | **string** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { ItemResult } from '@openfilz-sdk/typescript-ee';
16
+
17
+ const instance: ItemResult = {
18
+ documentId,
19
+ outcome,
20
+ detail,
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,20 @@
1
+ # ReorganizationApplyRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **itemIds** | **Array&lt;string&gt;** | | [optional] [default to undefined]
9
+
10
+ ## Example
11
+
12
+ ```typescript
13
+ import { ReorganizationApplyRequest } from '@openfilz-sdk/typescript-ee';
14
+
15
+ const instance: ReorganizationApplyRequest = {
16
+ itemIds,
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,34 @@
1
+ # ReorganizationApplyResult
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **planId** | **string** | | [optional] [default to undefined]
9
+ **status** | **string** | | [optional] [default to undefined]
10
+ **moved** | **number** | | [optional] [default to undefined]
11
+ **failed** | **number** | | [optional] [default to undefined]
12
+ **skipped** | **number** | | [optional] [default to undefined]
13
+ **createdFolders** | **Array&lt;string&gt;** | | [optional] [default to undefined]
14
+ **modifiedFolderIds** | **Array&lt;string&gt;** | | [optional] [default to undefined]
15
+ **plan** | [**ReorganizationPlanView**](ReorganizationPlanView.md) | | [optional] [default to undefined]
16
+
17
+ ## Example
18
+
19
+ ```typescript
20
+ import { ReorganizationApplyResult } from '@openfilz-sdk/typescript-ee';
21
+
22
+ const instance: ReorganizationApplyResult = {
23
+ planId,
24
+ status,
25
+ moved,
26
+ failed,
27
+ skipped,
28
+ createdFolders,
29
+ modifiedFolderIds,
30
+ plan,
31
+ };
32
+ ```
33
+
34
+ [[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,44 @@
1
+ # ReorganizationPlanView
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **id** | **string** | | [optional] [default to undefined]
9
+ **status** | **string** | | [optional] [default to undefined]
10
+ **rootFolderId** | **string** | | [optional] [default to undefined]
11
+ **rootFolderPath** | **string** | | [optional] [default to undefined]
12
+ **rationale** | **string** | | [optional] [default to undefined]
13
+ **items** | [**Array&lt;Item&gt;**](Item.md) | | [optional] [default to undefined]
14
+ **foldersToCreate** | **Array&lt;string&gt;** | | [optional] [default to undefined]
15
+ **applicable** | **number** | | [optional] [default to undefined]
16
+ **blocked** | **number** | | [optional] [default to undefined]
17
+ **createdBy** | **string** | | [optional] [default to undefined]
18
+ **createdAt** | **string** | | [optional] [default to undefined]
19
+ **appliedAt** | **string** | | [optional] [default to undefined]
20
+ **results** | [**Array&lt;ItemResult&gt;**](ItemResult.md) | | [optional] [default to undefined]
21
+
22
+ ## Example
23
+
24
+ ```typescript
25
+ import { ReorganizationPlanView } from '@openfilz-sdk/typescript-ee';
26
+
27
+ const instance: ReorganizationPlanView = {
28
+ id,
29
+ status,
30
+ rootFolderId,
31
+ rootFolderPath,
32
+ rationale,
33
+ items,
34
+ foldersToCreate,
35
+ applicable,
36
+ blocked,
37
+ createdBy,
38
+ createdAt,
39
+ appliedAt,
40
+ results,
41
+ };
42
+ ```
43
+
44
+ [[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/models/index.ts CHANGED
@@ -49,6 +49,8 @@ export * from './folder-element-info';
49
49
  export * from './folder-response';
50
50
  export * from './ingestion-status-dto';
51
51
  export * from './instantiate-template-request';
52
+ export * from './item';
53
+ export * from './item-result';
52
54
  export * from './license-info';
53
55
  export * from './list-ai-models-request';
54
56
  export * from './mcp-agent-token-info';
@@ -72,6 +74,9 @@ export * from './pdf-transform-audit';
72
74
  export * from './public-signature-view';
73
75
  export * from './rename-audit';
74
76
  export * from './rename-request';
77
+ export * from './reorganization-apply-request';
78
+ export * from './reorganization-apply-result';
79
+ export * from './reorganization-plan-view';
75
80
  export * from './replace-audit';
76
81
  export * from './response';
77
82
  export * from './restore-version-audit';
@@ -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 ItemResult {
18
+ 'documentId'?: string;
19
+ 'outcome'?: string;
20
+ 'detail'?: string;
21
+ }
22
+
package/models/item.ts ADDED
@@ -0,0 +1,27 @@
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 Item {
18
+ 'documentId'?: string;
19
+ 'name'?: string;
20
+ 'type'?: string;
21
+ 'currentPath'?: string;
22
+ 'targetPath'?: string;
23
+ 'targetExists'?: boolean;
24
+ 'applicable'?: boolean;
25
+ 'issue'?: string;
26
+ }
27
+
@@ -0,0 +1,20 @@
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 ReorganizationApplyRequest {
18
+ 'itemIds'?: Array<string>;
19
+ }
20
+
@@ -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
+ // May contain unused imports in some cases
17
+ // @ts-ignore
18
+ import type { ReorganizationPlanView } from './reorganization-plan-view';
19
+
20
+ export interface ReorganizationApplyResult {
21
+ 'planId'?: string;
22
+ 'status'?: string;
23
+ 'moved'?: number;
24
+ 'failed'?: number;
25
+ 'skipped'?: number;
26
+ 'createdFolders'?: Array<string>;
27
+ 'modifiedFolderIds'?: Array<string>;
28
+ 'plan'?: ReorganizationPlanView;
29
+ }
30
+
@@ -0,0 +1,38 @@
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 { Item } from './item';
19
+ // May contain unused imports in some cases
20
+ // @ts-ignore
21
+ import type { ItemResult } from './item-result';
22
+
23
+ export interface ReorganizationPlanView {
24
+ 'id'?: string;
25
+ 'status'?: string;
26
+ 'rootFolderId'?: string;
27
+ 'rootFolderPath'?: string;
28
+ 'rationale'?: string;
29
+ 'items'?: Array<Item>;
30
+ 'foldersToCreate'?: Array<string>;
31
+ 'applicable'?: number;
32
+ 'blocked'?: number;
33
+ 'createdBy'?: string;
34
+ 'createdAt'?: string;
35
+ 'appliedAt'?: string;
36
+ 'results'?: Array<ItemResult>;
37
+ }
38
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@openfilz-sdk/typescript-ee",
3
- "version": "1.9.5",
3
+ "version": "1.9.6",
4
4
  "description": "OpenAPI client for @openfilz-sdk/typescript-ee",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "repository": {