@openfilz-sdk/typescript-ee 1.9.6 → 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 +22 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +23 -4
- package/api/aichat-api.ts +9 -9
- 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 +4 -4
- package/dist/api/aichat-api.js +9 -9
- 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 +4 -4
- package/dist/esm/api/aichat-api.js +9 -9
- 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 +9 -0
- package/dist/esm/models/index.js +9 -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/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 +9 -0
- package/dist/models/index.js +9 -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/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 +4 -4
- 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/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 +9 -0
- package/models/insight-backfill-request.ts +21 -0
- package/models/insight-backfill-status.ts +29 -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
|
@@ -173,9 +173,9 @@ export const AIChatApiAxiosParamCreator = function (configuration) {
|
|
|
173
173
|
* @param {*} [options] Override http request option.
|
|
174
174
|
* @throws {RequiredError}
|
|
175
175
|
*/
|
|
176
|
-
|
|
176
|
+
get4: (planId_1, ...args_1) => __awaiter(this, [planId_1, ...args_1], void 0, function* (planId, options = {}) {
|
|
177
177
|
// verify required parameter 'planId' is not null or undefined
|
|
178
|
-
assertParamExists('
|
|
178
|
+
assertParamExists('get4', 'planId', planId);
|
|
179
179
|
const localVarPath = `/api/v1/ai/reorganization/{planId}`
|
|
180
180
|
.replace('{planId}', encodeURIComponent(String(planId)));
|
|
181
181
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -341,12 +341,12 @@ export const AIChatApiFp = function (configuration) {
|
|
|
341
341
|
* @param {*} [options] Override http request option.
|
|
342
342
|
* @throws {RequiredError}
|
|
343
343
|
*/
|
|
344
|
-
|
|
344
|
+
get4(planId, options) {
|
|
345
345
|
return __awaiter(this, void 0, void 0, function* () {
|
|
346
346
|
var _a, _b, _c;
|
|
347
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.
|
|
347
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.get4(planId, options);
|
|
348
348
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
349
|
-
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIChatApi.
|
|
349
|
+
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['AIChatApi.get4']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
350
350
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
351
351
|
});
|
|
352
352
|
},
|
|
@@ -437,8 +437,8 @@ export const AIChatApiFactory = function (configuration, basePath, axios) {
|
|
|
437
437
|
* @param {*} [options] Override http request option.
|
|
438
438
|
* @throws {RequiredError}
|
|
439
439
|
*/
|
|
440
|
-
|
|
441
|
-
return localVarFp.
|
|
440
|
+
get4(planId, options) {
|
|
441
|
+
return localVarFp.get4(planId, options).then((request) => request(axios, basePath));
|
|
442
442
|
},
|
|
443
443
|
/**
|
|
444
444
|
* Get all messages in a conversation
|
|
@@ -513,8 +513,8 @@ export class AIChatApi extends BaseAPI {
|
|
|
513
513
|
* @param {*} [options] Override http request option.
|
|
514
514
|
* @throws {RequiredError}
|
|
515
515
|
*/
|
|
516
|
-
|
|
517
|
-
return AIChatApiFp(this.configuration).
|
|
516
|
+
get4(planId, options) {
|
|
517
|
+
return AIChatApiFp(this.configuration).get4(planId, options).then((request) => request(this.axios, this.basePath));
|
|
518
518
|
}
|
|
519
519
|
/**
|
|
520
520
|
* Get all messages in a conversation
|
|
@@ -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
|
}
|
|
@@ -516,11 +516,12 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
516
516
|
* @summary Upload multiple documents
|
|
517
517
|
* @param {Array<File>} file
|
|
518
518
|
* @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)
|
|
519
|
+
* @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.
|
|
519
520
|
* @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>
|
|
520
521
|
* @param {*} [options] Override http request option.
|
|
521
522
|
* @throws {RequiredError}
|
|
522
523
|
*/
|
|
523
|
-
uploadDocument: (file_1, allowDuplicateFileNames_1, parametersByFilename_1, ...args_1) => __awaiter(this, [file_1, allowDuplicateFileNames_1, parametersByFilename_1, ...args_1], void 0, function* (file, allowDuplicateFileNames, parametersByFilename, options = {}) {
|
|
524
|
+
uploadDocument: (file_1, allowDuplicateFileNames_1, autoFile_1, parametersByFilename_1, ...args_1) => __awaiter(this, [file_1, allowDuplicateFileNames_1, autoFile_1, parametersByFilename_1, ...args_1], void 0, function* (file, allowDuplicateFileNames, autoFile, parametersByFilename, options = {}) {
|
|
524
525
|
// verify required parameter 'file' is not null or undefined
|
|
525
526
|
assertParamExists('uploadDocument', 'file', file);
|
|
526
527
|
const localVarPath = `/api/v1/documents/upload-multiple`;
|
|
@@ -540,6 +541,9 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
540
541
|
if (allowDuplicateFileNames !== undefined) {
|
|
541
542
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
542
543
|
}
|
|
544
|
+
if (autoFile !== undefined) {
|
|
545
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
546
|
+
}
|
|
543
547
|
if (file) {
|
|
544
548
|
file.forEach((element) => {
|
|
545
549
|
localVarFormParams.append('file', element);
|
|
@@ -564,12 +568,13 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
564
568
|
* @summary Upload a single document
|
|
565
569
|
* @param {File} file
|
|
566
570
|
* @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)
|
|
571
|
+
* @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.
|
|
567
572
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
568
573
|
* @param {string} [metadata]
|
|
569
574
|
* @param {*} [options] Override http request option.
|
|
570
575
|
* @throws {RequiredError}
|
|
571
576
|
*/
|
|
572
|
-
uploadDocument1: (file_1, allowDuplicateFileNames_1, parentFolderId_1, metadata_1, ...args_1) => __awaiter(this, [file_1, allowDuplicateFileNames_1, parentFolderId_1, metadata_1, ...args_1], void 0, function* (file, allowDuplicateFileNames, parentFolderId, metadata, options = {}) {
|
|
577
|
+
uploadDocument1: (file_1, allowDuplicateFileNames_1, autoFile_1, parentFolderId_1, metadata_1, ...args_1) => __awaiter(this, [file_1, allowDuplicateFileNames_1, autoFile_1, parentFolderId_1, metadata_1, ...args_1], void 0, function* (file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options = {}) {
|
|
573
578
|
// verify required parameter 'file' is not null or undefined
|
|
574
579
|
assertParamExists('uploadDocument1', 'file', file);
|
|
575
580
|
const localVarPath = `/api/v1/documents/upload`;
|
|
@@ -589,6 +594,9 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
589
594
|
if (allowDuplicateFileNames !== undefined) {
|
|
590
595
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
591
596
|
}
|
|
597
|
+
if (autoFile !== undefined) {
|
|
598
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
599
|
+
}
|
|
592
600
|
if (file !== undefined) {
|
|
593
601
|
localVarFormParams.append('file', file);
|
|
594
602
|
}
|
|
@@ -840,14 +848,15 @@ export const DocumentControllerApiFp = function (configuration) {
|
|
|
840
848
|
* @summary Upload multiple documents
|
|
841
849
|
* @param {Array<File>} file
|
|
842
850
|
* @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)
|
|
851
|
+
* @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.
|
|
843
852
|
* @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>
|
|
844
853
|
* @param {*} [options] Override http request option.
|
|
845
854
|
* @throws {RequiredError}
|
|
846
855
|
*/
|
|
847
|
-
uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options) {
|
|
856
|
+
uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options) {
|
|
848
857
|
return __awaiter(this, void 0, void 0, function* () {
|
|
849
858
|
var _a, _b, _c;
|
|
850
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options);
|
|
859
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options);
|
|
851
860
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
852
861
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentControllerApi.uploadDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
853
862
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -858,15 +867,16 @@ export const DocumentControllerApiFp = function (configuration) {
|
|
|
858
867
|
* @summary Upload a single document
|
|
859
868
|
* @param {File} file
|
|
860
869
|
* @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)
|
|
870
|
+
* @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.
|
|
861
871
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
862
872
|
* @param {string} [metadata]
|
|
863
873
|
* @param {*} [options] Override http request option.
|
|
864
874
|
* @throws {RequiredError}
|
|
865
875
|
*/
|
|
866
|
-
uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options) {
|
|
876
|
+
uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options) {
|
|
867
877
|
return __awaiter(this, void 0, void 0, function* () {
|
|
868
878
|
var _a, _b, _c;
|
|
869
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options);
|
|
879
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options);
|
|
870
880
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
871
881
|
const localVarOperationServerBasePath = (_c = (_b = operationServerMap['DocumentControllerApi.uploadDocument1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
872
882
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1025,25 +1035,27 @@ export const DocumentControllerApiFactory = function (configuration, basePath, a
|
|
|
1025
1035
|
* @summary Upload multiple documents
|
|
1026
1036
|
* @param {Array<File>} file
|
|
1027
1037
|
* @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)
|
|
1038
|
+
* @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.
|
|
1028
1039
|
* @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>
|
|
1029
1040
|
* @param {*} [options] Override http request option.
|
|
1030
1041
|
* @throws {RequiredError}
|
|
1031
1042
|
*/
|
|
1032
|
-
uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options) {
|
|
1033
|
-
return localVarFp.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1043
|
+
uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options) {
|
|
1044
|
+
return localVarFp.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1034
1045
|
},
|
|
1035
1046
|
/**
|
|
1036
1047
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1037
1048
|
* @summary Upload a single document
|
|
1038
1049
|
* @param {File} file
|
|
1039
1050
|
* @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)
|
|
1051
|
+
* @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.
|
|
1040
1052
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1041
1053
|
* @param {string} [metadata]
|
|
1042
1054
|
* @param {*} [options] Override http request option.
|
|
1043
1055
|
* @throws {RequiredError}
|
|
1044
1056
|
*/
|
|
1045
|
-
uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options) {
|
|
1046
|
-
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1057
|
+
uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options) {
|
|
1058
|
+
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1047
1059
|
},
|
|
1048
1060
|
};
|
|
1049
1061
|
};
|
|
@@ -1196,24 +1208,26 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1196
1208
|
* @summary Upload multiple documents
|
|
1197
1209
|
* @param {Array<File>} file
|
|
1198
1210
|
* @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)
|
|
1211
|
+
* @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.
|
|
1199
1212
|
* @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>
|
|
1200
1213
|
* @param {*} [options] Override http request option.
|
|
1201
1214
|
* @throws {RequiredError}
|
|
1202
1215
|
*/
|
|
1203
|
-
uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options) {
|
|
1204
|
-
return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1216
|
+
uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options) {
|
|
1217
|
+
return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1205
1218
|
}
|
|
1206
1219
|
/**
|
|
1207
1220
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1208
1221
|
* @summary Upload a single document
|
|
1209
1222
|
* @param {File} file
|
|
1210
1223
|
* @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)
|
|
1224
|
+
* @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.
|
|
1211
1225
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1212
1226
|
* @param {string} [metadata]
|
|
1213
1227
|
* @param {*} [options] Override http request option.
|
|
1214
1228
|
* @throws {RequiredError}
|
|
1215
1229
|
*/
|
|
1216
|
-
uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options) {
|
|
1217
|
-
return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1230
|
+
uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options) {
|
|
1231
|
+
return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1218
1232
|
}
|
|
1219
1233
|
}
|
|
@@ -0,0 +1,133 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* openfilz-api
|
|
3
|
+
* API for Document Management System
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 1.0.0
|
|
6
|
+
*
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import type { Configuration } from '../configuration';
|
|
13
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
|
+
import { type RequestArgs, BaseAPI } from '../base';
|
|
15
|
+
import type { DocumentInsightView } from '../models';
|
|
16
|
+
import type { InsightBackfillRequest } from '../models';
|
|
17
|
+
import type { InsightBackfillStatus } from '../models';
|
|
18
|
+
/**
|
|
19
|
+
* DocumentInsightsApi - axios parameter creator
|
|
20
|
+
*/
|
|
21
|
+
export declare const DocumentInsightsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
22
|
+
/**
|
|
23
|
+
* Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
|
|
24
|
+
* @summary Enrich existing documents
|
|
25
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
26
|
+
* @param {*} [options] Override http request option.
|
|
27
|
+
* @throws {RequiredError}
|
|
28
|
+
*/
|
|
29
|
+
backfill: (insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
30
|
+
/**
|
|
31
|
+
*
|
|
32
|
+
* @summary Progress of a backfill job
|
|
33
|
+
* @param {string} jobId
|
|
34
|
+
* @param {*} [options] Override http request option.
|
|
35
|
+
* @throws {RequiredError}
|
|
36
|
+
*/
|
|
37
|
+
backfillStatus: (jobId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
38
|
+
/**
|
|
39
|
+
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
40
|
+
* @summary Get the insights of a document
|
|
41
|
+
* @param {string} documentId
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
getInsights: (documentId: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
46
|
+
};
|
|
47
|
+
/**
|
|
48
|
+
* DocumentInsightsApi - functional programming interface
|
|
49
|
+
*/
|
|
50
|
+
export declare const DocumentInsightsApiFp: (configuration?: Configuration) => {
|
|
51
|
+
/**
|
|
52
|
+
* Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
|
|
53
|
+
* @summary Enrich existing documents
|
|
54
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
55
|
+
* @param {*} [options] Override http request option.
|
|
56
|
+
* @throws {RequiredError}
|
|
57
|
+
*/
|
|
58
|
+
backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
|
|
59
|
+
/**
|
|
60
|
+
*
|
|
61
|
+
* @summary Progress of a backfill job
|
|
62
|
+
* @param {string} jobId
|
|
63
|
+
* @param {*} [options] Override http request option.
|
|
64
|
+
* @throws {RequiredError}
|
|
65
|
+
*/
|
|
66
|
+
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>>;
|
|
67
|
+
/**
|
|
68
|
+
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
69
|
+
* @summary Get the insights of a document
|
|
70
|
+
* @param {string} documentId
|
|
71
|
+
* @param {*} [options] Override http request option.
|
|
72
|
+
* @throws {RequiredError}
|
|
73
|
+
*/
|
|
74
|
+
getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>>;
|
|
75
|
+
};
|
|
76
|
+
/**
|
|
77
|
+
* DocumentInsightsApi - factory interface
|
|
78
|
+
*/
|
|
79
|
+
export declare const DocumentInsightsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
80
|
+
/**
|
|
81
|
+
* Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
|
|
82
|
+
* @summary Enrich existing documents
|
|
83
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
84
|
+
* @param {*} [options] Override http request option.
|
|
85
|
+
* @throws {RequiredError}
|
|
86
|
+
*/
|
|
87
|
+
backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
|
|
88
|
+
/**
|
|
89
|
+
*
|
|
90
|
+
* @summary Progress of a backfill job
|
|
91
|
+
* @param {string} jobId
|
|
92
|
+
* @param {*} [options] Override http request option.
|
|
93
|
+
* @throws {RequiredError}
|
|
94
|
+
*/
|
|
95
|
+
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus>;
|
|
96
|
+
/**
|
|
97
|
+
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
98
|
+
* @summary Get the insights of a document
|
|
99
|
+
* @param {string} documentId
|
|
100
|
+
* @param {*} [options] Override http request option.
|
|
101
|
+
* @throws {RequiredError}
|
|
102
|
+
*/
|
|
103
|
+
getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView>;
|
|
104
|
+
};
|
|
105
|
+
/**
|
|
106
|
+
* DocumentInsightsApi - object-oriented interface
|
|
107
|
+
*/
|
|
108
|
+
export declare class DocumentInsightsApi extends BaseAPI {
|
|
109
|
+
/**
|
|
110
|
+
* Queues every FILE without a tier-2 insight (or with an older prompt version when force), optionally under one folder, and returns the job at once. Poll GET /backfill/{jobId}.
|
|
111
|
+
* @summary Enrich existing documents
|
|
112
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
113
|
+
* @param {*} [options] Override http request option.
|
|
114
|
+
* @throws {RequiredError}
|
|
115
|
+
*/
|
|
116
|
+
backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, any, {}, any>>;
|
|
117
|
+
/**
|
|
118
|
+
*
|
|
119
|
+
* @summary Progress of a backfill job
|
|
120
|
+
* @param {string} jobId
|
|
121
|
+
* @param {*} [options] Override http request option.
|
|
122
|
+
* @throws {RequiredError}
|
|
123
|
+
*/
|
|
124
|
+
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<InsightBackfillStatus, any, {}, any>>;
|
|
125
|
+
/**
|
|
126
|
+
* Tier 1: the file\'s own metadata (title, author, dates, page count, language) captured at upload. Tier 2: the AI-derived category, summary, keywords and entities when openfilz.ai.insights.active is on. 404 when the document is not visible or has no insights yet.
|
|
127
|
+
* @summary Get the insights of a document
|
|
128
|
+
* @param {string} documentId
|
|
129
|
+
* @param {*} [options] Override http request option.
|
|
130
|
+
* @throws {RequiredError}
|
|
131
|
+
*/
|
|
132
|
+
getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<DocumentInsightView, any, {}, any>>;
|
|
133
|
+
}
|