@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
|
@@ -602,11 +602,12 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
602
602
|
* @summary Upload multiple documents
|
|
603
603
|
* @param {Array<File>} file
|
|
604
604
|
* @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)
|
|
605
|
+
* @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.
|
|
605
606
|
* @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>
|
|
606
607
|
* @param {*} [options] Override http request option.
|
|
607
608
|
* @throws {RequiredError}
|
|
608
609
|
*/
|
|
609
|
-
uploadDocument: async (file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
610
|
+
uploadDocument: async (file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
610
611
|
// verify required parameter 'file' is not null or undefined
|
|
611
612
|
assertParamExists('uploadDocument', 'file', file)
|
|
612
613
|
const localVarPath = `/api/v1/documents/upload-multiple`;
|
|
@@ -630,6 +631,10 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
630
631
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
631
632
|
}
|
|
632
633
|
|
|
634
|
+
if (autoFile !== undefined) {
|
|
635
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
636
|
+
}
|
|
637
|
+
|
|
633
638
|
if (file) {
|
|
634
639
|
file.forEach((element) => {
|
|
635
640
|
localVarFormParams.append('file', element as any);
|
|
@@ -658,12 +663,13 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
658
663
|
* @summary Upload a single document
|
|
659
664
|
* @param {File} file
|
|
660
665
|
* @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)
|
|
666
|
+
* @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.
|
|
661
667
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
662
668
|
* @param {string} [metadata]
|
|
663
669
|
* @param {*} [options] Override http request option.
|
|
664
670
|
* @throws {RequiredError}
|
|
665
671
|
*/
|
|
666
|
-
uploadDocument1: async (file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
672
|
+
uploadDocument1: async (file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
667
673
|
// verify required parameter 'file' is not null or undefined
|
|
668
674
|
assertParamExists('uploadDocument1', 'file', file)
|
|
669
675
|
const localVarPath = `/api/v1/documents/upload`;
|
|
@@ -687,6 +693,10 @@ export const DocumentControllerApiAxiosParamCreator = function (configuration?:
|
|
|
687
693
|
localVarQueryParameter['allowDuplicateFileNames'] = allowDuplicateFileNames;
|
|
688
694
|
}
|
|
689
695
|
|
|
696
|
+
if (autoFile !== undefined) {
|
|
697
|
+
localVarQueryParameter['autoFile'] = autoFile;
|
|
698
|
+
}
|
|
699
|
+
|
|
690
700
|
|
|
691
701
|
if (file !== undefined) {
|
|
692
702
|
localVarFormParams.append('file', file as any);
|
|
@@ -905,12 +915,13 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
|
|
|
905
915
|
* @summary Upload multiple documents
|
|
906
916
|
* @param {Array<File>} file
|
|
907
917
|
* @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)
|
|
918
|
+
* @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.
|
|
908
919
|
* @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>
|
|
909
920
|
* @param {*} [options] Override http request option.
|
|
910
921
|
* @throws {RequiredError}
|
|
911
922
|
*/
|
|
912
|
-
async uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>> {
|
|
913
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options);
|
|
923
|
+
async uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<UploadResponse>>> {
|
|
924
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options);
|
|
914
925
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
915
926
|
const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.uploadDocument']?.[localVarOperationServerIndex]?.url;
|
|
916
927
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -920,13 +931,14 @@ export const DocumentControllerApiFp = function(configuration?: Configuration) {
|
|
|
920
931
|
* @summary Upload a single document
|
|
921
932
|
* @param {File} file
|
|
922
933
|
* @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)
|
|
934
|
+
* @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.
|
|
923
935
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
924
936
|
* @param {string} [metadata]
|
|
925
937
|
* @param {*} [options] Override http request option.
|
|
926
938
|
* @throws {RequiredError}
|
|
927
939
|
*/
|
|
928
|
-
async uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>> {
|
|
929
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options);
|
|
940
|
+
async uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UploadResponse>> {
|
|
941
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options);
|
|
930
942
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
931
943
|
const localVarOperationServerBasePath = operationServerMap['DocumentControllerApi.uploadDocument1']?.[localVarOperationServerIndex]?.url;
|
|
932
944
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
@@ -1085,25 +1097,27 @@ export const DocumentControllerApiFactory = function (configuration?: Configurat
|
|
|
1085
1097
|
* @summary Upload multiple documents
|
|
1086
1098
|
* @param {Array<File>} file
|
|
1087
1099
|
* @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)
|
|
1100
|
+
* @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.
|
|
1088
1101
|
* @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>
|
|
1089
1102
|
* @param {*} [options] Override http request option.
|
|
1090
1103
|
* @throws {RequiredError}
|
|
1091
1104
|
*/
|
|
1092
|
-
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>> {
|
|
1093
|
-
return localVarFp.uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1105
|
+
uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig): AxiosPromise<Array<UploadResponse>> {
|
|
1106
|
+
return localVarFp.uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(axios, basePath));
|
|
1094
1107
|
},
|
|
1095
1108
|
/**
|
|
1096
1109
|
* Uploads a single file, optionally with metadata and a parent folder ID.
|
|
1097
1110
|
* @summary Upload a single document
|
|
1098
1111
|
* @param {File} file
|
|
1099
1112
|
* @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)
|
|
1113
|
+
* @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.
|
|
1100
1114
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1101
1115
|
* @param {string} [metadata]
|
|
1102
1116
|
* @param {*} [options] Override http request option.
|
|
1103
1117
|
* @throws {RequiredError}
|
|
1104
1118
|
*/
|
|
1105
|
-
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse> {
|
|
1106
|
-
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1119
|
+
uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig): AxiosPromise<UploadResponse> {
|
|
1120
|
+
return localVarFp.uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(axios, basePath));
|
|
1107
1121
|
},
|
|
1108
1122
|
};
|
|
1109
1123
|
};
|
|
@@ -1270,12 +1284,13 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1270
1284
|
* @summary Upload multiple documents
|
|
1271
1285
|
* @param {Array<File>} file
|
|
1272
1286
|
* @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)
|
|
1287
|
+
* @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.
|
|
1273
1288
|
* @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>
|
|
1274
1289
|
* @param {*} [options] Override http request option.
|
|
1275
1290
|
* @throws {RequiredError}
|
|
1276
1291
|
*/
|
|
1277
|
-
public uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) {
|
|
1278
|
-
return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1292
|
+
public uploadDocument(file: Array<File>, allowDuplicateFileNames?: boolean, autoFile?: boolean, parametersByFilename?: string, options?: RawAxiosRequestConfig) {
|
|
1293
|
+
return DocumentControllerApiFp(this.configuration).uploadDocument(file, allowDuplicateFileNames, autoFile, parametersByFilename, options).then((request) => request(this.axios, this.basePath));
|
|
1279
1294
|
}
|
|
1280
1295
|
|
|
1281
1296
|
/**
|
|
@@ -1283,13 +1298,14 @@ export class DocumentControllerApi extends BaseAPI {
|
|
|
1283
1298
|
* @summary Upload a single document
|
|
1284
1299
|
* @param {File} file
|
|
1285
1300
|
* @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)
|
|
1301
|
+
* @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.
|
|
1286
1302
|
* @param {string} [parentFolderId] Target parent folder ID to store the file; if not sent or null, the file is stored at the root level
|
|
1287
1303
|
* @param {string} [metadata]
|
|
1288
1304
|
* @param {*} [options] Override http request option.
|
|
1289
1305
|
* @throws {RequiredError}
|
|
1290
1306
|
*/
|
|
1291
|
-
public uploadDocument1(file: File, allowDuplicateFileNames?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) {
|
|
1292
|
-
return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1307
|
+
public uploadDocument1(file: File, allowDuplicateFileNames?: boolean, autoFile?: boolean, parentFolderId?: string, metadata?: string, options?: RawAxiosRequestConfig) {
|
|
1308
|
+
return DocumentControllerApiFp(this.configuration).uploadDocument1(file, allowDuplicateFileNames, autoFile, parentFolderId, metadata, options).then((request) => request(this.axios, this.basePath));
|
|
1293
1309
|
}
|
|
1294
1310
|
}
|
|
1295
1311
|
|
|
@@ -0,0 +1,275 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* openfilz-api
|
|
5
|
+
* API for Document Management System
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 1.0.0
|
|
8
|
+
*
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
|
|
16
|
+
import type { Configuration } from '../configuration';
|
|
17
|
+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
18
|
+
import globalAxios from 'axios';
|
|
19
|
+
// Some imports not used depending on template conditions
|
|
20
|
+
// @ts-ignore
|
|
21
|
+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction, replaceWithSerializableTypeIfNeeded } from '../common';
|
|
22
|
+
// @ts-ignore
|
|
23
|
+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
|
+
// @ts-ignore
|
|
25
|
+
import type { DocumentInsightView } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
27
|
+
import type { InsightBackfillRequest } from '../models';
|
|
28
|
+
// @ts-ignore
|
|
29
|
+
import type { InsightBackfillStatus } from '../models';
|
|
30
|
+
/**
|
|
31
|
+
* DocumentInsightsApi - axios parameter creator
|
|
32
|
+
*/
|
|
33
|
+
export const DocumentInsightsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
|
+
return {
|
|
35
|
+
/**
|
|
36
|
+
* 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}.
|
|
37
|
+
* @summary Enrich existing documents
|
|
38
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
39
|
+
* @param {*} [options] Override http request option.
|
|
40
|
+
* @throws {RequiredError}
|
|
41
|
+
*/
|
|
42
|
+
backfill: async (insightBackfillRequest?: InsightBackfillRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
43
|
+
const localVarPath = `/api/v1/ai/insights/backfill`;
|
|
44
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
46
|
+
let baseOptions;
|
|
47
|
+
if (configuration) {
|
|
48
|
+
baseOptions = configuration.baseOptions;
|
|
49
|
+
}
|
|
50
|
+
|
|
51
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
52
|
+
const localVarHeaderParameter = {} as any;
|
|
53
|
+
const localVarQueryParameter = {} as any;
|
|
54
|
+
|
|
55
|
+
// authentication keycloak_auth required
|
|
56
|
+
// http bearer authentication required
|
|
57
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
58
|
+
|
|
59
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
60
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
61
|
+
|
|
62
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
63
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
64
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
65
|
+
localVarRequestOptions.data = serializeDataIfNeeded(insightBackfillRequest, localVarRequestOptions, configuration)
|
|
66
|
+
|
|
67
|
+
return {
|
|
68
|
+
url: toPathString(localVarUrlObj),
|
|
69
|
+
options: localVarRequestOptions,
|
|
70
|
+
};
|
|
71
|
+
},
|
|
72
|
+
/**
|
|
73
|
+
*
|
|
74
|
+
* @summary Progress of a backfill job
|
|
75
|
+
* @param {string} jobId
|
|
76
|
+
* @param {*} [options] Override http request option.
|
|
77
|
+
* @throws {RequiredError}
|
|
78
|
+
*/
|
|
79
|
+
backfillStatus: async (jobId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
80
|
+
// verify required parameter 'jobId' is not null or undefined
|
|
81
|
+
assertParamExists('backfillStatus', 'jobId', jobId)
|
|
82
|
+
const localVarPath = `/api/v1/ai/insights/backfill/{jobId}`
|
|
83
|
+
.replace('{jobId}', encodeURIComponent(String(jobId)));
|
|
84
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
85
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
86
|
+
let baseOptions;
|
|
87
|
+
if (configuration) {
|
|
88
|
+
baseOptions = configuration.baseOptions;
|
|
89
|
+
}
|
|
90
|
+
|
|
91
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
92
|
+
const localVarHeaderParameter = {} as any;
|
|
93
|
+
const localVarQueryParameter = {} as any;
|
|
94
|
+
|
|
95
|
+
// authentication keycloak_auth required
|
|
96
|
+
// http bearer authentication required
|
|
97
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
98
|
+
|
|
99
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
100
|
+
|
|
101
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
102
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
103
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
104
|
+
|
|
105
|
+
return {
|
|
106
|
+
url: toPathString(localVarUrlObj),
|
|
107
|
+
options: localVarRequestOptions,
|
|
108
|
+
};
|
|
109
|
+
},
|
|
110
|
+
/**
|
|
111
|
+
* 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.
|
|
112
|
+
* @summary Get the insights of a document
|
|
113
|
+
* @param {string} documentId
|
|
114
|
+
* @param {*} [options] Override http request option.
|
|
115
|
+
* @throws {RequiredError}
|
|
116
|
+
*/
|
|
117
|
+
getInsights: async (documentId: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
118
|
+
// verify required parameter 'documentId' is not null or undefined
|
|
119
|
+
assertParamExists('getInsights', 'documentId', documentId)
|
|
120
|
+
const localVarPath = `/api/v1/documents/{documentId}/insights`
|
|
121
|
+
.replace('{documentId}', encodeURIComponent(String(documentId)));
|
|
122
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
123
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
124
|
+
let baseOptions;
|
|
125
|
+
if (configuration) {
|
|
126
|
+
baseOptions = configuration.baseOptions;
|
|
127
|
+
}
|
|
128
|
+
|
|
129
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
130
|
+
const localVarHeaderParameter = {} as any;
|
|
131
|
+
const localVarQueryParameter = {} as any;
|
|
132
|
+
|
|
133
|
+
// authentication keycloak_auth required
|
|
134
|
+
// http bearer authentication required
|
|
135
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
136
|
+
|
|
137
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
138
|
+
|
|
139
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
140
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
141
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
142
|
+
|
|
143
|
+
return {
|
|
144
|
+
url: toPathString(localVarUrlObj),
|
|
145
|
+
options: localVarRequestOptions,
|
|
146
|
+
};
|
|
147
|
+
},
|
|
148
|
+
}
|
|
149
|
+
};
|
|
150
|
+
|
|
151
|
+
/**
|
|
152
|
+
* DocumentInsightsApi - functional programming interface
|
|
153
|
+
*/
|
|
154
|
+
export const DocumentInsightsApiFp = function(configuration?: Configuration) {
|
|
155
|
+
const localVarAxiosParamCreator = DocumentInsightsApiAxiosParamCreator(configuration)
|
|
156
|
+
return {
|
|
157
|
+
/**
|
|
158
|
+
* 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}.
|
|
159
|
+
* @summary Enrich existing documents
|
|
160
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
161
|
+
* @param {*} [options] Override http request option.
|
|
162
|
+
* @throws {RequiredError}
|
|
163
|
+
*/
|
|
164
|
+
async backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>> {
|
|
165
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.backfill(insightBackfillRequest, options);
|
|
166
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
167
|
+
const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.backfill']?.[localVarOperationServerIndex]?.url;
|
|
168
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
169
|
+
},
|
|
170
|
+
/**
|
|
171
|
+
*
|
|
172
|
+
* @summary Progress of a backfill job
|
|
173
|
+
* @param {string} jobId
|
|
174
|
+
* @param {*} [options] Override http request option.
|
|
175
|
+
* @throws {RequiredError}
|
|
176
|
+
*/
|
|
177
|
+
async backfillStatus(jobId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InsightBackfillStatus>> {
|
|
178
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.backfillStatus(jobId, options);
|
|
179
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
180
|
+
const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.backfillStatus']?.[localVarOperationServerIndex]?.url;
|
|
181
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
182
|
+
},
|
|
183
|
+
/**
|
|
184
|
+
* 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.
|
|
185
|
+
* @summary Get the insights of a document
|
|
186
|
+
* @param {string} documentId
|
|
187
|
+
* @param {*} [options] Override http request option.
|
|
188
|
+
* @throws {RequiredError}
|
|
189
|
+
*/
|
|
190
|
+
async getInsights(documentId: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DocumentInsightView>> {
|
|
191
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getInsights(documentId, options);
|
|
192
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
193
|
+
const localVarOperationServerBasePath = operationServerMap['DocumentInsightsApi.getInsights']?.[localVarOperationServerIndex]?.url;
|
|
194
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
195
|
+
},
|
|
196
|
+
}
|
|
197
|
+
};
|
|
198
|
+
|
|
199
|
+
/**
|
|
200
|
+
* DocumentInsightsApi - factory interface
|
|
201
|
+
*/
|
|
202
|
+
export const DocumentInsightsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
203
|
+
const localVarFp = DocumentInsightsApiFp(configuration)
|
|
204
|
+
return {
|
|
205
|
+
/**
|
|
206
|
+
* 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}.
|
|
207
|
+
* @summary Enrich existing documents
|
|
208
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
209
|
+
* @param {*} [options] Override http request option.
|
|
210
|
+
* @throws {RequiredError}
|
|
211
|
+
*/
|
|
212
|
+
backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus> {
|
|
213
|
+
return localVarFp.backfill(insightBackfillRequest, options).then((request) => request(axios, basePath));
|
|
214
|
+
},
|
|
215
|
+
/**
|
|
216
|
+
*
|
|
217
|
+
* @summary Progress of a backfill job
|
|
218
|
+
* @param {string} jobId
|
|
219
|
+
* @param {*} [options] Override http request option.
|
|
220
|
+
* @throws {RequiredError}
|
|
221
|
+
*/
|
|
222
|
+
backfillStatus(jobId: string, options?: RawAxiosRequestConfig): AxiosPromise<InsightBackfillStatus> {
|
|
223
|
+
return localVarFp.backfillStatus(jobId, options).then((request) => request(axios, basePath));
|
|
224
|
+
},
|
|
225
|
+
/**
|
|
226
|
+
* 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.
|
|
227
|
+
* @summary Get the insights of a document
|
|
228
|
+
* @param {string} documentId
|
|
229
|
+
* @param {*} [options] Override http request option.
|
|
230
|
+
* @throws {RequiredError}
|
|
231
|
+
*/
|
|
232
|
+
getInsights(documentId: string, options?: RawAxiosRequestConfig): AxiosPromise<DocumentInsightView> {
|
|
233
|
+
return localVarFp.getInsights(documentId, options).then((request) => request(axios, basePath));
|
|
234
|
+
},
|
|
235
|
+
};
|
|
236
|
+
};
|
|
237
|
+
|
|
238
|
+
/**
|
|
239
|
+
* DocumentInsightsApi - object-oriented interface
|
|
240
|
+
*/
|
|
241
|
+
export class DocumentInsightsApi extends BaseAPI {
|
|
242
|
+
/**
|
|
243
|
+
* 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}.
|
|
244
|
+
* @summary Enrich existing documents
|
|
245
|
+
* @param {InsightBackfillRequest} [insightBackfillRequest]
|
|
246
|
+
* @param {*} [options] Override http request option.
|
|
247
|
+
* @throws {RequiredError}
|
|
248
|
+
*/
|
|
249
|
+
public backfill(insightBackfillRequest?: InsightBackfillRequest, options?: RawAxiosRequestConfig) {
|
|
250
|
+
return DocumentInsightsApiFp(this.configuration).backfill(insightBackfillRequest, options).then((request) => request(this.axios, this.basePath));
|
|
251
|
+
}
|
|
252
|
+
|
|
253
|
+
/**
|
|
254
|
+
*
|
|
255
|
+
* @summary Progress of a backfill job
|
|
256
|
+
* @param {string} jobId
|
|
257
|
+
* @param {*} [options] Override http request option.
|
|
258
|
+
* @throws {RequiredError}
|
|
259
|
+
*/
|
|
260
|
+
public backfillStatus(jobId: string, options?: RawAxiosRequestConfig) {
|
|
261
|
+
return DocumentInsightsApiFp(this.configuration).backfillStatus(jobId, options).then((request) => request(this.axios, this.basePath));
|
|
262
|
+
}
|
|
263
|
+
|
|
264
|
+
/**
|
|
265
|
+
* 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.
|
|
266
|
+
* @summary Get the insights of a document
|
|
267
|
+
* @param {string} documentId
|
|
268
|
+
* @param {*} [options] Override http request option.
|
|
269
|
+
* @throws {RequiredError}
|
|
270
|
+
*/
|
|
271
|
+
public getInsights(documentId: string, options?: RawAxiosRequestConfig) {
|
|
272
|
+
return DocumentInsightsApiFp(this.configuration).getInsights(documentId, options).then((request) => request(this.axios, this.basePath));
|
|
273
|
+
}
|
|
274
|
+
}
|
|
275
|
+
|
package/api/esign-api.ts
CHANGED
|
@@ -190,9 +190,9 @@ export const ESignApiAxiosParamCreator = function (configuration?: Configuration
|
|
|
190
190
|
* @param {*} [options] Override http request option.
|
|
191
191
|
* @throws {RequiredError}
|
|
192
192
|
*/
|
|
193
|
-
|
|
193
|
+
get3: async (id: string, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
194
194
|
// verify required parameter 'id' is not null or undefined
|
|
195
|
-
assertParamExists('
|
|
195
|
+
assertParamExists('get3', 'id', id)
|
|
196
196
|
const localVarPath = `/api/v1/signatures/{id}`
|
|
197
197
|
.replace('{id}', encodeURIComponent(String(id)));
|
|
198
198
|
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
@@ -479,10 +479,10 @@ export const ESignApiFp = function(configuration?: Configuration) {
|
|
|
479
479
|
* @param {*} [options] Override http request option.
|
|
480
480
|
* @throws {RequiredError}
|
|
481
481
|
*/
|
|
482
|
-
async
|
|
483
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.
|
|
482
|
+
async get3(id: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SignatureEnvelopeDTO>> {
|
|
483
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.get3(id, options);
|
|
484
484
|
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
485
|
-
const localVarOperationServerBasePath = operationServerMap['ESignApi.
|
|
485
|
+
const localVarOperationServerBasePath = operationServerMap['ESignApi.get3']?.[localVarOperationServerIndex]?.url;
|
|
486
486
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
487
487
|
},
|
|
488
488
|
/**
|
|
@@ -605,8 +605,8 @@ export const ESignApiFactory = function (configuration?: Configuration, basePath
|
|
|
605
605
|
* @param {*} [options] Override http request option.
|
|
606
606
|
* @throws {RequiredError}
|
|
607
607
|
*/
|
|
608
|
-
|
|
609
|
-
return localVarFp.
|
|
608
|
+
get3(id: string, options?: RawAxiosRequestConfig): AxiosPromise<SignatureEnvelopeDTO> {
|
|
609
|
+
return localVarFp.get3(id, options).then((request) => request(axios, basePath));
|
|
610
610
|
},
|
|
611
611
|
/**
|
|
612
612
|
*
|
|
@@ -715,8 +715,8 @@ export class ESignApi extends BaseAPI {
|
|
|
715
715
|
* @param {*} [options] Override http request option.
|
|
716
716
|
* @throws {RequiredError}
|
|
717
717
|
*/
|
|
718
|
-
public
|
|
719
|
-
return ESignApiFp(this.configuration).
|
|
718
|
+
public get3(id: string, options?: RawAxiosRequestConfig) {
|
|
719
|
+
return ESignApiFp(this.configuration).get3(id, options).then((request) => request(this.axios, this.basePath));
|
|
720
720
|
}
|
|
721
721
|
|
|
722
722
|
/**
|