Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit e2d54e9

Browse files
Merge pull request #284 from regulaforensics/ffa149d3
Commit: ffa149d3
2 parents 6830986 + 9992066 commit e2d54e9

File tree

8 files changed

+312
-19
lines changed

8 files changed

+312
-19
lines changed

‎src/.openapi-generator/FILES‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
api/healthcheck-api.ts
22
api/process-api.ts
3+
api/resources-api.ts
34
api/transaction-api.ts
45
base.ts
56
common.ts
@@ -34,6 +35,8 @@ models/container-list.ts
3435
models/critical.ts
3536
models/cross-source-value-comparison.ts
3637
models/data-module.ts
38+
models/database-document-list.ts
39+
models/database-document.ts
3740
models/details-optical.ts
3841
models/details-rfid.ts
3942
models/device-info-documents-database.ts

‎src/api/resources-api.ts‎

Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/* tslint:disable */
2+
/* eslint-disable */
3+
/**
4+
* NOTE: This file is auto generated by OpenAPI Generator.
5+
* Do not edit the file manually.
6+
*/
7+
8+
9+
import type { Configuration } from '../configuration';
10+
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
11+
import globalAxios from 'axios';
12+
// Some imports not used depending on template conditions
13+
// @ts-ignore
14+
import { DUMMY_BASE_URL, assertParamExists, setApiKeyToObject, setBasicAuthToObject, setBearerAuthToObject, setOAuthToObject, setSearchParams, serializeDataIfNeeded, toPathString, createRequestFunction } from '../common';
15+
// @ts-ignore
16+
import { BASE_PATH, COLLECTION_FORMATS, type RequestArgs, BaseAPI, RequiredError, operationServerMap } from '../base';
17+
// @ts-ignore
18+
import type { DatabaseDocumentList } from '../models';
19+
/**
20+
* ResourcesApi - axios parameter creator
21+
* @export
22+
*/
23+
export const ResourcesApiAxiosParamCreator = function (configuration?: Configuration) {
24+
return {
25+
/**
26+
*
27+
* @summary Returns the list of documents stored in the database that the Web Service API is running with.
28+
* @param {*} [options] Override http request option.
29+
* @throws {RequiredError}
30+
*/
31+
doclist: async (options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
32+
const localVarPath = `/api/doclist`;
33+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
34+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
35+
let baseOptions;
36+
if (configuration) {
37+
baseOptions = configuration.baseOptions;
38+
}
39+
40+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
41+
const localVarHeaderParameter = {} as any;
42+
const localVarQueryParameter = {} as any;
43+
44+
45+
46+
setSearchParams(localVarUrlObj, localVarQueryParameter);
47+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
48+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
49+
50+
return {
51+
url: toPathString(localVarUrlObj),
52+
options: localVarRequestOptions,
53+
};
54+
},
55+
}
56+
};
57+
58+
/**
59+
* ResourcesApi - functional programming interface
60+
* @export
61+
*/
62+
export const ResourcesApiFp = function(configuration?: Configuration) {
63+
const localVarAxiosParamCreator = ResourcesApiAxiosParamCreator(configuration)
64+
return {
65+
/**
66+
*
67+
* @summary Returns the list of documents stored in the database that the Web Service API is running with.
68+
* @param {*} [options] Override http request option.
69+
* @throws {RequiredError}
70+
*/
71+
async doclist(options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DatabaseDocumentList>> {
72+
const localVarAxiosArgs = await localVarAxiosParamCreator.doclist(options);
73+
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
74+
const localVarOperationServerBasePath = operationServerMap['ResourcesApi.doclist']?.[localVarOperationServerIndex]?.url;
75+
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
76+
},
77+
}
78+
};
79+
80+
/**
81+
* ResourcesApi - factory interface
82+
* @export
83+
*/
84+
export const ResourcesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
85+
const localVarFp = ResourcesApiFp(configuration)
86+
return {
87+
/**
88+
*
89+
* @summary Returns the list of documents stored in the database that the Web Service API is running with.
90+
* @param {*} [options] Override http request option.
91+
* @throws {RequiredError}
92+
*/
93+
doclist(options?: RawAxiosRequestConfig): AxiosPromise<DatabaseDocumentList> {
94+
return localVarFp.doclist(options).then((request) => request(axios, basePath));
95+
},
96+
};
97+
};
98+
99+
/**
100+
* ResourcesApi - object-oriented interface
101+
* @export
102+
* @class ResourcesApi
103+
* @extends {BaseAPI}
104+
*/
105+
export class ResourcesApi extends BaseAPI {
106+
/**
107+
*
108+
* @summary Returns the list of documents stored in the database that the Web Service API is running with.
109+
* @param {*} [options] Override http request option.
110+
* @throws {RequiredError}
111+
* @memberof ResourcesApi
112+
*/
113+
public doclist(options?: RawAxiosRequestConfig) {
114+
return ResourcesApiFp(this.configuration).doclist(options).then((request) => request(this.axios, this.basePath));
115+
}
116+
}
117+

‎src/api/transaction-api.ts‎

Lines changed: 15 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -178,10 +178,11 @@ export const TransactionApiAxiosParamCreator = function (configuration?: Configu
178178
* @summary Reprocess
179179
* @param {string} transactionId Transaction id
180180
* @param {TransactionProcessRequest} transactionProcessRequest
181+
* @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
181182
* @param {*} [options] Override http request option.
182183
* @throws {RequiredError}
183184
*/
184-
apiV2TransactionTransactionIdProcessPost: async (transactionId: string, transactionProcessRequest: TransactionProcessRequest, options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
185+
apiV2TransactionTransactionIdProcessPost: async (transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean,options: RawAxiosRequestConfig = {}): Promise<RequestArgs> => {
185186
// verify required parameter 'transactionId' is not null or undefined
186187
assertParamExists('apiV2TransactionTransactionIdProcessPost', 'transactionId', transactionId)
187188
// verify required parameter 'transactionProcessRequest' is not null or undefined
@@ -199,6 +200,10 @@ export const TransactionApiAxiosParamCreator = function (configuration?: Configu
199200
const localVarHeaderParameter = {} as any;
200201
const localVarQueryParameter = {} as any;
201202

203+
if (useCache !== undefined) {
204+
localVarQueryParameter['useCache'] = useCache;
205+
}
206+
202207

203208

204209
localVarHeaderParameter['Content-Type'] = 'application/json';
@@ -320,11 +325,12 @@ export const TransactionApiFp = function(configuration?: Configuration) {
320325
* @summary Reprocess
321326
* @param {string} transactionId Transaction id
322327
* @param {TransactionProcessRequest} transactionProcessRequest
328+
* @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
323329
* @param {*} [options] Override http request option.
324330
* @throws {RequiredError}
325331
*/
326-
async apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionProcessResult>> {
327-
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, options);
332+
async apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean,options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TransactionProcessResult>> {
333+
const localVarAxiosArgs = await localVarAxiosParamCreator.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, useCache,options);
328334
const localVarOperationServerIndex = configuration?.serverIndex ?? 0;
329335
const localVarOperationServerBasePath = operationServerMap['TransactionApi.apiV2TransactionTransactionIdProcessPost']?.[localVarOperationServerIndex]?.url;
330336
return (axios, basePath) => createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration)(axios, localVarOperationServerBasePath || basePath);
@@ -399,11 +405,12 @@ export const TransactionApiFactory = function (configuration?: Configuration, ba
399405
* @summary Reprocess
400406
* @param {string} transactionId Transaction id
401407
* @param {TransactionProcessRequest} transactionProcessRequest
408+
* @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
402409
* @param {*} [options] Override http request option.
403410
* @throws {RequiredError}
404411
*/
405-
apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: RawAxiosRequestConfig): AxiosPromise<TransactionProcessResult> {
406-
return localVarFp.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, options).then((request) => request(axios, basePath));
412+
apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean,options?: RawAxiosRequestConfig): AxiosPromise<TransactionProcessResult> {
413+
return localVarFp.apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, useCache,options).then((request) => request(axios, basePath));
407414
},
408415
/**
409416
*
@@ -480,12 +487,13 @@ export class TransactionApi extends BaseAPI {
480487
* @summary Reprocess
481488
* @param {string} transactionId Transaction id
482489
* @param {TransactionProcessRequest} transactionProcessRequest
490+
* @param {boolean} [useCache] Get processed values from storage in case transaction has already processed.
483491
* @param {*} [options] Override http request option.
484492
* @throws {RequiredError}
485493
* @memberof TransactionApi
486494
*/
487-
public apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, options?: RawAxiosRequestConfig) {
488-
return TransactionApiFp(this.configuration).apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, options).then((request) => request(this.axios, this.basePath));
495+
public apiV2TransactionTransactionIdProcessPost(transactionId: string, transactionProcessRequest: TransactionProcessRequest, useCache?: boolean,options?: RawAxiosRequestConfig) {
496+
return TransactionApiFp(this.configuration).apiV2TransactionTransactionIdProcessPost(transactionId, transactionProcessRequest, useCache,options).then((request) => request(this.axios, this.basePath));
489497
}
490498

491499
/**

‎src/ext/document-reader.ts‎

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
import { HealthcheckApi } from '../api/healthcheck-api';
22
import { ProcessApi } from '../api/process-api';
33
import { TransactionApi } from '../api/transaction-api';
4+
import { ResourcesApi } from '../api/resources-api';
45
import { ProcessResult } from './process-result';
56
import { Configuration, ConfigurationParameters } from '../configuration';
6-
import globalAxios, { AxiosInstance, AxiosResponse } from 'axios';
7+
import globalAxios, { AxiosInstance, AxiosResponse,RawAxiosRequestConfig } from 'axios';
78
import { BASE_PATH } from '../base';
89
import {
910
ProcessRequestImage,
@@ -17,6 +18,7 @@ import {
1718
ListTransactionsByTagResponse,
1819
TransactionProcessGetResponse,
1920
Healthcheck,
21+
DatabaseDocumentList,
2022
} from '../models';
2123
import { Base64String, instanceOfProcessRequest, ProcessRequestExt } from './process-request-ext';
2224
import { ProcessRequestImageWrapper } from './process-request-image-wrapper';
@@ -26,6 +28,7 @@ export class DocumentReaderApi {
2628
private readonly healthcheckApi: HealthcheckApi;
2729
private readonly processApi: ProcessApi;
2830
private readonly transactionApi: TransactionApi;
31+
private readonly resourcesApi: ResourcesApi;
2932

3033
private license: string | undefined;
3134

@@ -37,29 +40,36 @@ export class DocumentReaderApi {
3740
this.healthcheckApi = new HealthcheckApi(new Configuration(configuration), basePath, axios);
3841
this.processApi = new ProcessApi(new Configuration(configuration), basePath, axios);
3942
this.transactionApi = new TransactionApi(new Configuration(configuration), basePath, axios);
43+
this.resourcesApi = new ResourcesApi(new Configuration(configuration), basePath, axios);
4044
}
4145

42-
async ping(xRequestID?: string): Promise<DeviceInfo> {
43-
const axiosResult = await this.healthcheckApi.ping(xRequestID);
46+
async doclist(options?: RawAxiosRequestConfig): Promise<DatabaseDocumentList> {
47+
const axiosResult = await this.resourcesApi.doclist(options);
4448
return axiosResult.data;
4549
}
4650

47-
async health(xRequestID?: string): Promise<Healthcheck> {
48-
const axiosResult = await this.healthcheckApi.healthz(xRequestID);
51+
async ping(xRequestID?: string, options?: RawAxiosRequestConfig): Promise<DeviceInfo> {
52+
const axiosResult = await this.healthcheckApi.ping(xRequestID, options);
53+
return axiosResult.data;
54+
}
55+
56+
async health(xRequestID?: string, options?: RawAxiosRequestConfig): Promise<Healthcheck> {
57+
const axiosResult = await this.healthcheckApi.healthz(xRequestID, options);
4958
return axiosResult.data;
5059
}
5160

5261
/**
5362
*
5463
* @summary Process list of documents images and return extracted data
5564
* @param {ProcessRequestExt} [request] Request options such as image, results types and etc.
65+
* @param {string} xRequestID It allows the client and server to correlate each HTTP request.
5666
* @param {*} [options] Override http request option.
5767
* @throws {RequiredError} If some request params are missed
5868
* */
5969
async process(
6070
request: ProcessRequestExt | ProcessRequestBase,
6171
xRequestID?: string,
62-
options?: any,
72+
options?: RawAxiosRequestConfig,
6373
): Promise<ProcessResult> {
6474
let baseRequest;
6575

@@ -100,17 +110,20 @@ export class DocumentReaderApi {
100110
* @summary Reprocess
101111
* @param {string} transactionId Transaction id
102112
* @param {TransactionProcessRequest} transactionProcessRequest
113+
* @param {boolean} useCache Get processed values from storage in case transaction has already processed.
103114
* @param {*} [options] Override http request option.
104115
* @throws {RequiredError}
105116
*/
106117
public reprocessTransaction(
107118
transactionId: string,
108119
transactionProcessRequest: TransactionProcessRequest,
109-
options?: any,
120+
useCache?: boolean,
121+
options?: RawAxiosRequestConfig,
110122
): Promise<AxiosResponse<TransactionProcessResult, any>> {
111123
return this.transactionApi.apiV2TransactionTransactionIdProcessPost(
112124
transactionId,
113125
transactionProcessRequest,
126+
useCache,
114127
options,
115128
);
116129
}
@@ -126,7 +139,7 @@ export class DocumentReaderApi {
126139
async getReprocessTransactionResult(
127140
transactionId: string,
128141
withImages?: boolean,
129-
options?: any,
142+
options?: RawAxiosRequestConfig,
130143
): Promise<ProcessResult> {
131144
const axiosResult = await this.transactionApi.apiV2TransactionTransactionIdResultsGet(
132145
transactionId,
@@ -143,7 +156,10 @@ export class DocumentReaderApi {
143156
* @param {*} [options] Override http request option.
144157
* @throws {RequiredError}
145158
*/
146-
async getTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<ListTransactionsByTagResponse>> {
159+
async getTransactionsByTag(
160+
tagId: string,
161+
options?: RawAxiosRequestConfig,
162+
): Promise<AxiosResponse<ListTransactionsByTagResponse>> {
147163
return this.transactionApi.apiV2TagTagIdTransactionsGet(tagId, options);
148164
}
149165

@@ -154,7 +170,10 @@ export class DocumentReaderApi {
154170
* @param {*} [options] Override http request option.
155171
* @throws {RequiredError}
156172
*/
157-
async deleteReprocessTransactionsByTag(tagId: string, options?: any): Promise<AxiosResponse<object, any>> {
173+
async deleteReprocessTransactionsByTag(
174+
tagId: string,
175+
options?: RawAxiosRequestConfig,
176+
): Promise<AxiosResponse<object, any>> {
158177
return this.transactionApi.apiV2TagTagIdDelete(tagId, options);
159178
}
160179

@@ -169,7 +188,7 @@ export class DocumentReaderApi {
169188
async getReprocessTransactionFile(
170189
transactionId: string,
171190
name: string,
172-
options?: any,
191+
options?: RawAxiosRequestConfig,
173192
): Promise<AxiosResponse<any, any>> {
174193
return this.transactionApi.apiV2TransactionTransactionIdFileGet(transactionId, name, options);
175194
}
@@ -183,7 +202,7 @@ export class DocumentReaderApi {
183202
*/
184203
async getReprocessTransactionData(
185204
transactionId: string,
186-
options?: any,
205+
options?: RawAxiosRequestConfig,
187206
): Promise<AxiosResponse<TransactionProcessGetResponse, any>> {
188207
return this.transactionApi.apiV2TransactionTransactionIdGet(transactionId, options);
189208
}

‎src/models/database-document-list.ts‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
/* tslint:disable */
2+
/* eslint-disable */
3+
/**
4+
* NOTE: This file is auto generated by OpenAPI Generator.
5+
* Do not edit the file manually.
6+
*/
7+
8+
9+
// May contain unused imports in some cases
10+
// @ts-ignore
11+
import type { DatabaseDocument } from './database-document';
12+
13+
/**
14+
*
15+
* @export
16+
* @interface DatabaseDocumentList
17+
*/
18+
export interface DatabaseDocumentList {
19+
/**
20+
* The list of documents stored in the database.
21+
* @type {Array<DatabaseDocument>}
22+
* @memberof DatabaseDocumentList
23+
*/
24+
'items': Array<DatabaseDocument>;
25+
}
26+

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /