@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
|
@@ -519,11 +519,12 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
519
519
|
* @summary Upload multiple documents
|
|
520
520
|
* @param {Array<File>} file
|
|
521
521
|
* @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)
|
|
522
|
+
* @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.
|
|
522
523
|
* @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>
|
|
523
524
|
* @param {*} [options] Override http request option.
|
|
524
525
|
* @throws {RequiredError}
|
|
525
526
|
*/
|
|
526
|
-
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 = {}) {
|
|
527
|
+
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 = {}) {
|
|
527
528
|
// verify required parameter 'file' is not null or undefined
|
|
528
529
|
(0, common_1.assertParamExists)('uploadDocument', 'file', file);
|
|
529
530
|
const localVarPath = `/api/v1/documents/upload-multiple`;
|
|
@@ -543,6 +544,9 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
543
544
|
if (allowDuplicateFileNames !== undefined) {
|
|
544
545
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
545
546
|
}
|
|
547
|
+
if (autoFile !== undefined) {
|
|
548
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
549
|
+
}
|
|
546
550
|
if (file) {
|
|
547
551
|
file.forEach((element) => {
|
|
548
552
|
localVarFormParams.append('file', element);
|
|
@@ -567,12 +571,13 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
567
571
|
* @summary Upload a single document
|
|
568
572
|
* @param {File} file
|
|
569
573
|
* @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)
|
|
574
|
+
* @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.
|
|
570
575
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
571
576
|
* @param {string} [metadata]
|
|
572
577
|
* @param {*} [options] Override http request option.
|
|
573
578
|
* @throws {RequiredError}
|
|
574
579
|
*/
|
|
575
|
-
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 = {}) {
|
|
580
|
+
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 = {}) {
|
|
576
581
|
// verify required parameter 'file' is not null or undefined
|
|
577
582
|
(0, common_1.assertParamExists)('uploadDocument1', 'file', file);
|
|
578
583
|
const localVarPath = `/api/v1/documents/upload`;
|
|
@@ -592,6 +597,9 @@ const DocumentControllerApiAxiosParamCreator = function (configuration) {
|
|
|
592
597
|
if (allowDuplicateFileNames !== undefined) {
|
|
593
598
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
594
599
|
}
|
|
600
|
+
if (autoFile !== undefined) {
|
|
601
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
602
|
+
}
|
|
595
603
|
if (file !== undefined) {
|
|
596
604
|
localVarFormParams.append('file', file);
|
|
597
605
|
}
|
|
@@ -844,14 +852,15 @@ const DocumentControllerApiFp = function (configuration) {
|
|
|
844
852
|
* @summary Upload multiple documents
|
|
845
853
|
* @param {Array<File>} file
|
|
846
854
|
* @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)
|
|
855
|
+
* @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.
|
|
847
856
|
* @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>
|
|
848
857
|
* @param {*} [options] Override http request option.
|
|
849
858
|
* @throws {RequiredError}
|
|
850
859
|
*/
|
|
851
|
-
uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options) {
|
|
860
|
+
uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options) {
|
|
852
861
|
return __awaiter(this, void 0, void 0, function* () {
|
|
853
862
|
var _a, _b, _c;
|
|
854
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options);
|
|
863
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options);
|
|
855
864
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
856
865
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentControllerApi.uploadDocument']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
857
866
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -862,15 +871,16 @@ const DocumentControllerApiFp = function (configuration) {
|
|
|
862
871
|
* @summary Upload a single document
|
|
863
872
|
* @param {File} file
|
|
864
873
|
* @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)
|
|
874
|
+
* @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.
|
|
865
875
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
866
876
|
* @param {string} [metadata]
|
|
867
877
|
* @param {*} [options] Override http request option.
|
|
868
878
|
* @throws {RequiredError}
|
|
869
879
|
*/
|
|
870
|
-
uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options) {
|
|
880
|
+
uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options) {
|
|
871
881
|
return __awaiter(this, void 0, void 0, function* () {
|
|
872
882
|
var _a, _b, _c;
|
|
873
|
-
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options);
|
|
883
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options);
|
|
874
884
|
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
875
885
|
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentControllerApi.uploadDocument1']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
876
886
|
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1030,25 +1040,27 @@ const DocumentControllerApiFactory = function (configuration, basePath, axios) {
|
|
|
1030
1040
|
* @summary Upload multiple documents
|
|
1031
1041
|
* @param {Array<File>} file
|
|
1032
1042
|
* @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)
|
|
1043
|
+
* @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.
|
|
1033
1044
|
* @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>
|
|
1034
1045
|
* @param {*} [options] Override http request option.
|
|
1035
1046
|
* @throws {RequiredError}
|
|
1036
1047
|
*/
|
|
1037
|
-
uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options) {
|
|
1038
|
-
return localVarFp.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1048
|
+
uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options) {
|
|
1049
|
+
return localVarFp.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1039
1050
|
},
|
|
1040
1051
|
/**
|
|
1041
1052
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1042
1053
|
* @summary Upload a single document
|
|
1043
1054
|
* @param {File} file
|
|
1044
1055
|
* @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)
|
|
1056
|
+
* @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.
|
|
1045
1057
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1046
1058
|
* @param {string} [metadata]
|
|
1047
1059
|
* @param {*} [options] Override http request option.
|
|
1048
1060
|
* @throws {RequiredError}
|
|
1049
1061
|
*/
|
|
1050
|
-
uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options) {
|
|
1051
|
-
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1062
|
+
uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options) {
|
|
1063
|
+
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1052
1064
|
},
|
|
1053
1065
|
};
|
|
1054
1066
|
};
|
|
@@ -1202,25 +1214,27 @@ class DocumentControllerApi extends base_1.BaseAPI {
|
|
|
1202
1214
|
* @summary Upload multiple documents
|
|
1203
1215
|
* @param {Array<File>} file
|
|
1204
1216
|
* @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)
|
|
1217
|
+
* @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.
|
|
1205
1218
|
* @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>
|
|
1206
1219
|
* @param {*} [options] Override http request option.
|
|
1207
1220
|
* @throws {RequiredError}
|
|
1208
1221
|
*/
|
|
1209
|
-
uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options) {
|
|
1210
|
-
return (0, exports.DocumentControllerApiFp)(this.configuration).uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1222
|
+
uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options) {
|
|
1223
|
+
return (0, exports.DocumentControllerApiFp)(this.configuration).uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1211
1224
|
}
|
|
1212
1225
|
/**
|
|
1213
1226
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1214
1227
|
* @summary Upload a single document
|
|
1215
1228
|
* @param {File} file
|
|
1216
1229
|
* @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)
|
|
1230
|
+
* @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.
|
|
1217
1231
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1218
1232
|
* @param {string} [metadata]
|
|
1219
1233
|
* @param {*} [options] Override http request option.
|
|
1220
1234
|
* @throws {RequiredError}
|
|
1221
1235
|
*/
|
|
1222
|
-
uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options) {
|
|
1223
|
-
return (0, exports.DocumentControllerApiFp)(this.configuration).uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1236
|
+
uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options) {
|
|
1237
|
+
return (0, exports.DocumentControllerApiFp)(this.configuration).uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1224
1238
|
}
|
|
1225
1239
|
}
|
|
1226
1240
|
exports.DocumentControllerApi = DocumentControllerApi;
|
|
@@ -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
|
+
}
|
|
@@ -0,0 +1,269 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* openfilz-api
|
|
6
|
+
* API for Document Management System
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 1.0.0
|
|
9
|
+
*
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
|
|
16
|
+
function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
|
|
17
|
+
return new (P || (P = Promise))(function (resolve, reject) {
|
|
18
|
+
function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
|
|
19
|
+
function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
|
|
20
|
+
function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
|
|
21
|
+
step((generator = generator.apply(thisArg, _arguments || [])).next());
|
|
22
|
+
});
|
|
23
|
+
};
|
|
24
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
25
|
+
exports.DocumentInsightsApi = exports.DocumentInsightsApiFactory = exports.DocumentInsightsApiFp = exports.DocumentInsightsApiAxiosParamCreator = void 0;
|
|
26
|
+
const axios_1 = require("axios");
|
|
27
|
+
// Some imports not used depending on template conditions
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
const common_1 = require("../common");
|
|
30
|
+
// @ts-ignore
|
|
31
|
+
const base_1 = require("../base");
|
|
32
|
+
/**
|
|
33
|
+
* DocumentInsightsApi - axios parameter creator
|
|
34
|
+
*/
|
|
35
|
+
const DocumentInsightsApiAxiosParamCreator = function (configuration) {
|
|
36
|
+
return {
|
|
37
|
+
/**
|
|
38
|
+
* 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}.
|
|
39
|
+
* @summary Enrich existing documents
|
|
40
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
41
|
+
* @param {*} [options] Override http request option.
|
|
42
|
+
* @throws {RequiredError}
|
|
43
|
+
*/
|
|
44
|
+
backfill: (insightBackfillRequest_1, ...args_1) => __awaiter(this, [insightBackfillRequest_1, ...args_1], void 0, function* (insightBackfillRequest, options = {}) {
|
|
45
|
+
const localVarPath = `/api/v1/ai/insights/backfill`;
|
|
46
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
47
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
48
|
+
let baseOptions;
|
|
49
|
+
if (configuration) {
|
|
50
|
+
baseOptions = configuration.baseOptions;
|
|
51
|
+
}
|
|
52
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
|
|
53
|
+
const localVarHeaderParameter = {};
|
|
54
|
+
const localVarQueryParameter = {};
|
|
55
|
+
// authentication keycloak_auth required
|
|
56
|
+
// http bearer authentication required
|
|
57
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
58
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
59
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
60
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
61
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
62
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
63
|
+
localVarRequestOptions.data = (0, common_1.serializeDataIfNeeded)(insightBackfillRequest, localVarRequestOptions, configuration);
|
|
64
|
+
return {
|
|
65
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
66
|
+
options: localVarRequestOptions,
|
|
67
|
+
};
|
|
68
|
+
}),
|
|
69
|
+
/**
|
|
70
|
+
*
|
|
71
|
+
* @summary Progress of a backfill job
|
|
72
|
+
* @param {string} jobId
|
|
73
|
+
* @param {*} [options] Override http request option.
|
|
74
|
+
* @throws {RequiredError}
|
|
75
|
+
*/
|
|
76
|
+
backfillStatus: (jobId_1, ...args_1) => __awaiter(this, [jobId_1, ...args_1], void 0, function* (jobId, options = {}) {
|
|
77
|
+
// verify required parameter 'jobId' is not null or undefined
|
|
78
|
+
(0, common_1.assertParamExists)('backfillStatus', 'jobId', jobId);
|
|
79
|
+
const localVarPath = `/api/v1/ai/insights/backfill/{jobId}`
|
|
80
|
+
.replace('{jobId}', encodeURIComponent(String(jobId)));
|
|
81
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
82
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
83
|
+
let baseOptions;
|
|
84
|
+
if (configuration) {
|
|
85
|
+
baseOptions = configuration.baseOptions;
|
|
86
|
+
}
|
|
87
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
88
|
+
const localVarHeaderParameter = {};
|
|
89
|
+
const localVarQueryParameter = {};
|
|
90
|
+
// authentication keycloak_auth required
|
|
91
|
+
// http bearer authentication required
|
|
92
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
93
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
94
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
95
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
96
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
97
|
+
return {
|
|
98
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
99
|
+
options: localVarRequestOptions,
|
|
100
|
+
};
|
|
101
|
+
}),
|
|
102
|
+
/**
|
|
103
|
+
* 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.
|
|
104
|
+
* @summary Get the insights of a document
|
|
105
|
+
* @param {string} documentId
|
|
106
|
+
* @param {*} [options] Override http request option.
|
|
107
|
+
* @throws {RequiredError}
|
|
108
|
+
*/
|
|
109
|
+
getInsights: (documentId_1, ...args_1) => __awaiter(this, [documentId_1, ...args_1], void 0, function* (documentId, options = {}) {
|
|
110
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
111
|
+
(0, common_1.assertParamExists)('getInsights', 'documentId', documentId);
|
|
112
|
+
const localVarPath = `/api/v1/documents/{documentId}/insights`
|
|
113
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
114
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
115
|
+
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
|
|
116
|
+
let baseOptions;
|
|
117
|
+
if (configuration) {
|
|
118
|
+
baseOptions = configuration.baseOptions;
|
|
119
|
+
}
|
|
120
|
+
const localVarRequestOptions = Object.assign(Object.assign({ method: 'GET' }, baseOptions), options);
|
|
121
|
+
const localVarHeaderParameter = {};
|
|
122
|
+
const localVarQueryParameter = {};
|
|
123
|
+
// authentication keycloak_auth required
|
|
124
|
+
// http bearer authentication required
|
|
125
|
+
yield (0, common_1.setBearerAuthToObject)(localVarHeaderParameter, configuration);
|
|
126
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
127
|
+
(0, common_1.setSearchParams)(localVarUrlObj, localVarQueryParameter);
|
|
128
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
129
|
+
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
|
|
130
|
+
return {
|
|
131
|
+
url: (0, common_1.toPathString)(localVarUrlObj),
|
|
132
|
+
options: localVarRequestOptions,
|
|
133
|
+
};
|
|
134
|
+
}),
|
|
135
|
+
};
|
|
136
|
+
};
|
|
137
|
+
exports.DocumentInsightsApiAxiosParamCreator = DocumentInsightsApiAxiosParamCreator;
|
|
138
|
+
/**
|
|
139
|
+
* DocumentInsightsApi - functional programming interface
|
|
140
|
+
*/
|
|
141
|
+
const DocumentInsightsApiFp = function (configuration) {
|
|
142
|
+
const localVarAxiosParamCreator = (0, exports.DocumentInsightsApiAxiosParamCreator)(configuration);
|
|
143
|
+
return {
|
|
144
|
+
/**
|
|
145
|
+
* 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}.
|
|
146
|
+
* @summary Enrich existing documents
|
|
147
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
148
|
+
* @param {*} [options] Override http request option.
|
|
149
|
+
* @throws {RequiredError}
|
|
150
|
+
*/
|
|
151
|
+
backfill(insightBackfillRequest, options) {
|
|
152
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
153
|
+
var _a, _b, _c;
|
|
154
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.backfill(insightBackfillRequest, options);
|
|
155
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
156
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentInsightsApi.backfill']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
157
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
158
|
+
});
|
|
159
|
+
},
|
|
160
|
+
/**
|
|
161
|
+
*
|
|
162
|
+
* @summary Progress of a backfill job
|
|
163
|
+
* @param {string} jobId
|
|
164
|
+
* @param {*} [options] Override http request option.
|
|
165
|
+
* @throws {RequiredError}
|
|
166
|
+
*/
|
|
167
|
+
backfillStatus(jobId, options) {
|
|
168
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
169
|
+
var _a, _b, _c;
|
|
170
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.backfillStatus(jobId, options);
|
|
171
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
172
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentInsightsApi.backfillStatus']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
173
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
174
|
+
});
|
|
175
|
+
},
|
|
176
|
+
/**
|
|
177
|
+
* 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.
|
|
178
|
+
* @summary Get the insights of a document
|
|
179
|
+
* @param {string} documentId
|
|
180
|
+
* @param {*} [options] Override http request option.
|
|
181
|
+
* @throws {RequiredError}
|
|
182
|
+
*/
|
|
183
|
+
getInsights(documentId, options) {
|
|
184
|
+
return __awaiter(this, void 0, void 0, function* () {
|
|
185
|
+
var _a, _b, _c;
|
|
186
|
+
const localVarAxiosArgs = yield localVarAxiosParamCreator.getInsights(documentId, options);
|
|
187
|
+
const localVarOperationServerIndex = (_a = configuration === null || configuration === void 0 ? void 0 : configuration.serverIndex) !== null && _a !== void 0 ? _a : 0;
|
|
188
|
+
const localVarOperationServerBasePath = (_c = (_b = base_1.operationServerMap['DocumentInsightsApi.getInsights']) === null || _b === void 0 ? void 0 : _b[localVarOperationServerIndex]) === null || _c === void 0 ? void 0 : _c.url;
|
|
189
|
+
return (axios, basePath) => (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
190
|
+
});
|
|
191
|
+
},
|
|
192
|
+
};
|
|
193
|
+
};
|
|
194
|
+
exports.DocumentInsightsApiFp = DocumentInsightsApiFp;
|
|
195
|
+
/**
|
|
196
|
+
* DocumentInsightsApi - factory interface
|
|
197
|
+
*/
|
|
198
|
+
const DocumentInsightsApiFactory = function (configuration, basePath, axios) {
|
|
199
|
+
const localVarFp = (0, exports.DocumentInsightsApiFp)(configuration);
|
|
200
|
+
return {
|
|
201
|
+
/**
|
|
202
|
+
* 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}.
|
|
203
|
+
* @summary Enrich existing documents
|
|
204
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
205
|
+
* @param {*} [options] Override http request option.
|
|
206
|
+
* @throws {RequiredError}
|
|
207
|
+
*/
|
|
208
|
+
backfill(insightBackfillRequest, options) {
|
|
209
|
+
return localVarFp.backfill(insightBackfillRequest, options).then((request) => request(axios, basePath));
|
|
210
|
+
},
|
|
211
|
+
/**
|
|
212
|
+
*
|
|
213
|
+
* @summary Progress of a backfill job
|
|
214
|
+
* @param {string} jobId
|
|
215
|
+
* @param {*} [options] Override http request option.
|
|
216
|
+
* @throws {RequiredError}
|
|
217
|
+
*/
|
|
218
|
+
backfillStatus(jobId, options) {
|
|
219
|
+
return localVarFp.backfillStatus(jobId, options).then((request) => request(axios, basePath));
|
|
220
|
+
},
|
|
221
|
+
/**
|
|
222
|
+
* 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.
|
|
223
|
+
* @summary Get the insights of a document
|
|
224
|
+
* @param {string} documentId
|
|
225
|
+
* @param {*} [options] Override http request option.
|
|
226
|
+
* @throws {RequiredError}
|
|
227
|
+
*/
|
|
228
|
+
getInsights(documentId, options) {
|
|
229
|
+
return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
|
|
230
|
+
},
|
|
231
|
+
};
|
|
232
|
+
};
|
|
233
|
+
exports.DocumentInsightsApiFactory = DocumentInsightsApiFactory;
|
|
234
|
+
/**
|
|
235
|
+
* DocumentInsightsApi - object-oriented interface
|
|
236
|
+
*/
|
|
237
|
+
class DocumentInsightsApi extends base_1.BaseAPI {
|
|
238
|
+
/**
|
|
239
|
+
* 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}.
|
|
240
|
+
* @summary Enrich existing documents
|
|
241
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
242
|
+
* @param {*} [options] Override http request option.
|
|
243
|
+
* @throws {RequiredError}
|
|
244
|
+
*/
|
|
245
|
+
backfill(insightBackfillRequest, options) {
|
|
246
|
+
return (0, exports.DocumentInsightsApiFp)(this.configuration).backfill(insightBackfillRequest, options).then((request) => request(this.axios, this.basePath));
|
|
247
|
+
}
|
|
248
|
+
/**
|
|
249
|
+
*
|
|
250
|
+
* @summary Progress of a backfill job
|
|
251
|
+
* @param {string} jobId
|
|
252
|
+
* @param {*} [options] Override http request option.
|
|
253
|
+
* @throws {RequiredError}
|
|
254
|
+
*/
|
|
255
|
+
backfillStatus(jobId, options) {
|
|
256
|
+
return (0, exports.DocumentInsightsApiFp)(this.configuration).backfillStatus(jobId, options).then((request) => request(this.axios, this.basePath));
|
|
257
|
+
}
|
|
258
|
+
/**
|
|
259
|
+
* 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.
|
|
260
|
+
* @summary Get the insights of a document
|
|
261
|
+
* @param {string} documentId
|
|
262
|
+
* @param {*} [options] Override http request option.
|
|
263
|
+
* @throws {RequiredError}
|
|
264
|
+
*/
|
|
265
|
+
getInsights(documentId, options) {
|
|
266
|
+
return (0, exports.DocumentInsightsApiFp)(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
267
|
+
}
|
|
268
|
+
}
|
|
269
|
+
exports.DocumentInsightsApi = DocumentInsightsApi;
|
package/dist/api/esign-api.d.ts
CHANGED
|
@@ -58,7 +58,7 @@ export declare const ESignApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
58
58
|
* @param {*} [options] Override http request option.
|
|
59
59
|
* @throws {RequiredError}
|
|
60
60
|
*/
|
|
61
|
-
|
|
61
|
+
get3: (id: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
62
62
|
/**
|
|
63
63
|
*
|
|
64
64
|
* @summary List envelopes I sent for signature
|
|
@@ -142,7 +142,7 @@ export declare const ESignApiFp: (configuration?: Configuration) => {
|
|
|
142
142
|
* @param {*} [options] Override http request option.
|
|
143
143
|
* @throws {RequiredError}
|
|
144
144
|
*/
|
|
145
|
-
|
|
145
|
+
get3(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>>;
|
|
146
146
|
/**
|
|
147
147
|
*
|
|
148
148
|
* @summary List envelopes I sent for signature
|
|
@@ -226,7 +226,7 @@ export declare const ESignApiFactory: (configuration?: Configuration, basePath?:
|
|
|
226
226
|
* @param {*} [options] Override http request option.
|
|
227
227
|
* @throws {RequiredError}
|
|
228
228
|
*/
|
|
229
|
-
|
|
229
|
+
get3(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO>;
|
|
230
230
|
/**
|
|
231
231
|
*
|
|
232
232
|
* @summary List envelopes I sent for signature
|
|
@@ -310,7 +310,7 @@ export declare class ESignApi extends BaseAPI {
|
|
|
310
310
|
* @param {*} [options] Override http request option.
|
|
311
311
|
* @throws {RequiredError}
|
|
312
312
|
*/
|
|
313
|
-
|
|
313
|
+
get3(id: string, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<SignatureEnvelopeDTO, any, {}, any>>;
|
|
314
314
|
/**
|
|
315
315
|
*
|
|
316
316
|
* @summary List envelopes I sent for signature
|