@openfilz-sdk/typescript-ee 1.9.6 → 1.9.8

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 (128) hide show
  1. package/.openapi-generator/FILES +26 -0
  2. package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
  3. package/README.md +27 -4
  4. package/api/aichat-api.ts +82 -9
  5. package/api/document-controller-api.ts +30 -14
  6. package/api/document-insights-api.ts +357 -0
  7. package/api/esign-api.ts +9 -9
  8. package/api/settings-api.ts +142 -0
  9. package/api/smart-filing-api.ts +421 -0
  10. package/api.ts +2 -0
  11. package/dist/api/aichat-api.d.ts +37 -4
  12. package/dist/api/aichat-api.js +77 -9
  13. package/dist/api/document-controller-api.d.ts +16 -8
  14. package/dist/api/document-controller-api.js +28 -14
  15. package/dist/api/document-insights-api.d.ts +170 -0
  16. package/dist/api/document-insights-api.js +346 -0
  17. package/dist/api/esign-api.d.ts +4 -4
  18. package/dist/api/esign-api.js +9 -9
  19. package/dist/api/settings-api.d.ts +62 -0
  20. package/dist/api/settings-api.js +132 -0
  21. package/dist/api/smart-filing-api.d.ts +197 -0
  22. package/dist/api/smart-filing-api.js +409 -0
  23. package/dist/api.d.ts +2 -0
  24. package/dist/api.js +2 -0
  25. package/dist/esm/api/aichat-api.d.ts +37 -4
  26. package/dist/esm/api/aichat-api.js +77 -9
  27. package/dist/esm/api/document-controller-api.d.ts +16 -8
  28. package/dist/esm/api/document-controller-api.js +28 -14
  29. package/dist/esm/api/document-insights-api.d.ts +170 -0
  30. package/dist/esm/api/document-insights-api.js +339 -0
  31. package/dist/esm/api/esign-api.d.ts +4 -4
  32. package/dist/esm/api/esign-api.js +9 -9
  33. package/dist/esm/api/settings-api.d.ts +62 -0
  34. package/dist/esm/api/settings-api.js +132 -0
  35. package/dist/esm/api/smart-filing-api.d.ts +197 -0
  36. package/dist/esm/api/smart-filing-api.js +402 -0
  37. package/dist/esm/api.d.ts +2 -0
  38. package/dist/esm/api.js +2 -0
  39. package/dist/esm/models/ai-preferences-view.d.ts +16 -0
  40. package/dist/esm/models/ai-preferences-view.js +14 -0
  41. package/dist/esm/models/auto-file-job-view.d.ts +25 -0
  42. package/dist/esm/models/auto-file-job-view.js +14 -0
  43. package/dist/esm/models/auto-file-request.d.ts +15 -0
  44. package/dist/esm/models/auto-file-request.js +14 -0
  45. package/dist/esm/models/auto-file-ticket.d.ts +15 -0
  46. package/dist/esm/models/auto-file-ticket.js +14 -0
  47. package/dist/esm/models/document-insight-view.d.ts +33 -0
  48. package/dist/esm/models/document-insight-view.js +14 -0
  49. package/dist/esm/models/filing-outcome.d.ts +25 -0
  50. package/dist/esm/models/filing-outcome.js +14 -0
  51. package/dist/esm/models/index.d.ts +11 -0
  52. package/dist/esm/models/index.js +11 -0
  53. package/dist/esm/models/insight-backfill-request.d.ts +15 -0
  54. package/dist/esm/models/insight-backfill-request.js +14 -0
  55. package/dist/esm/models/insight-backfill-status.d.ts +23 -0
  56. package/dist/esm/models/insight-backfill-status.js +14 -0
  57. package/dist/esm/models/insight-category-update.d.ts +14 -0
  58. package/dist/esm/models/insight-category-update.js +14 -0
  59. package/dist/esm/models/reorganization-by-kind-request.d.ts +14 -0
  60. package/dist/esm/models/reorganization-by-kind-request.js +14 -0
  61. package/dist/esm/models/save-ai-preferences-request.d.ts +15 -0
  62. package/dist/esm/models/save-ai-preferences-request.js +14 -0
  63. package/dist/esm/models/settings.d.ts +3 -0
  64. package/dist/esm/models/tus-finalize-request.d.ts +1 -0
  65. package/dist/esm/models/upload-response.d.ts +2 -0
  66. package/dist/models/ai-preferences-view.d.ts +16 -0
  67. package/dist/models/ai-preferences-view.js +15 -0
  68. package/dist/models/auto-file-job-view.d.ts +25 -0
  69. package/dist/models/auto-file-job-view.js +15 -0
  70. package/dist/models/auto-file-request.d.ts +15 -0
  71. package/dist/models/auto-file-request.js +15 -0
  72. package/dist/models/auto-file-ticket.d.ts +15 -0
  73. package/dist/models/auto-file-ticket.js +15 -0
  74. package/dist/models/document-insight-view.d.ts +33 -0
  75. package/dist/models/document-insight-view.js +15 -0
  76. package/dist/models/filing-outcome.d.ts +25 -0
  77. package/dist/models/filing-outcome.js +15 -0
  78. package/dist/models/index.d.ts +11 -0
  79. package/dist/models/index.js +11 -0
  80. package/dist/models/insight-backfill-request.d.ts +15 -0
  81. package/dist/models/insight-backfill-request.js +15 -0
  82. package/dist/models/insight-backfill-status.d.ts +23 -0
  83. package/dist/models/insight-backfill-status.js +15 -0
  84. package/dist/models/insight-category-update.d.ts +14 -0
  85. package/dist/models/insight-category-update.js +15 -0
  86. package/dist/models/reorganization-by-kind-request.d.ts +14 -0
  87. package/dist/models/reorganization-by-kind-request.js +15 -0
  88. package/dist/models/save-ai-preferences-request.d.ts +15 -0
  89. package/dist/models/save-ai-preferences-request.js +15 -0
  90. package/dist/models/settings.d.ts +3 -0
  91. package/dist/models/tus-finalize-request.d.ts +1 -0
  92. package/dist/models/upload-response.d.ts +2 -0
  93. package/docs/AIChatApi.md +57 -4
  94. package/docs/AiPreferencesView.md +24 -0
  95. package/docs/AutoFileJobView.md +40 -0
  96. package/docs/AutoFileRequest.md +22 -0
  97. package/docs/AutoFileTicket.md +22 -0
  98. package/docs/DocumentControllerApi.md +6 -0
  99. package/docs/DocumentInsightView.md +54 -0
  100. package/docs/DocumentInsightsApi.md +219 -0
  101. package/docs/ESignApi.md +4 -4
  102. package/docs/FilingOutcome.md +42 -0
  103. package/docs/InsightBackfillRequest.md +22 -0
  104. package/docs/InsightBackfillStatus.md +38 -0
  105. package/docs/InsightCategoryUpdate.md +20 -0
  106. package/docs/ReorganizationByKindRequest.md +20 -0
  107. package/docs/SaveAiPreferencesRequest.md +22 -0
  108. package/docs/Settings.md +6 -0
  109. package/docs/SettingsApi.md +97 -0
  110. package/docs/SmartFilingApi.md +264 -0
  111. package/docs/TusFinalizeRequest.md +2 -0
  112. package/docs/UploadResponse.md +2 -0
  113. package/models/ai-preferences-view.ts +22 -0
  114. package/models/auto-file-job-view.ts +33 -0
  115. package/models/auto-file-request.ts +21 -0
  116. package/models/auto-file-ticket.ts +21 -0
  117. package/models/document-insight-view.ts +37 -0
  118. package/models/filing-outcome.ts +31 -0
  119. package/models/index.ts +11 -0
  120. package/models/insight-backfill-request.ts +21 -0
  121. package/models/insight-backfill-status.ts +29 -0
  122. package/models/insight-category-update.ts +20 -0
  123. package/models/reorganization-by-kind-request.ts +20 -0
  124. package/models/save-ai-preferences-request.ts +21 -0
  125. package/models/settings.ts +3 -0
  126. package/models/tus-finalize-request.ts +1 -0
  127. package/models/upload-response.ts +4 -0
  128. package/package.json +1 -1
@@ -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
+ export interface InsightBackfillRequest {
13
+ 'folderId'?: string;
14
+ 'force'?: boolean;
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,23 @@
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 InsightBackfillStatus {
13
+ 'jobId'?: string;
14
+ 'folderId'?: string;
15
+ 'force'?: boolean;
16
+ 'status'?: string;
17
+ 'total'?: number;
18
+ 'done'?: number;
19
+ 'failed'?: number;
20
+ 'skipped'?: number;
21
+ 'startedAt'?: string;
22
+ 'finishedAt'?: string;
23
+ }
@@ -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,14 @@
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 InsightCategoryUpdate {
13
+ 'category'?: string;
14
+ }
@@ -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,14 @@
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 ReorganizationByKindRequest {
13
+ 'rootFolderId'?: string;
14
+ }
@@ -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,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
+ export interface SaveAiPreferencesRequest {
13
+ 'autoFile'?: boolean;
14
+ 'autoFileNewFolders'?: boolean;
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 });
@@ -18,6 +18,9 @@ export interface Settings {
18
18
  'thumbnailsActive'?: boolean;
19
19
  'aiActive'?: boolean;
20
20
  'aiUserSettingsEnabled'?: boolean;
21
+ 'aiInsightsActive'?: boolean;
22
+ 'aiInsightsCategories'?: Array<string>;
23
+ 'aiAutoFileActive'?: boolean;
21
24
  'signatureActive'?: boolean;
22
25
  'pdfToolsActive'?: boolean;
23
26
  'signatureRequesterRoleRequired'?: boolean;
@@ -16,4 +16,5 @@ export interface TusFinalizeRequest {
16
16
  [key: string]: any;
17
17
  };
18
18
  'allowDuplicateFileNames'?: boolean;
19
+ 'autoFile'?: boolean;
19
20
  }
@@ -9,6 +9,7 @@
9
9
  * https://openapi-generator.tech
10
10
  * Do not edit the class manually.
11
11
  */
12
+ import type { AutoFileTicket } from './auto-file-ticket';
12
13
  export interface UploadResponse {
13
14
  'id'?: string;
14
15
  'name'?: string;
@@ -16,4 +17,5 @@ export interface UploadResponse {
16
17
  'size'?: number;
17
18
  'errorType'?: string;
18
19
  'errorMessage'?: string;
20
+ 'autoFile'?: AutoFileTicket;
19
21
  }
package/docs/AIChatApi.md CHANGED
@@ -8,9 +8,10 @@ All URIs are relative to *http://localhost:8081*
8
8
  |[**chat**](#chat) | **POST** /api/v1/ai/chat | Chat with AI assistant|
9
9
  |[**deleteConversation**](#deleteconversation) | **DELETE** /api/v1/ai/conversations/{conversationId} | Delete conversation|
10
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|
11
+ |[**get4**](#get4) | **GET** /api/v1/ai/reorganization/{planId} | Get a reorganisation plan proposed by the AI assistant|
12
12
  |[**getConversationHistory**](#getconversationhistory) | **GET** /api/v1/ai/conversations/{conversationId} | Get conversation history|
13
13
  |[**listConversations**](#listconversations) | **GET** /api/v1/ai/conversations | List conversations|
14
+ |[**proposeByKind**](#proposebykind) | **POST** /api/v1/ai/reorganization/by-kind | Propose a reorganisation by kind of document — no model involved|
14
15
 
15
16
  # **apply**
16
17
  > ReorganizationApplyResult apply()
@@ -220,8 +221,8 @@ const { status, data } = await apiInstance.discard(
220
221
 
221
222
  [[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
 
223
- # **get3**
224
- > ReorganizationPlanView get3()
224
+ # **get4**
225
+ > ReorganizationPlanView get4()
225
226
 
226
227
  The plan\'s items (what moves where), which are applicable, and its status.
227
228
 
@@ -238,7 +239,7 @@ const apiInstance = new AIChatApi(configuration);
238
239
 
239
240
  let planId: string; // (default to undefined)
240
241
 
241
- const { status, data } = await apiInstance.get3(
242
+ const { status, data } = await apiInstance.get4(
242
243
  planId
243
244
  );
244
245
  ```
@@ -366,3 +367,55 @@ This endpoint does not have any parameters.
366
367
 
367
368
  [[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)
368
369
 
370
+ # **proposeByKind**
371
+ > ReorganizationPlanView proposeByKind()
372
+
373
+ Every folder of the scope holding documents of several kinds (their insight category) gets one sub-folder per kind, named like the existing folders (Invoices / Factures…), and the files move there. The answer is a stored plan to review and apply; a plan without an id means nothing needs splitting.
374
+
375
+ ### Example
376
+
377
+ ```typescript
378
+ import {
379
+ AIChatApi,
380
+ Configuration,
381
+ ReorganizationByKindRequest
382
+ } from '@openfilz-sdk/typescript-ee';
383
+
384
+ const configuration = new Configuration();
385
+ const apiInstance = new AIChatApi(configuration);
386
+
387
+ let reorganizationByKindRequest: ReorganizationByKindRequest; // (optional)
388
+
389
+ const { status, data } = await apiInstance.proposeByKind(
390
+ reorganizationByKindRequest
391
+ );
392
+ ```
393
+
394
+ ### Parameters
395
+
396
+ |Name | Type | Description | Notes|
397
+ |------------- | ------------- | ------------- | -------------|
398
+ | **reorganizationByKindRequest** | **ReorganizationByKindRequest**| | |
399
+
400
+
401
+ ### Return type
402
+
403
+ **ReorganizationPlanView**
404
+
405
+ ### Authorization
406
+
407
+ [keycloak_auth](../README.md#keycloak_auth)
408
+
409
+ ### HTTP request headers
410
+
411
+ - **Content-Type**: application/json
412
+ - **Accept**: application/json
413
+
414
+
415
+ ### HTTP response details
416
+ | Status code | Description | Response headers |
417
+ |-------------|-------------|------------------|
418
+ |**200** | OK | - |
419
+
420
+ [[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)
421
+
@@ -0,0 +1,24 @@
1
+ # AiPreferencesView
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **autoFileAvailable** | **boolean** | | [optional] [default to undefined]
9
+ **autoFile** | **boolean** | | [optional] [default to undefined]
10
+ **autoFileNewFolders** | **boolean** | | [optional] [default to undefined]
11
+
12
+ ## Example
13
+
14
+ ```typescript
15
+ import { AiPreferencesView } from '@openfilz-sdk/typescript-ee';
16
+
17
+ const instance: AiPreferencesView = {
18
+ autoFileAvailable,
19
+ autoFile,
20
+ autoFileNewFolders,
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,40 @@
1
+ # AutoFileJobView
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **jobId** | **string** | | [optional] [default to undefined]
9
+ **createdBy** | **string** | | [optional] [default to undefined]
10
+ **status** | **string** | | [optional] [default to undefined]
11
+ **total** | **number** | | [optional] [default to undefined]
12
+ **filed** | **number** | | [optional] [default to undefined]
13
+ **skipped** | **number** | | [optional] [default to undefined]
14
+ **failed** | **number** | | [optional] [default to undefined]
15
+ **pending** | **number** | | [optional] [default to undefined]
16
+ **items** | [**Array&lt;FilingOutcome&gt;**](FilingOutcome.md) | | [optional] [default to undefined]
17
+ **createdAt** | **string** | | [optional] [default to undefined]
18
+ **finishedAt** | **string** | | [optional] [default to undefined]
19
+
20
+ ## Example
21
+
22
+ ```typescript
23
+ import { AutoFileJobView } from '@openfilz-sdk/typescript-ee';
24
+
25
+ const instance: AutoFileJobView = {
26
+ jobId,
27
+ createdBy,
28
+ status,
29
+ total,
30
+ filed,
31
+ skipped,
32
+ failed,
33
+ pending,
34
+ items,
35
+ createdAt,
36
+ finishedAt,
37
+ };
38
+ ```
39
+
40
+ [[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
+ # AutoFileRequest
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentIds** | **Array&lt;string&gt;** | | [optional] [default to undefined]
9
+ **allowNewFolders** | **boolean** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { AutoFileRequest } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: AutoFileRequest = {
17
+ documentIds,
18
+ allowNewFolders,
19
+ };
20
+ ```
21
+
22
+ [[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
+ # AutoFileTicket
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **jobId** | **string** | | [optional] [default to undefined]
9
+ **status** | **string** | | [optional] [default to undefined]
10
+
11
+ ## Example
12
+
13
+ ```typescript
14
+ import { AutoFileTicket } from '@openfilz-sdk/typescript-ee';
15
+
16
+ const instance: AutoFileTicket = {
17
+ jobId,
18
+ status,
19
+ };
20
+ ```
21
+
22
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
@@ -736,11 +736,13 @@ const apiInstance = new DocumentControllerApi(configuration);
736
736
 
737
737
  let file: Array<File>; // (default to undefined)
738
738
  let allowDuplicateFileNames: boolean; //when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten) (optional) (default to false)
739
+ let autoFile: boolean; //Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active. (optional) (default to undefined)
739
740
  let parametersByFilename: string; //Paste the JSON array here<br>This array provides optional metadata and attributes for the uploaded files<br><section> <h3>Each object in the array must contain:</h3> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>filename</code></td> <td><code>String</code></td> <td>Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.</td> </tr> <tr> <td><code>fileAttributes</code></td> <td><code>JSON Object</code></td> <td>Container for metadata and other file-specific attributes.</td> </tr> </tbody> </table> <h4>Inside <code>fileAttributes</code>:</h4> <table> <thead> <tr> <th>Field</th> <th>Type</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td><code>parentFolderId</code></td> <td><code>UUID</code></td> <td>UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)</td> </tr> <tr> <td><code>metadata</code></td> <td><code>Map&lt;String, JSON Object&gt;</code></td> <td>Arbitrary metadata to associate with the file (key/value pairs).</td> </tr> </tbody> </table> <h4>Example of <code>parametersByFilename</code> JSON array :</h4> <pre><code>[ { \\\"filename\\\": \\\"file1.txt\\\", \\\"fileAttributes\\\": { \\\"parentFolderId\\\": \\\"f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\", \\\"metadata\\\": { \\\"country\\\": \\\"UK\\\", \\\"owner\\\": { \\\"name\\\": \\\"Joe\\\", \\\"owner_id\\\": 1234568 } } } }, { \\\"filename\\\": \\\"file2.md\\\", \\\"fileAttributes\\\": { \\\"metadata\\\": { \\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\", \\\"key3\\\": \\\"value3\\\" } } } ]</code></pre> </section> (optional) (default to undefined)
740
741
 
741
742
  const { status, data } = await apiInstance.uploadDocument(
742
743
  file,
743
744
  allowDuplicateFileNames,
745
+ autoFile,
744
746
  parametersByFilename
745
747
  );
746
748
  ```
@@ -751,6 +753,7 @@ const { status, data } = await apiInstance.uploadDocument(
751
753
  |------------- | ------------- | ------------- | -------------|
752
754
  | **file** | **Array&lt;File&gt;** | | defaults to undefined|
753
755
  | **allowDuplicateFileNames** | [**boolean**] | when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten) | (optional) defaults to false|
756
+ | **autoFile** | [**boolean**] | Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active. | (optional) defaults to undefined|
754
757
  | **parametersByFilename** | [**string**] | Paste the JSON array here&lt;br&gt;This array provides optional metadata and attributes for the uploaded files&lt;br&gt;&lt;section&gt; &lt;h3&gt;Each object in the array must contain:&lt;/h3&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;filename&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;String&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Must match the filename of one of the uploaded files. Filenames must be unique in the upload request.&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;fileAttributes&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;JSON Object&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Container for metadata and other file-specific attributes.&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Inside &lt;code&gt;fileAttributes&lt;/code&gt;:&lt;/h4&gt; &lt;table&gt; &lt;thead&gt; &lt;tr&gt; &lt;th&gt;Field&lt;/th&gt; &lt;th&gt;Type&lt;/th&gt; &lt;th&gt;Description&lt;/th&gt; &lt;/tr&gt; &lt;/thead&gt; &lt;tbody&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;parentFolderId&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;UUID&lt;/code&gt;&lt;/td&gt; &lt;td&gt;UUID of the target folder to upload the file (if not provided : the file will be uploaded at the root level)&lt;/td&gt; &lt;/tr&gt; &lt;tr&gt; &lt;td&gt;&lt;code&gt;metadata&lt;/code&gt;&lt;/td&gt; &lt;td&gt;&lt;code&gt;Map&amp;lt;String, JSON Object&amp;gt;&lt;/code&gt;&lt;/td&gt; &lt;td&gt;Arbitrary metadata to associate with the file (key/value pairs).&lt;/td&gt; &lt;/tr&gt; &lt;/tbody&gt; &lt;/table&gt; &lt;h4&gt;Example of &lt;code&gt;parametersByFilename&lt;/code&gt; JSON array :&lt;/h4&gt; &lt;pre&gt;&lt;code&gt;[ { \\\&quot;filename\\\&quot;: \\\&quot;file1.txt\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;parentFolderId\\\&quot;: \\\&quot;f8c3de3d-1fea-4d7c-a8b0-29f63c4c3454\\\&quot;, \\\&quot;metadata\\\&quot;: { \\\&quot;country\\\&quot;: \\\&quot;UK\\\&quot;, \\\&quot;owner\\\&quot;: { \\\&quot;name\\\&quot;: \\\&quot;Joe\\\&quot;, \\\&quot;owner_id\\\&quot;: 1234568 } } } }, { \\\&quot;filename\\\&quot;: \\\&quot;file2.md\\\&quot;, \\\&quot;fileAttributes\\\&quot;: { \\\&quot;metadata\\\&quot;: { \\\&quot;key1\\\&quot;: \\\&quot;value1\\\&quot;, \\\&quot;key2\\\&quot;: \\\&quot;value2\\\&quot;, \\\&quot;key3\\\&quot;: \\\&quot;value3\\\&quot; } } } ]&lt;/code&gt;&lt;/pre&gt; &lt;/section&gt; | (optional) defaults to undefined|
755
758
 
756
759
 
@@ -793,12 +796,14 @@ const apiInstance = new DocumentControllerApi(configuration);
793
796
 
794
797
  let file: File; // (default to undefined)
795
798
  let allowDuplicateFileNames: boolean; //when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten) (optional) (default to false)
799
+ let autoFile: boolean; //Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent = the user\'s own switch. Needs openfilz.ai.auto-file.active. (optional) (default to undefined)
796
800
  let parentFolderId: string; //Target parent folder ID to store the file; if not sent or null, the file is stored at the root level (optional) (default to undefined)
797
801
  let metadata: string; // (optional) (default to undefined)
798
802
 
799
803
  const { status, data } = await apiInstance.uploadDocument1(
800
804
  file,
801
805
  allowDuplicateFileNames,
806
+ autoFile,
802
807
  parentFolderId,
803
808
  metadata
804
809
  );
@@ -810,6 +815,7 @@ const { status, data } = await apiInstance.uploadDocument1(
810
815
  |------------- | ------------- | ------------- | -------------|
811
816
  | **file** | [**File**] | | defaults to undefined|
812
817
  | **allowDuplicateFileNames** | [**boolean**] | when true : if a file with the same name already exists in the target parent folder, a 409 error is raised. When false : the file will be stored (but no existing file with same name will be overwritten) | (optional) defaults to false|
818
+ | **autoFile** | [**boolean**] | Smart filing: true asks OpenFilz to choose the destination folder of the uploaded file(s) after the upload (a job id comes back in autoFile.jobId); false leaves them where they are; absent &#x3D; the user\&#39;s own switch. Needs openfilz.ai.auto-file.active. | (optional) defaults to undefined|
813
819
  | **parentFolderId** | [**string**] | Target parent folder ID to store the file; if not sent or null, the file is stored at the root level | (optional) defaults to undefined|
814
820
  | **metadata** | [**string**] | | (optional) defaults to undefined|
815
821
 
@@ -0,0 +1,54 @@
1
+ # DocumentInsightView
2
+
3
+
4
+ ## Properties
5
+
6
+ Name | Type | Description | Notes
7
+ ------------ | ------------- | ------------- | -------------
8
+ **documentId** | **string** | | [optional] [default to undefined]
9
+ **fileTitle** | **string** | | [optional] [default to undefined]
10
+ **fileAuthor** | **string** | | [optional] [default to undefined]
11
+ **fileCreatedAt** | **string** | | [optional] [default to undefined]
12
+ **fileModifiedAt** | **string** | | [optional] [default to undefined]
13
+ **pageCount** | **number** | | [optional] [default to undefined]
14
+ **language** | **string** | | [optional] [default to undefined]
15
+ **category** | **string** | | [optional] [default to undefined]
16
+ **summary** | **string** | | [optional] [default to undefined]
17
+ **keywords** | **Array&lt;string&gt;** | | [optional] [default to undefined]
18
+ **entities** | **{ [key: string]: any; }** | | [optional] [default to undefined]
19
+ **tier** | **number** | | [optional] [default to undefined]
20
+ **model** | **string** | | [optional] [default to undefined]
21
+ **promptVersion** | **number** | | [optional] [default to undefined]
22
+ **status** | **string** | | [optional] [default to undefined]
23
+ **error** | **string** | | [optional] [default to undefined]
24
+ **createdAt** | **string** | | [optional] [default to undefined]
25
+ **updatedAt** | **string** | | [optional] [default to undefined]
26
+
27
+ ## Example
28
+
29
+ ```typescript
30
+ import { DocumentInsightView } from '@openfilz-sdk/typescript-ee';
31
+
32
+ const instance: DocumentInsightView = {
33
+ documentId,
34
+ fileTitle,
35
+ fileAuthor,
36
+ fileCreatedAt,
37
+ fileModifiedAt,
38
+ pageCount,
39
+ language,
40
+ category,
41
+ summary,
42
+ keywords,
43
+ entities,
44
+ tier,
45
+ model,
46
+ promptVersion,
47
+ status,
48
+ error,
49
+ createdAt,
50
+ updatedAt,
51
+ };
52
+ ```
53
+
54
+ [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)