@openfilz-sdk/typescript-ee 1.9.5 → 1.9.7
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.
- package/.openapi-generator/FILES +32 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +30 -3
- package/api/aichat-api.ts +228 -0
- package/api/document-controller-api.ts +30 -14
- package/api/document-insights-api.ts +275 -0
- package/api/esign-api.ts +9 -9
- package/api/settings-api.ts +142 -0
- package/api/smart-filing-api.ts +421 -0
- package/api.ts +2 -0
- package/dist/api/aichat-api.d.ts +103 -0
- package/dist/api/aichat-api.js +213 -0
- package/dist/api/document-controller-api.d.ts +16 -8
- package/dist/api/document-controller-api.js +28 -14
- package/dist/api/document-insights-api.d.ts +133 -0
- package/dist/api/document-insights-api.js +269 -0
- package/dist/api/esign-api.d.ts +4 -4
- package/dist/api/esign-api.js +9 -9
- package/dist/api/settings-api.d.ts +62 -0
- package/dist/api/settings-api.js +132 -0
- package/dist/api/smart-filing-api.d.ts +197 -0
- package/dist/api/smart-filing-api.js +409 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/esm/api/aichat-api.d.ts +103 -0
- package/dist/esm/api/aichat-api.js +213 -0
- package/dist/esm/api/document-controller-api.d.ts +16 -8
- package/dist/esm/api/document-controller-api.js +28 -14
- package/dist/esm/api/document-insights-api.d.ts +133 -0
- package/dist/esm/api/document-insights-api.js +262 -0
- package/dist/esm/api/esign-api.d.ts +4 -4
- package/dist/esm/api/esign-api.js +9 -9
- package/dist/esm/api/settings-api.d.ts +62 -0
- package/dist/esm/api/settings-api.js +132 -0
- package/dist/esm/api/smart-filing-api.d.ts +197 -0
- package/dist/esm/api/smart-filing-api.js +402 -0
- package/dist/esm/api.d.ts +2 -0
- package/dist/esm/api.js +2 -0
- package/dist/esm/models/ai-preferences-view.d.ts +16 -0
- package/dist/esm/models/ai-preferences-view.js +14 -0
- package/dist/esm/models/auto-file-job-view.d.ts +25 -0
- package/dist/esm/models/auto-file-job-view.js +14 -0
- package/dist/esm/models/auto-file-request.d.ts +15 -0
- package/dist/esm/models/auto-file-request.js +14 -0
- package/dist/esm/models/auto-file-ticket.d.ts +15 -0
- package/dist/esm/models/auto-file-ticket.js +14 -0
- package/dist/esm/models/document-insight-view.d.ts +33 -0
- package/dist/esm/models/document-insight-view.js +14 -0
- package/dist/esm/models/filing-outcome.d.ts +25 -0
- package/dist/esm/models/filing-outcome.js +14 -0
- package/dist/esm/models/index.d.ts +14 -0
- package/dist/esm/models/index.js +14 -0
- package/dist/esm/models/insight-backfill-request.d.ts +15 -0
- package/dist/esm/models/insight-backfill-request.js +14 -0
- package/dist/esm/models/insight-backfill-status.d.ts +23 -0
- package/dist/esm/models/insight-backfill-status.js +14 -0
- package/dist/esm/models/item-result.d.ts +16 -0
- package/dist/esm/models/item-result.js +14 -0
- package/dist/esm/models/item.d.ts +21 -0
- package/dist/esm/models/item.js +14 -0
- package/dist/esm/models/reorganization-apply-request.d.ts +14 -0
- package/dist/esm/models/reorganization-apply-request.js +14 -0
- package/dist/esm/models/reorganization-apply-result.d.ts +22 -0
- package/dist/esm/models/reorganization-apply-result.js +14 -0
- package/dist/esm/models/reorganization-plan-view.d.ts +28 -0
- package/dist/esm/models/reorganization-plan-view.js +14 -0
- package/dist/esm/models/save-ai-preferences-request.d.ts +15 -0
- package/dist/esm/models/save-ai-preferences-request.js +14 -0
- package/dist/esm/models/settings.d.ts +2 -0
- package/dist/esm/models/tus-finalize-request.d.ts +1 -0
- package/dist/esm/models/upload-response.d.ts +2 -0
- package/dist/models/ai-preferences-view.d.ts +16 -0
- package/dist/models/ai-preferences-view.js +15 -0
- package/dist/models/auto-file-job-view.d.ts +25 -0
- package/dist/models/auto-file-job-view.js +15 -0
- package/dist/models/auto-file-request.d.ts +15 -0
- package/dist/models/auto-file-request.js +15 -0
- package/dist/models/auto-file-ticket.d.ts +15 -0
- package/dist/models/auto-file-ticket.js +15 -0
- package/dist/models/document-insight-view.d.ts +33 -0
- package/dist/models/document-insight-view.js +15 -0
- package/dist/models/filing-outcome.d.ts +25 -0
- package/dist/models/filing-outcome.js +15 -0
- package/dist/models/index.d.ts +14 -0
- package/dist/models/index.js +14 -0
- package/dist/models/insight-backfill-request.d.ts +15 -0
- package/dist/models/insight-backfill-request.js +15 -0
- package/dist/models/insight-backfill-status.d.ts +23 -0
- package/dist/models/insight-backfill-status.js +15 -0
- package/dist/models/item-result.d.ts +16 -0
- package/dist/models/item-result.js +15 -0
- package/dist/models/item.d.ts +21 -0
- package/dist/models/item.js +15 -0
- package/dist/models/reorganization-apply-request.d.ts +14 -0
- package/dist/models/reorganization-apply-request.js +15 -0
- package/dist/models/reorganization-apply-result.d.ts +22 -0
- package/dist/models/reorganization-apply-result.js +15 -0
- package/dist/models/reorganization-plan-view.d.ts +28 -0
- package/dist/models/reorganization-plan-view.js +15 -0
- package/dist/models/save-ai-preferences-request.d.ts +15 -0
- package/dist/models/save-ai-preferences-request.js +15 -0
- package/dist/models/settings.d.ts +2 -0
- package/dist/models/tus-finalize-request.d.ts +1 -0
- package/dist/models/upload-response.d.ts +2 -0
- package/docs/AIChatApi.md +159 -0
- package/docs/AiPreferencesView.md +24 -0
- package/docs/AutoFileJobView.md +40 -0
- package/docs/AutoFileRequest.md +22 -0
- package/docs/AutoFileTicket.md +22 -0
- package/docs/DocumentControllerApi.md +6 -0
- package/docs/DocumentInsightView.md +54 -0
- package/docs/DocumentInsightsApi.md +163 -0
- package/docs/ESignApi.md +4 -4
- package/docs/FilingOutcome.md +42 -0
- package/docs/InsightBackfillRequest.md +22 -0
- package/docs/InsightBackfillStatus.md +38 -0
- package/docs/Item.md +34 -0
- package/docs/ItemResult.md +24 -0
- package/docs/ReorganizationApplyRequest.md +20 -0
- package/docs/ReorganizationApplyResult.md +34 -0
- package/docs/ReorganizationPlanView.md +44 -0
- package/docs/SaveAiPreferencesRequest.md +22 -0
- package/docs/Settings.md +4 -0
- package/docs/SettingsApi.md +97 -0
- package/docs/SmartFilingApi.md +264 -0
- package/docs/TusFinalizeRequest.md +2 -0
- package/docs/UploadResponse.md +2 -0
- package/models/ai-preferences-view.ts +22 -0
- package/models/auto-file-job-view.ts +33 -0
- package/models/auto-file-request.ts +21 -0
- package/models/auto-file-ticket.ts +21 -0
- package/models/document-insight-view.ts +37 -0
- package/models/filing-outcome.ts +31 -0
- package/models/index.ts +14 -0
- package/models/insight-backfill-request.ts +21 -0
- package/models/insight-backfill-status.ts +29 -0
- package/models/item-result.ts +22 -0
- package/models/item.ts +27 -0
- package/models/reorganization-apply-request.ts +20 -0
- package/models/reorganization-apply-result.ts +30 -0
- package/models/reorganization-plan-view.ts +38 -0
- package/models/save-ai-preferences-request.ts +21 -0
- package/models/settings.ts +2 -0
- package/models/tus-finalize-request.ts +1 -0
- package/models/upload-response.ts +4 -0
- package/package.json +1 -1
package/dist/api/aichat-api.d.ts
CHANGED
|
@@ -15,10 +15,22 @@ import { type RequestArgs, BaseAPI } from '../base';
|
|
|
15
15
|
import type { AiChatConversation } from '../models';
|
|
16
16
|
import type { AiChatRequest } from '../models';
|
|
17
17
|
import type { AiChatResponse } from '../models';
|
|
18
|
+
import type { ReorganizationApplyRequest } from '../models';
|
|
19
|
+
import type { ReorganizationApplyResult } from '../models';
|
|
20
|
+
import type { ReorganizationPlanView } from '../models';
|
|
18
21
|
/**
|
|
19
22
|
* AIChatApi - axios parameter creator
|
|
20
23
|
*/
|
|
21
24
|
export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25
|
+
/**
|
|
26
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
27
|
+
* @summary Apply a proposed reorganisation plan
|
|
28
|
+
* @param {string} planId
|
|
29
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
30
|
+
* @param {*} [options] Override http request option.
|
|
31
|
+
* @throws {RequiredError}
|
|
32
|
+
*/
|
|
33
|
+
apply: (planId: string, reorganizationApplyRequest?: ReorganizationApplyRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
22
34
|
/**
|
|
23
35
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
24
36
|
* @summary Chat with AI assistant
|
|
@@ -35,6 +47,22 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
35
47
|
* @throws {RequiredError}
|
|
36
48
|
*/
|
|
37
49
|
deleteConversation: (conversationId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
50
|
+
/**
|
|
51
|
+
*
|
|
52
|
+
* @summary Discard a proposed reorganisation plan
|
|
53
|
+
* @param {string} planId
|
|
54
|
+
* @param {*} [options] Override http request option.
|
|
55
|
+
* @throws {RequiredError}
|
|
56
|
+
*/
|
|
57
|
+
discard: (planId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
58
|
+
/**
|
|
59
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
60
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
61
|
+
* @param {string} planId
|
|
62
|
+
* @param {*} [options] Override http request option.
|
|
63
|
+
* @throws {RequiredError}
|
|
64
|
+
*/
|
|
65
|
+
get4: (planId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
66
|
/**
|
|
39
67
|
* Get all messages in a conversation
|
|
40
68
|
* @summary Get conversation history
|
|
@@ -55,6 +83,15 @@ export declare const AIChatApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
55
83
|
* AIChatApi - functional programming interface
|
|
56
84
|
*/
|
|
57
85
|
export declare const AIChatApiFp: (configuration?: Configuration) => {
|
|
86
|
+
/**
|
|
87
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
88
|
+
* @summary Apply a proposed reorganisation plan
|
|
89
|
+
* @param {string} planId
|
|
90
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
91
|
+
* @param {*} [options] Override http request option.
|
|
92
|
+
* @throws {RequiredError}
|
|
93
|
+
*/
|
|
94
|
+
apply(planId: string, reorganizationApplyRequest?: ReorganizationApplyRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationApplyResult>>;
|
|
58
95
|
/**
|
|
59
96
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
60
97
|
* @summary Chat with AI assistant
|
|
@@ -71,6 +108,22 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
|
|
|
71
108
|
* @throws {RequiredError}
|
|
72
109
|
*/
|
|
73
110
|
deleteConversation(conversationId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
111
|
+
/**
|
|
112
|
+
*
|
|
113
|
+
* @summary Discard a proposed reorganisation plan
|
|
114
|
+
* @param {string} planId
|
|
115
|
+
* @param {*} [options] Override http request option.
|
|
116
|
+
* @throws {RequiredError}
|
|
117
|
+
*/
|
|
118
|
+
discard(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
|
|
119
|
+
/**
|
|
120
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
121
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
122
|
+
* @param {string} planId
|
|
123
|
+
* @param {*} [options] Override http request option.
|
|
124
|
+
* @throws {RequiredError}
|
|
125
|
+
*/
|
|
126
|
+
get4(planId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReorganizationPlanView>>;
|
|
74
127
|
/**
|
|
75
128
|
* Get all messages in a conversation
|
|
76
129
|
* @summary Get conversation history
|
|
@@ -91,6 +144,15 @@ export declare const AIChatApiFp: (configuration?: Configuration) => {
|
|
|
91
144
|
* AIChatApi - factory interface
|
|
92
145
|
*/
|
|
93
146
|
export declare const AIChatApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
147
|
+
/**
|
|
148
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
149
|
+
* @summary Apply a proposed reorganisation plan
|
|
150
|
+
* @param {string} planId
|
|
151
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
152
|
+
* @param {*} [options] Override http request option.
|
|
153
|
+
* @throws {RequiredError}
|
|
154
|
+
*/
|
|
155
|
+
apply(planId: string, reorganizationApplyRequest?: ReorganizationApplyRequest, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationApplyResult>;
|
|
94
156
|
/**
|
|
95
157
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
96
158
|
* @summary Chat with AI assistant
|
|
@@ -107,6 +169,22 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
|
|
|
107
169
|
* @throws {RequiredError}
|
|
108
170
|
*/
|
|
109
171
|
deleteConversation(conversationId: string, options?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
172
|
+
/**
|
|
173
|
+
*
|
|
174
|
+
* @summary Discard a proposed reorganisation plan
|
|
175
|
+
* @param {string} planId
|
|
176
|
+
* @param {*} [options] Override http request option.
|
|
177
|
+
* @throws {RequiredError}
|
|
178
|
+
*/
|
|
179
|
+
discard(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
|
|
180
|
+
/**
|
|
181
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
182
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
183
|
+
* @param {string} planId
|
|
184
|
+
* @param {*} [options] Override http request option.
|
|
185
|
+
* @throws {RequiredError}
|
|
186
|
+
*/
|
|
187
|
+
get4(planId: string, options?: RawAxiosRequestConfig): AxiosPromise<ReorganizationPlanView>;
|
|
110
188
|
/**
|
|
111
189
|
* Get all messages in a conversation
|
|
112
190
|
* @summary Get conversation history
|
|
@@ -127,6 +205,15 @@ export declare const AIChatApiFactory: (configuration?: Configuration, basePath?
|
|
|
127
205
|
* AIChatApi - object-oriented interface
|
|
128
206
|
*/
|
|
129
207
|
export declare class AIChatApi extends BaseAPI {
|
|
208
|
+
/**
|
|
209
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
210
|
+
* @summary Apply a proposed reorganisation plan
|
|
211
|
+
* @param {string} planId
|
|
212
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
213
|
+
* @param {*} [options] Override http request option.
|
|
214
|
+
* @throws {RequiredError}
|
|
215
|
+
*/
|
|
216
|
+
apply(planId: string, reorganizationApplyRequest?: ReorganizationApplyRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationApplyResult, any, {}, any>>;
|
|
130
217
|
/**
|
|
131
218
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
132
219
|
* @summary Chat with AI assistant
|
|
@@ -143,6 +230,22 @@ export declare class AIChatApi extends BaseAPI {
|
|
|
143
230
|
* @throws {RequiredError}
|
|
144
231
|
*/
|
|
145
232
|
deleteConversation(conversationId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}, any>>;
|
|
233
|
+
/**
|
|
234
|
+
*
|
|
235
|
+
* @summary Discard a proposed reorganisation plan
|
|
236
|
+
* @param {string} planId
|
|
237
|
+
* @param {*} [options] Override http request option.
|
|
238
|
+
* @throws {RequiredError}
|
|
239
|
+
*/
|
|
240
|
+
discard(planId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
|
|
241
|
+
/**
|
|
242
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
243
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
244
|
+
* @param {string} planId
|
|
245
|
+
* @param {*} [options] Override http request option.
|
|
246
|
+
* @throws {RequiredError}
|
|
247
|
+
*/
|
|
248
|
+
get4(planId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<ReorganizationPlanView, any, {}, any>>;
|
|
146
249
|
/**
|
|
147
250
|
* Get all messages in a conversation
|
|
148
251
|
* @summary Get conversation history
|
package/dist/api/aichat-api.js
CHANGED
|
@@ -34,6 +34,42 @@ const base_1 = require("../base");
|
|
|
34
34
|
*/
|
|
35
35
|
const AIChatApiAxiosParamCreator = function (configuration) {
|
|
36
36
|
return {
|
|
37
|
+
/**
|
|
38
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
39
|
+
* @summary Apply a proposed reorganisation plan
|
|
40
|
+
* @param {string} planId
|
|
41
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
apply: (planId_1, reorganizationApplyRequest_1, ...args_1) => __awaiter(this, [planId_1, reorganizationApplyRequest_1, ...args_1], void 0, function* (planId, reorganizationApplyRequest, options = {}) {
|
|
46
|
+
// verify required parameter 'planId' is not null or undefined
|
|
47
|
+
(0, common_1.assertParamExists)('apply', 'planId', planId);
|
|
48
|
+
const localVarPath = `/api/v1/ai/reorganization/{planId}/apply`
|
|
49
|
+
.replace('{planId}', encodeURIComponent(String(planId)));
|
|
50
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
52
|
+
let baseOptions;
|
|
53
|
+
if (configuration) {
|
|
54
|
+
baseOptions = configuration.baseOptions;
|
|
55
|
+
}
|
|
56
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
57
|
+
const localVarHeaderParameter = {};
|
|
58
|
+
const localVarQueryParameter = {};
|
|
59
|
+
// authentication keycloak_auth required
|
|
60
|
+
// http bearer authentication required
|
|
61
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
62
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
63
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
64
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
65
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
67
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(reorganizationApplyRequest, localVarRequestOptions, configuration);
|
|
68
|
+
return {
|
|
69
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
70
|
+
options: localVarRequestOptions,
|
|
71
|
+
};
|
|
72
|
+
}),
|
|
37
73
|
/**
|
|
38
74
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
39
75
|
* @summary Chat with AI assistant
|
|
@@ -100,6 +136,72 @@ const AIChatApiAxiosParamCreator = function (configuration) {
|
|
|
100
136
|
options: localVarRequestOptions,
|
|
101
137
|
};
|
|
102
138
|
}),
|
|
139
|
+
/**
|
|
140
|
+
*
|
|
141
|
+
* @summary Discard a proposed reorganisation plan
|
|
142
|
+
* @param {string} planId
|
|
143
|
+
* @param {*} [options] Override http request option.
|
|
144
|
+
* @throws {RequiredError}
|
|
145
|
+
*/
|
|
146
|
+
discard: (planId_1, ...args_1) => __awaiter(this, [planId_1, ...args_1], void 0, function* (planId, options = {}) {
|
|
147
|
+
// verify required parameter 'planId' is not null or undefined
|
|
148
|
+
(0, common_1.assertParamExists)('discard', 'planId', planId);
|
|
149
|
+
const localVarPath = `/api/v1/ai/reorganization/{planId}/discard`
|
|
150
|
+
.replace('{planId}', encodeURIComponent(String(planId)));
|
|
151
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
152
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
153
|
+
let baseOptions;
|
|
154
|
+
if (configuration) {
|
|
155
|
+
baseOptions = configuration.baseOptions;
|
|
156
|
+
}
|
|
157
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
158
|
+
const localVarHeaderParameter = {};
|
|
159
|
+
const localVarQueryParameter = {};
|
|
160
|
+
// authentication keycloak_auth required
|
|
161
|
+
// http bearer authentication required
|
|
162
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
163
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
164
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
165
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
166
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
167
|
+
return {
|
|
168
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
169
|
+
options: localVarRequestOptions,
|
|
170
|
+
};
|
|
171
|
+
}),
|
|
172
|
+
/**
|
|
173
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
174
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
175
|
+
* @param {string} planId
|
|
176
|
+
* @param {*} [options] Override http request option.
|
|
177
|
+
* @throws {RequiredError}
|
|
178
|
+
*/
|
|
179
|
+
get4: (planId_1, ...args_1) => __awaiter(this, [planId_1, ...args_1], void 0, function* (planId, options = {}) {
|
|
180
|
+
// verify required parameter 'planId' is not null or undefined
|
|
181
|
+
(0, common_1.assertParamExists)('get4', 'planId', planId);
|
|
182
|
+
const localVarPath = `/api/v1/ai/reorganization/{planId}`
|
|
183
|
+
.replace('{planId}', encodeURIComponent(String(planId)));
|
|
184
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
185
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
186
|
+
let baseOptions;
|
|
187
|
+
if (configuration) {
|
|
188
|
+
baseOptions = configuration.baseOptions;
|
|
189
|
+
}
|
|
190
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
191
|
+
const localVarHeaderParameter = {};
|
|
192
|
+
const localVarQueryParameter = {};
|
|
193
|
+
// authentication keycloak_auth required
|
|
194
|
+
// http bearer authentication required
|
|
195
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
196
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
197
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
198
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
199
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
200
|
+
return {
|
|
201
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
202
|
+
options: localVarRequestOptions,
|
|
203
|
+
};
|
|
204
|
+
}),
|
|
103
205
|
/**
|
|
104
206
|
* Get all messages in a conversation
|
|
105
207
|
* @summary Get conversation history
|
|
@@ -171,6 +273,23 @@ exports.AIChatApiAxiosParamCreator = AIChatApiAxiosParamCreator;
|
|
|
171
273
|
const AIChatApiFp = function (configuration) {
|
|
172
274
|
const localVarAxiosParamCreator = (0, exports.AIChatApiAxiosParamCreator)(configuration);
|
|
173
275
|
return {
|
|
276
|
+
/**
|
|
277
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
278
|
+
* @summary Apply a proposed reorganisation plan
|
|
279
|
+
* @param {string} planId
|
|
280
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
281
|
+
* @param {*} [options] Override http request option.
|
|
282
|
+
* @throws {RequiredError}
|
|
283
|
+
*/
|
|
284
|
+
apply(planId, reorganizationApplyRequest, options) {
|
|
285
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
286
|
+
var _a, _b, _c;
|
|
287
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.apply(planId, reorganizationApplyRequest, options);
|
|
288
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
289
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIChatApi.apply']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
290
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
291
|
+
});
|
|
292
|
+
},
|
|
174
293
|
/**
|
|
175
294
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
176
295
|
* @summary Chat with AI assistant
|
|
@@ -203,6 +322,38 @@ const AIChatApiFp = function (configuration) {
|
|
|
203
322
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
204
323
|
});
|
|
205
324
|
},
|
|
325
|
+
/**
|
|
326
|
+
*
|
|
327
|
+
* @summary Discard a proposed reorganisation plan
|
|
328
|
+
* @param {string} planId
|
|
329
|
+
* @param {*} [options] Override http request option.
|
|
330
|
+
* @throws {RequiredError}
|
|
331
|
+
*/
|
|
332
|
+
discard(planId, options) {
|
|
333
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
334
|
+
var _a, _b, _c;
|
|
335
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.discard(planId, options);
|
|
336
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
337
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIChatApi.discard']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
338
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
339
|
+
});
|
|
340
|
+
},
|
|
341
|
+
/**
|
|
342
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
343
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
344
|
+
* @param {string} planId
|
|
345
|
+
* @param {*} [options] Override http request option.
|
|
346
|
+
* @throws {RequiredError}
|
|
347
|
+
*/
|
|
348
|
+
get4(planId, options) {
|
|
349
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
350
|
+
var _a, _b, _c;
|
|
351
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.get4(planId, options);
|
|
352
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
353
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['AIChatApi.get4']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
354
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
355
|
+
});
|
|
356
|
+
},
|
|
206
357
|
/**
|
|
207
358
|
* Get all messages in a conversation
|
|
208
359
|
* @summary Get conversation history
|
|
@@ -243,6 +394,17 @@ exports.AIChatApiFp = AIChatApiFp;
|
|
|
243
394
|
const AIChatApiFactory = function (configuration, basePath, axios) {
|
|
244
395
|
const localVarFp = (0, exports.AIChatApiFp)(configuration);
|
|
245
396
|
return {
|
|
397
|
+
/**
|
|
398
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
399
|
+
* @summary Apply a proposed reorganisation plan
|
|
400
|
+
* @param {string} planId
|
|
401
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
402
|
+
* @param {*} [options] Override http request option.
|
|
403
|
+
* @throws {RequiredError}
|
|
404
|
+
*/
|
|
405
|
+
apply(planId, reorganizationApplyRequest, options) {
|
|
406
|
+
return localVarFp.apply(planId, reorganizationApplyRequest, options).then((request) => request(axios, basePath));
|
|
407
|
+
},
|
|
246
408
|
/**
|
|
247
409
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
248
410
|
* @summary Chat with AI assistant
|
|
@@ -263,6 +425,26 @@ const AIChatApiFactory = function (configuration, basePath, axios) {
|
|
|
263
425
|
deleteConversation(conversationId, options) {
|
|
264
426
|
return localVarFp.deleteConversation(conversationId, options).then((request) => request(axios, basePath));
|
|
265
427
|
},
|
|
428
|
+
/**
|
|
429
|
+
*
|
|
430
|
+
* @summary Discard a proposed reorganisation plan
|
|
431
|
+
* @param {string} planId
|
|
432
|
+
* @param {*} [options] Override http request option.
|
|
433
|
+
* @throws {RequiredError}
|
|
434
|
+
*/
|
|
435
|
+
discard(planId, options) {
|
|
436
|
+
return localVarFp.discard(planId, options).then((request) => request(axios, basePath));
|
|
437
|
+
},
|
|
438
|
+
/**
|
|
439
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
440
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
441
|
+
* @param {string} planId
|
|
442
|
+
* @param {*} [options] Override http request option.
|
|
443
|
+
* @throws {RequiredError}
|
|
444
|
+
*/
|
|
445
|
+
get4(planId, options) {
|
|
446
|
+
return localVarFp.get4(planId, options).then((request) => request(axios, basePath));
|
|
447
|
+
},
|
|
266
448
|
/**
|
|
267
449
|
* Get all messages in a conversation
|
|
268
450
|
* @summary Get conversation history
|
|
@@ -289,6 +471,17 @@ exports.AIChatApiFactory = AIChatApiFactory;
|
|
|
289
471
|
* AIChatApi - object-oriented interface
|
|
290
472
|
*/
|
|
291
473
|
class AIChatApi extends base_1.BaseAPI {
|
|
474
|
+
/**
|
|
475
|
+
* Creates the missing folders and moves the selected items (all applicable items when none is given).
|
|
476
|
+
* @summary Apply a proposed reorganisation plan
|
|
477
|
+
* @param {string} planId
|
|
478
|
+
* @param {ReorganizationApplyRequest} [reorganizationApplyRequest]
|
|
479
|
+
* @param {*} [options] Override http request option.
|
|
480
|
+
* @throws {RequiredError}
|
|
481
|
+
*/
|
|
482
|
+
apply(planId, reorganizationApplyRequest, options) {
|
|
483
|
+
return (0, exports.AIChatApiFp)(this.configuration).apply(planId, reorganizationApplyRequest, options).then((request) => request(this.axios, this.basePath));
|
|
484
|
+
}
|
|
292
485
|
/**
|
|
293
486
|
* Send a message and receive a streaming response. The AI can answer questions about documents, search, summarize, and reorganize files.
|
|
294
487
|
* @summary Chat with AI assistant
|
|
@@ -309,6 +502,26 @@ class AIChatApi extends base_1.BaseAPI {
|
|
|
309
502
|
deleteConversation(conversationId, options) {
|
|
310
503
|
return (0, exports.AIChatApiFp)(this.configuration).deleteConversation(conversationId, options).then((request) => request(this.axios, this.basePath));
|
|
311
504
|
}
|
|
505
|
+
/**
|
|
506
|
+
*
|
|
507
|
+
* @summary Discard a proposed reorganisation plan
|
|
508
|
+
* @param {string} planId
|
|
509
|
+
* @param {*} [options] Override http request option.
|
|
510
|
+
* @throws {RequiredError}
|
|
511
|
+
*/
|
|
512
|
+
discard(planId, options) {
|
|
513
|
+
return (0, exports.AIChatApiFp)(this.configuration).discard(planId, options).then((request) => request(this.axios, this.basePath));
|
|
514
|
+
}
|
|
515
|
+
/**
|
|
516
|
+
* The plan\'s items (what moves where), which are applicable, and its status.
|
|
517
|
+
* @summary Get a reorganisation plan proposed by the AI assistant
|
|
518
|
+
* @param {string} planId
|
|
519
|
+
* @param {*} [options] Override http request option.
|
|
520
|
+
* @throws {RequiredError}
|
|
521
|
+
*/
|
|
522
|
+
get4(planId, options) {
|
|
523
|
+
return (0, exports.AIChatApiFp)(this.configuration).get4(planId, options).then((request) => request(this.axios, this.basePath));
|
|
524
|
+
}
|
|
312
525
|
/**
|
|
313
526
|
* Get all messages in a conversation
|
|
314
527
|
* @summary Get conversation history
|
|
@@ -147,22 +147,24 @@ export declare const DocumentControllerApiAxiosParamCreator: (configuration?: Co
|
|
|
147
147
|
* @summary Upload multiple documents
|
|
148
148
|
* @param {Array<File>} file
|
|
149
149
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
150
|
+
* @param {boolean} [autoFile] 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.
|
|
150
151
|
* @param {string} [parametersByFilename] 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>
|
|
151
152
|
* @param {*} [options] Override http request option.
|
|
152
153
|
* @throws {RequiredError}
|
|
153
154
|
*/
|
|
154
|
-
uploadDocument: (file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
155
|
+
uploadDocument: (file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
155
156
|
/**
|
|
156
157
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
157
158
|
* @summary Upload a single document
|
|
158
159
|
* @param {File} file
|
|
159
160
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
161
|
+
* @param {boolean} [autoFile] 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.
|
|
160
162
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
161
163
|
* @param {string} [metadata]
|
|
162
164
|
* @param {*} [options] Override http request option.
|
|
163
165
|
* @throws {RequiredError}
|
|
164
166
|
*/
|
|
165
|
-
uploadDocument1: (file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
167
|
+
uploadDocument1: (file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
166
168
|
};
|
|
167
169
|
/**
|
|
168
170
|
* DocumentControllerApi - functional programming interface
|
|
@@ -291,22 +293,24 @@ export declare const DocumentControllerApiFp: (configuration?: Configuration) =>
|
|
|
291
293
|
* @summary Upload multiple documents
|
|
292
294
|
* @param {Array<File>} file
|
|
293
295
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
296
|
+
* @param {boolean} [autoFile] 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.
|
|
294
297
|
* @param {string} [parametersByFilename] 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>
|
|
295
298
|
* @param {*} [options] Override http request option.
|
|
296
299
|
* @throws {RequiredError}
|
|
297
300
|
*/
|
|
298
|
-
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>>;
|
|
301
|
+
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>>;
|
|
299
302
|
/**
|
|
300
303
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
301
304
|
* @summary Upload a single document
|
|
302
305
|
* @param {File} file
|
|
303
306
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
307
|
+
* @param {boolean} [autoFile] 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.
|
|
304
308
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
305
309
|
* @param {string} [metadata]
|
|
306
310
|
* @param {*} [options] Override http request option.
|
|
307
311
|
* @throws {RequiredError}
|
|
308
312
|
*/
|
|
309
|
-
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>>;
|
|
313
|
+
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>>;
|
|
310
314
|
};
|
|
311
315
|
/**
|
|
312
316
|
* DocumentControllerApi - factory interface
|
|
@@ -435,22 +439,24 @@ export declare const DocumentControllerApiFactory: (configuration?: Configuratio
|
|
|
435
439
|
* @summary Upload multiple documents
|
|
436
440
|
* @param {Array<File>} file
|
|
437
441
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
442
|
+
* @param {boolean} [autoFile] 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.
|
|
438
443
|
* @param {string} [parametersByFilename] 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>
|
|
439
444
|
* @param {*} [options] Override http request option.
|
|
440
445
|
* @throws {RequiredError}
|
|
441
446
|
*/
|
|
442
|
-
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>>;
|
|
447
|
+
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>>;
|
|
443
448
|
/**
|
|
444
449
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
445
450
|
* @summary Upload a single document
|
|
446
451
|
* @param {File} file
|
|
447
452
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
453
|
+
* @param {boolean} [autoFile] 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.
|
|
448
454
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
449
455
|
* @param {string} [metadata]
|
|
450
456
|
* @param {*} [options] Override http request option.
|
|
451
457
|
* @throws {RequiredError}
|
|
452
458
|
*/
|
|
453
|
-
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse>;
|
|
459
|
+
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse>;
|
|
454
460
|
};
|
|
455
461
|
/**
|
|
456
462
|
* DocumentControllerApi - object-oriented interface
|
|
@@ -579,20 +585,22 @@ export declare class DocumentControllerApi extends BaseAPI {
|
|
|
579
585
|
* @summary Upload multiple documents
|
|
580
586
|
* @param {Array<File>} file
|
|
581
587
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
588
|
+
* @param {boolean} [autoFile] 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.
|
|
582
589
|
* @param {string} [parametersByFilename] 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>
|
|
583
590
|
* @param {*} [options] Override http request option.
|
|
584
591
|
* @throws {RequiredError}
|
|
585
592
|
*/
|
|
586
|
-
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse[], any, {}, any>>;
|
|
593
|
+
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse[], any, {}, any>>;
|
|
587
594
|
/**
|
|
588
595
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
589
596
|
* @summary Upload a single document
|
|
590
597
|
* @param {File} file
|
|
591
598
|
* @param {boolean} [allowDuplicateFileNames] 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)
|
|
599
|
+
* @param {boolean} [autoFile] 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.
|
|
592
600
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
593
601
|
* @param {string} [metadata]
|
|
594
602
|
* @param {*} [options] Override http request option.
|
|
595
603
|
* @throws {RequiredError}
|
|
596
604
|
*/
|
|
597
|
-
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse, any, {}, any>>;
|
|
605
|
+
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<UploadResponse, any, {}, any>>;
|
|
598
606
|
}
|