@openfilz-sdk/typescript-ee 1.9.6 → 1.9.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.openapi-generator/FILES +22 -0
- package/.openapi-generator/openfilz-api-generate-typescript-sdk.sha256 +1 -1
- package/README.md +23 -4
- package/api/aichat-api.ts +9 -9
- package/api/document-controller-api.ts +30 -14
- package/api/document-insights-api.ts +275 -0
- package/api/esign-api.ts +9 -9
- package/api/settings-api.ts +142 -0
- package/api/smart-filing-api.ts +421 -0
- package/api.ts +2 -0
- package/dist/api/aichat-api.d.ts +4 -4
- package/dist/api/aichat-api.js +9 -9
- package/dist/api/document-controller-api.d.ts +16 -8
- package/dist/api/document-controller-api.js +28 -14
- package/dist/api/document-insights-api.d.ts +133 -0
- package/dist/api/document-insights-api.js +269 -0
- package/dist/api/esign-api.d.ts +4 -4
- package/dist/api/esign-api.js +9 -9
- package/dist/api/settings-api.d.ts +62 -0
- package/dist/api/settings-api.js +132 -0
- package/dist/api/smart-filing-api.d.ts +197 -0
- package/dist/api/smart-filing-api.js +409 -0
- package/dist/api.d.ts +2 -0
- package/dist/api.js +2 -0
- package/dist/esm/api/aichat-api.d.ts +4 -4
- package/dist/esm/api/aichat-api.js +9 -9
- package/dist/esm/api/document-controller-api.d.ts +16 -8
- package/dist/esm/api/document-controller-api.js +28 -14
- package/dist/esm/api/document-insights-api.d.ts +133 -0
- package/dist/esm/api/document-insights-api.js +262 -0
- package/dist/esm/api/esign-api.d.ts +4 -4
- package/dist/esm/api/esign-api.js +9 -9
- package/dist/esm/api/settings-api.d.ts +62 -0
- package/dist/esm/api/settings-api.js +132 -0
- package/dist/esm/api/smart-filing-api.d.ts +197 -0
- package/dist/esm/api/smart-filing-api.js +402 -0
- package/dist/esm/api.d.ts +2 -0
- package/dist/esm/api.js +2 -0
- package/dist/esm/models/ai-preferences-view.d.ts +16 -0
- package/dist/esm/models/ai-preferences-view.js +14 -0
- package/dist/esm/models/auto-file-job-view.d.ts +25 -0
- package/dist/esm/models/auto-file-job-view.js +14 -0
- package/dist/esm/models/auto-file-request.d.ts +15 -0
- package/dist/esm/models/auto-file-request.js +14 -0
- package/dist/esm/models/auto-file-ticket.d.ts +15 -0
- package/dist/esm/models/auto-file-ticket.js +14 -0
- package/dist/esm/models/document-insight-view.d.ts +33 -0
- package/dist/esm/models/document-insight-view.js +14 -0
- package/dist/esm/models/filing-outcome.d.ts +25 -0
- package/dist/esm/models/filing-outcome.js +14 -0
- package/dist/esm/models/index.d.ts +9 -0
- package/dist/esm/models/index.js +9 -0
- package/dist/esm/models/insight-backfill-request.d.ts +15 -0
- package/dist/esm/models/insight-backfill-request.js +14 -0
- package/dist/esm/models/insight-backfill-status.d.ts +23 -0
- package/dist/esm/models/insight-backfill-status.js +14 -0
- package/dist/esm/models/save-ai-preferences-request.d.ts +15 -0
- package/dist/esm/models/save-ai-preferences-request.js +14 -0
- package/dist/esm/models/settings.d.ts +2 -0
- package/dist/esm/models/tus-finalize-request.d.ts +1 -0
- package/dist/esm/models/upload-response.d.ts +2 -0
- package/dist/models/ai-preferences-view.d.ts +16 -0
- package/dist/models/ai-preferences-view.js +15 -0
- package/dist/models/auto-file-job-view.d.ts +25 -0
- package/dist/models/auto-file-job-view.js +15 -0
- package/dist/models/auto-file-request.d.ts +15 -0
- package/dist/models/auto-file-request.js +15 -0
- package/dist/models/auto-file-ticket.d.ts +15 -0
- package/dist/models/auto-file-ticket.js +15 -0
- package/dist/models/document-insight-view.d.ts +33 -0
- package/dist/models/document-insight-view.js +15 -0
- package/dist/models/filing-outcome.d.ts +25 -0
- package/dist/models/filing-outcome.js +15 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/dist/models/insight-backfill-request.d.ts +15 -0
- package/dist/models/insight-backfill-request.js +15 -0
- package/dist/models/insight-backfill-status.d.ts +23 -0
- package/dist/models/insight-backfill-status.js +15 -0
- package/dist/models/save-ai-preferences-request.d.ts +15 -0
- package/dist/models/save-ai-preferences-request.js +15 -0
- package/dist/models/settings.d.ts +2 -0
- package/dist/models/tus-finalize-request.d.ts +1 -0
- package/dist/models/upload-response.d.ts +2 -0
- package/docs/AIChatApi.md +4 -4
- package/docs/AiPreferencesView.md +24 -0
- package/docs/AutoFileJobView.md +40 -0
- package/docs/AutoFileRequest.md +22 -0
- package/docs/AutoFileTicket.md +22 -0
- package/docs/DocumentControllerApi.md +6 -0
- package/docs/DocumentInsightView.md +54 -0
- package/docs/DocumentInsightsApi.md +163 -0
- package/docs/ESignApi.md +4 -4
- package/docs/FilingOutcome.md +42 -0
- package/docs/InsightBackfillRequest.md +22 -0
- package/docs/InsightBackfillStatus.md +38 -0
- package/docs/SaveAiPreferencesRequest.md +22 -0
- package/docs/Settings.md +4 -0
- package/docs/SettingsApi.md +97 -0
- package/docs/SmartFilingApi.md +264 -0
- package/docs/TusFinalizeRequest.md +2 -0
- package/docs/UploadResponse.md +2 -0
- package/models/ai-preferences-view.ts +22 -0
- package/models/auto-file-job-view.ts +33 -0
- package/models/auto-file-request.ts +21 -0
- package/models/auto-file-ticket.ts +21 -0
- package/models/document-insight-view.ts +37 -0
- package/models/filing-outcome.ts +31 -0
- package/models/index.ts +9 -0
- package/models/insight-backfill-request.ts +21 -0
- package/models/insight-backfill-status.ts +29 -0
- package/models/save-ai-preferences-request.ts +21 -0
- package/models/settings.ts +2 -0
- package/models/tus-finalize-request.ts +1 -0
- package/models/upload-response.ts +4 -0
- package/package.json +1 -1
|
@@ -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
|
/**
|
package/api/settings-api.ts
CHANGED
|
@@ -22,8 +22,12 @@ import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObj
|
|
|
22
22
|
// @ts-ignore
|
|
23
23
|
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
|
|
24
24
|
// @ts-ignore
|
|
25
|
+
import type { AiPreferencesView } from '../models';
|
|
26
|
+
// @ts-ignore
|
|
25
27
|
import type { LicenseInfo } from '../models';
|
|
26
28
|
// @ts-ignore
|
|
29
|
+
import type { SaveAiPreferencesRequest } from '../models';
|
|
30
|
+
// @ts-ignore
|
|
27
31
|
import type { Settings } from '../models';
|
|
28
32
|
// @ts-ignore
|
|
29
33
|
import type { UserPreferencesRequest } from '../models';
|
|
@@ -32,6 +36,40 @@ import type { UserPreferencesRequest } from '../models';
|
|
|
32
36
|
*/
|
|
33
37
|
export const SettingsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
34
38
|
return {
|
|
39
|
+
/**
|
|
40
|
+
*
|
|
41
|
+
* @summary The caller\'s smart-filing preferences
|
|
42
|
+
* @param {*} [options] Override http request option.
|
|
43
|
+
* @throws {RequiredError}
|
|
44
|
+
*/
|
|
45
|
+
get2: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
46
|
+
const localVarPath = `/api/v1/settings/ai/preferences`;
|
|
47
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
48
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
49
|
+
let baseOptions;
|
|
50
|
+
if (configuration) {
|
|
51
|
+
baseOptions = configuration.baseOptions;
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
55
|
+
const localVarHeaderParameter = {} as any;
|
|
56
|
+
const localVarQueryParameter = {} as any;
|
|
57
|
+
|
|
58
|
+
// authentication keycloak_auth required
|
|
59
|
+
// http bearer authentication required
|
|
60
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
61
|
+
|
|
62
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
63
|
+
|
|
64
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
65
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
66
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
67
|
+
|
|
68
|
+
return {
|
|
69
|
+
url: toPathString(localVarUrlObj),
|
|
70
|
+
options: localVarRequestOptions,
|
|
71
|
+
};
|
|
72
|
+
},
|
|
35
73
|
/**
|
|
36
74
|
* License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
|
|
37
75
|
* @summary Coarse license info
|
|
@@ -100,6 +138,45 @@ export const SettingsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
100
138
|
options: localVarRequestOptions,
|
|
101
139
|
};
|
|
102
140
|
},
|
|
141
|
+
/**
|
|
142
|
+
* A null field leaves the current value unchanged.
|
|
143
|
+
* @summary Save the caller\'s smart-filing preferences
|
|
144
|
+
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
145
|
+
* @param {*} [options] Override http request option.
|
|
146
|
+
* @throws {RequiredError}
|
|
147
|
+
*/
|
|
148
|
+
save: async (saveAiPreferencesRequest: SaveAiPreferencesRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
149
|
+
// verify required parameter 'saveAiPreferencesRequest' is not null or undefined
|
|
150
|
+
assertParamExists('save', 'saveAiPreferencesRequest', saveAiPreferencesRequest)
|
|
151
|
+
const localVarPath = `/api/v1/settings/ai/preferences`;
|
|
152
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
153
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
154
|
+
let baseOptions;
|
|
155
|
+
if (configuration) {
|
|
156
|
+
baseOptions = configuration.baseOptions;
|
|
157
|
+
}
|
|
158
|
+
|
|
159
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
160
|
+
const localVarHeaderParameter = {} as any;
|
|
161
|
+
const localVarQueryParameter = {} as any;
|
|
162
|
+
|
|
163
|
+
// authentication keycloak_auth required
|
|
164
|
+
// http bearer authentication required
|
|
165
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
166
|
+
|
|
167
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
168
|
+
localVarHeaderParameter['Accept'] = 'application/json';
|
|
169
|
+
|
|
170
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
171
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
172
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
173
|
+
localVarRequestOptions.data = serializeDataIfNeeded(saveAiPreferencesRequest, localVarRequestOptions, configuration)
|
|
174
|
+
|
|
175
|
+
return {
|
|
176
|
+
url: toPathString(localVarUrlObj),
|
|
177
|
+
options: localVarRequestOptions,
|
|
178
|
+
};
|
|
179
|
+
},
|
|
103
180
|
/**
|
|
104
181
|
* Save user\'s language and theme preferences
|
|
105
182
|
* @summary Save user preferences
|
|
@@ -148,6 +225,18 @@ export const SettingsApiAxiosParamCreator = function (configuration?: Configurat
|
|
|
148
225
|
export const SettingsApiFp = function(configuration?: Configuration) {
|
|
149
226
|
const localVarAxiosParamCreator = SettingsApiAxiosParamCreator(configuration)
|
|
150
227
|
return {
|
|
228
|
+
/**
|
|
229
|
+
*
|
|
230
|
+
* @summary The caller\'s smart-filing preferences
|
|
231
|
+
* @param {*} [options] Override http request option.
|
|
232
|
+
* @throws {RequiredError}
|
|
233
|
+
*/
|
|
234
|
+
async get2(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>> {
|
|
235
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.get2(options);
|
|
236
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
237
|
+
const localVarOperationServerBasePath = operationServerMap['SettingsApi.get2']?.[localVarOperationServerIndex]?.url;
|
|
238
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
239
|
+
},
|
|
151
240
|
/**
|
|
152
241
|
* License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
|
|
153
242
|
* @summary Coarse license info
|
|
@@ -172,6 +261,19 @@ export const SettingsApiFp = function(configuration?: Configuration) {
|
|
|
172
261
|
const localVarOperationServerBasePath = operationServerMap['SettingsApi.getSettings']?.[localVarOperationServerIndex]?.url;
|
|
173
262
|
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
174
263
|
},
|
|
264
|
+
/**
|
|
265
|
+
* A null field leaves the current value unchanged.
|
|
266
|
+
* @summary Save the caller\'s smart-filing preferences
|
|
267
|
+
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
268
|
+
* @param {*} [options] Override http request option.
|
|
269
|
+
* @throws {RequiredError}
|
|
270
|
+
*/
|
|
271
|
+
async save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AiPreferencesView>> {
|
|
272
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.save(saveAiPreferencesRequest, options);
|
|
273
|
+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
|
|
274
|
+
const localVarOperationServerBasePath = operationServerMap['SettingsApi.save']?.[localVarOperationServerIndex]?.url;
|
|
275
|
+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
|
|
276
|
+
},
|
|
175
277
|
/**
|
|
176
278
|
* Save user\'s language and theme preferences
|
|
177
279
|
* @summary Save user preferences
|
|
@@ -194,6 +296,15 @@ export const SettingsApiFp = function(configuration?: Configuration) {
|
|
|
194
296
|
export const SettingsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
195
297
|
const localVarFp = SettingsApiFp(configuration)
|
|
196
298
|
return {
|
|
299
|
+
/**
|
|
300
|
+
*
|
|
301
|
+
* @summary The caller\'s smart-filing preferences
|
|
302
|
+
* @param {*} [options] Override http request option.
|
|
303
|
+
* @throws {RequiredError}
|
|
304
|
+
*/
|
|
305
|
+
get2(options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView> {
|
|
306
|
+
return localVarFp.get2(options).then((request) => request(axios, basePath));
|
|
307
|
+
},
|
|
197
308
|
/**
|
|
198
309
|
* License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
|
|
199
310
|
* @summary Coarse license info
|
|
@@ -212,6 +323,16 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
|
|
|
212
323
|
getSettings(options?: RawAxiosRequestConfig): AxiosPromise<Settings> {
|
|
213
324
|
return localVarFp.getSettings(options).then((request) => request(axios, basePath));
|
|
214
325
|
},
|
|
326
|
+
/**
|
|
327
|
+
* A null field leaves the current value unchanged.
|
|
328
|
+
* @summary Save the caller\'s smart-filing preferences
|
|
329
|
+
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
330
|
+
* @param {*} [options] Override http request option.
|
|
331
|
+
* @throws {RequiredError}
|
|
332
|
+
*/
|
|
333
|
+
save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig): AxiosPromise<AiPreferencesView> {
|
|
334
|
+
return localVarFp.save(saveAiPreferencesRequest, options).then((request) => request(axios, basePath));
|
|
335
|
+
},
|
|
215
336
|
/**
|
|
216
337
|
* Save user\'s language and theme preferences
|
|
217
338
|
* @summary Save user preferences
|
|
@@ -229,6 +350,16 @@ export const SettingsApiFactory = function (configuration?: Configuration, baseP
|
|
|
229
350
|
* SettingsApi - object-oriented interface
|
|
230
351
|
*/
|
|
231
352
|
export class SettingsApi extends BaseAPI {
|
|
353
|
+
/**
|
|
354
|
+
*
|
|
355
|
+
* @summary The caller\'s smart-filing preferences
|
|
356
|
+
* @param {*} [options] Override http request option.
|
|
357
|
+
* @throws {RequiredError}
|
|
358
|
+
*/
|
|
359
|
+
public get2(options?: RawAxiosRequestConfig) {
|
|
360
|
+
return SettingsApiFp(this.configuration).get2(options).then((request) => request(this.axios, this.basePath));
|
|
361
|
+
}
|
|
362
|
+
|
|
232
363
|
/**
|
|
233
364
|
* License type and, for trials, the days remaining — drives the frontend trial banner. No license internals are exposed; the browser never talks to license-server.
|
|
234
365
|
* @summary Coarse license info
|
|
@@ -249,6 +380,17 @@ export class SettingsApi extends BaseAPI {
|
|
|
249
380
|
return SettingsApiFp(this.configuration).getSettings(options).then((request) => request(this.axios, this.basePath));
|
|
250
381
|
}
|
|
251
382
|
|
|
383
|
+
/**
|
|
384
|
+
* A null field leaves the current value unchanged.
|
|
385
|
+
* @summary Save the caller\'s smart-filing preferences
|
|
386
|
+
* @param {SaveAiPreferencesRequest} saveAiPreferencesRequest
|
|
387
|
+
* @param {*} [options] Override http request option.
|
|
388
|
+
* @throws {RequiredError}
|
|
389
|
+
*/
|
|
390
|
+
public save(saveAiPreferencesRequest: SaveAiPreferencesRequest, options?: RawAxiosRequestConfig) {
|
|
391
|
+
return SettingsApiFp(this.configuration).save(saveAiPreferencesRequest, options).then((request) => request(this.axios, this.basePath));
|
|
392
|
+
}
|
|
393
|
+
|
|
252
394
|
/**
|
|
253
395
|
* Save user\'s language and theme preferences
|
|
254
396
|
* @summary Save user preferences
|