@regulaforensics/document-reader-webclient 7.5.185-nightly → 7.5.187-rc
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/dist/main/index.cjs +1 -1
- package/dist/module/index.js +1 -1
- package/lib/index.d.ts +50 -317
- package/package.json +4 -4
package/lib/index.d.ts
CHANGED
|
@@ -423,11 +423,11 @@ export enum AuthenticityResultType {
|
|
|
423
423
|
*/
|
|
424
424
|
PHOTO_EMBED_TYPE = 512,
|
|
425
425
|
/**
|
|
426
|
-
* OVI check
|
|
426
|
+
* OVI check
|
|
427
427
|
*/
|
|
428
428
|
OVI = 1024,
|
|
429
429
|
/**
|
|
430
|
-
* Hologram presence check
|
|
430
|
+
* Hologram presence check
|
|
431
431
|
*/
|
|
432
432
|
HOLOGRAMS = 4096,
|
|
433
433
|
/**
|
|
@@ -571,7 +571,6 @@ export enum CheckDiagnose {
|
|
|
571
571
|
FIELD_POS_CORRECTOR_LANDMARKS_CHECK_ERROR = 83,
|
|
572
572
|
FIELD_POS_CORRECTOR_FACE_PRESENCE_CHECK_ERROR = 84,
|
|
573
573
|
FIELD_POS_CORRECTOR_FACE_ABSENCE_CHECK_ERROR = 85,
|
|
574
|
-
FIELD_POS_CORRECTOR_INCORRECT_HEAD_POSITION = 86,
|
|
575
574
|
OVI_IR_INVISIBLE = 90,
|
|
576
575
|
OVI_INSUFFICIENT_AREA = 91,
|
|
577
576
|
OVI_COLOR_INVARIABLE = 92,
|
|
@@ -606,7 +605,6 @@ export enum CheckDiagnose {
|
|
|
606
605
|
BARCODE_SIZE_PARAMS_ERROR = 142,
|
|
607
606
|
NOT_ALL_BARCODES_READ = 143,
|
|
608
607
|
GLARES_IN_BARCODE_AREA = 144,
|
|
609
|
-
NO_CERTIFICATE_FOR_DIGITAL_SIGNATURE_CHECK = 145,
|
|
610
608
|
PORTRAIT_COMPARISON_PORTRAITS_DIFFER = 150,
|
|
611
609
|
PORTRAIT_COMPARISON_NO_SERVICE_REPLY = 151,
|
|
612
610
|
PORTRAIT_COMPARISON_SERVICE_ERROR = 152,
|
|
@@ -636,7 +634,6 @@ export enum CheckDiagnose {
|
|
|
636
634
|
OCR_QUALITY_INVALID_FONT = 221,
|
|
637
635
|
OCR_QUALITY_INVALID_BACKGROUND = 222,
|
|
638
636
|
LASINK_INVALID_LINES_FREQUENCY = 230,
|
|
639
|
-
DOC_LIVENESS_BLACK_AND_WHITE_COPY_DETECTED = 239,
|
|
640
637
|
DOC_LIVENESS_ELECTRONIC_DEVICE_DETECTED = 240,
|
|
641
638
|
DOC_LIVENESS_INVALID_BARCODE_BACKGROUND = 241,
|
|
642
639
|
CHD_ICAO_IDB_BASE32_ERROR = 243,
|
|
@@ -670,12 +667,6 @@ export interface ImageData {
|
|
|
670
667
|
* @memberof ImageData
|
|
671
668
|
*/
|
|
672
669
|
image: string;
|
|
673
|
-
/**
|
|
674
|
-
* Image format
|
|
675
|
-
* @type {string}
|
|
676
|
-
* @memberof ImageData
|
|
677
|
-
*/
|
|
678
|
-
format?: string;
|
|
679
670
|
}
|
|
680
671
|
/**
|
|
681
672
|
* Regula Document Reader Web API
|
|
@@ -925,21 +916,13 @@ export enum SecurityFeatureType {
|
|
|
925
916
|
*/
|
|
926
917
|
PORTRAIT_COMPARISON_BARCODE_VS_CAMERA = 49,
|
|
927
918
|
/**
|
|
928
|
-
* Digital signature
|
|
919
|
+
* Digital signature сheck
|
|
929
920
|
*/
|
|
930
921
|
CHECK_DIGITAL_SIGNATURE = 50,
|
|
931
922
|
/**
|
|
932
|
-
* Contact
|
|
923
|
+
* Contact сhip check
|
|
933
924
|
*/
|
|
934
|
-
CONTACT_CHIP_CLASSIFICATION = 51
|
|
935
|
-
/**
|
|
936
|
-
* Head position check
|
|
937
|
-
*/
|
|
938
|
-
HEAD_POSITION_CHECK = 52,
|
|
939
|
-
/**
|
|
940
|
-
* Black and white copy check
|
|
941
|
-
*/
|
|
942
|
-
LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53
|
|
925
|
+
CONTACT_CHIP_CLASSIFICATION = 51
|
|
943
926
|
}
|
|
944
927
|
/**
|
|
945
928
|
*
|
|
@@ -977,6 +960,12 @@ export interface IdentResultAllOf {
|
|
|
977
960
|
* @memberof IdentResultAllOf
|
|
978
961
|
*/
|
|
979
962
|
EtalonImage?: ImageData;
|
|
963
|
+
/**
|
|
964
|
+
* Probability percent for IMAGE_PATTERN check or element\'s visibility for IR_VISIBILITY
|
|
965
|
+
* @type {number}
|
|
966
|
+
* @memberof IdentResultAllOf
|
|
967
|
+
*/
|
|
968
|
+
PercentValue?: number;
|
|
980
969
|
/**
|
|
981
970
|
*
|
|
982
971
|
* @type {AreaContainer}
|
|
@@ -1412,30 +1401,6 @@ export interface AuthenticityResultAllOf {
|
|
|
1412
1401
|
*/
|
|
1413
1402
|
AuthenticityCheckList: AuthenticityCheckList;
|
|
1414
1403
|
}
|
|
1415
|
-
/**
|
|
1416
|
-
* Regula Document Reader Web API
|
|
1417
|
-
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
1418
|
-
*
|
|
1419
|
-
* The version of the OpenAPI document: 7.2.0
|
|
1420
|
-
*
|
|
1421
|
-
*
|
|
1422
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
1423
|
-
* https://openapi-generator.tech
|
|
1424
|
-
* Do not edit the class manually.
|
|
1425
|
-
*/
|
|
1426
|
-
/**
|
|
1427
|
-
*
|
|
1428
|
-
* @export
|
|
1429
|
-
* @interface ByteArrayResultAllOf
|
|
1430
|
-
*/
|
|
1431
|
-
export interface ByteArrayResultAllOf {
|
|
1432
|
-
/**
|
|
1433
|
-
* Byte array in base64
|
|
1434
|
-
* @type {string}
|
|
1435
|
-
* @memberof ByteArrayResultAllOf
|
|
1436
|
-
*/
|
|
1437
|
-
ByteArray: string;
|
|
1438
|
-
}
|
|
1439
1404
|
/**
|
|
1440
1405
|
* Regula Document Reader Web API
|
|
1441
1406
|
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
@@ -2871,7 +2836,7 @@ export interface DocBarCodeInfoAllOf {
|
|
|
2871
2836
|
DocBarCodeInfo?: DocBarCodeInfoFieldsList;
|
|
2872
2837
|
}
|
|
2873
2838
|
/**
|
|
2874
|
-
*
|
|
2839
|
+
* Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image
|
|
2875
2840
|
* @export
|
|
2876
2841
|
* @interface DocumentImageResultAllOf
|
|
2877
2842
|
*/
|
|
@@ -5414,18 +5379,6 @@ export enum TextFieldType {
|
|
|
5414
5379
|
*/
|
|
5415
5380
|
ISO_ISSUER_ID_NUMBER = 336,
|
|
5416
5381
|
/**
|
|
5417
|
-
* DTC version
|
|
5418
|
-
*/
|
|
5419
|
-
DTC_VERSION = 337,
|
|
5420
|
-
/**
|
|
5421
|
-
* DTC ID
|
|
5422
|
-
*/
|
|
5423
|
-
DTC_ID = 338,
|
|
5424
|
-
/**
|
|
5425
|
-
* DTC date of expiry
|
|
5426
|
-
*/
|
|
5427
|
-
DTC_DATE_OF_EXPIRY = 339,
|
|
5428
|
-
/**
|
|
5429
5382
|
* GNIB number
|
|
5430
5383
|
*/
|
|
5431
5384
|
GNIB_NUMBER = 340,
|
|
@@ -6832,11 +6785,7 @@ export enum TextFieldType {
|
|
|
6832
6785
|
/**
|
|
6833
6786
|
* Date of First Positive Test Result
|
|
6834
6787
|
*/
|
|
6835
|
-
FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT = 691
|
|
6836
|
-
/**
|
|
6837
|
-
* EF.CardAccess
|
|
6838
|
-
*/
|
|
6839
|
-
EF_CARD_ACCESS = 692
|
|
6788
|
+
FT_DATE_OF_FIRST_POSITIVE_TEST_RESULT = 691
|
|
6840
6789
|
}
|
|
6841
6790
|
/**
|
|
6842
6791
|
* Regula Document Reader Web API
|
|
@@ -7648,7 +7597,6 @@ export type DocumentTypesCandidatesResult = DocumentTypesCandidatesResultAllOf &
|
|
|
7648
7597
|
export type DocumentPositionResult = DocumentPositionResultAllOf & ResultItem;
|
|
7649
7598
|
/**
|
|
7650
7599
|
* @type DocumentImageResult
|
|
7651
|
-
* Contains document image.
|
|
7652
7600
|
* @export
|
|
7653
7601
|
*/
|
|
7654
7602
|
export type DocumentImageResult = DocumentImageResultAllOf & ResultItem;
|
|
@@ -7664,11 +7612,6 @@ export type DocBarCodeInfo = DocBarCodeInfoAllOf & ResultItem;
|
|
|
7664
7612
|
* @export
|
|
7665
7613
|
*/
|
|
7666
7614
|
export type ChosenDocumentTypeResult = ChosenDocumentTypeResultAllOf & ResultItem;
|
|
7667
|
-
/**
|
|
7668
|
-
* @type ByteArrayResult
|
|
7669
|
-
* @export
|
|
7670
|
-
*/
|
|
7671
|
-
export type ByteArrayResult = ByteArrayResultAllOf & ResultItem;
|
|
7672
7615
|
/**
|
|
7673
7616
|
* @type AuthenticityResult
|
|
7674
7617
|
* @export
|
|
@@ -7749,10 +7692,10 @@ export interface ContainerList {
|
|
|
7749
7692
|
Count?: number;
|
|
7750
7693
|
/**
|
|
7751
7694
|
*
|
|
7752
|
-
* @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult
|
|
7695
|
+
* @type {Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>}
|
|
7753
7696
|
* @memberof ContainerList
|
|
7754
7697
|
*/
|
|
7755
|
-
List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult
|
|
7698
|
+
List: Array<StatusResult | TextResult | DocumentImageResult | ImagesResult | ChosenDocumentTypeResult | DocumentTypesCandidatesResult | TextDataResult | GraphicsResult | LexicalAnalysisResult | AuthenticityResult | ImageQualityResult | DocumentPositionResult | DocBarCodeInfo | LicenseResult | EncryptedRCLResult>;
|
|
7756
7699
|
}
|
|
7757
7700
|
/**
|
|
7758
7701
|
* Regula Document Reader Web API
|
|
@@ -7831,12 +7774,6 @@ export interface DocumentImage {
|
|
|
7831
7774
|
* @memberof DocumentImage
|
|
7832
7775
|
*/
|
|
7833
7776
|
image: string;
|
|
7834
|
-
/**
|
|
7835
|
-
* Image format
|
|
7836
|
-
* @type {string}
|
|
7837
|
-
* @memberof DocumentImage
|
|
7838
|
-
*/
|
|
7839
|
-
format?: string;
|
|
7840
7777
|
}
|
|
7841
7778
|
/**
|
|
7842
7779
|
*
|
|
@@ -7857,48 +7794,6 @@ export interface DocumentTypesCandidates {
|
|
|
7857
7794
|
*/
|
|
7858
7795
|
Candidates?: Array<OneCandidate>;
|
|
7859
7796
|
}
|
|
7860
|
-
/**
|
|
7861
|
-
* Regula Document Reader Web API
|
|
7862
|
-
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
7863
|
-
*
|
|
7864
|
-
* The version of the OpenAPI document: 7.2.0
|
|
7865
|
-
*
|
|
7866
|
-
*
|
|
7867
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
7868
|
-
* https://openapi-generator.tech
|
|
7869
|
-
* Do not edit the class manually.
|
|
7870
|
-
*/
|
|
7871
|
-
/**
|
|
7872
|
-
* Document database information
|
|
7873
|
-
* @export
|
|
7874
|
-
* @interface DocumentsDatabase
|
|
7875
|
-
*/
|
|
7876
|
-
export interface DocumentsDatabase {
|
|
7877
|
-
/**
|
|
7878
|
-
* Document database description
|
|
7879
|
-
* @type {string}
|
|
7880
|
-
* @memberof DocumentsDatabase
|
|
7881
|
-
*/
|
|
7882
|
-
Description?: string;
|
|
7883
|
-
/**
|
|
7884
|
-
* Date the document database was created
|
|
7885
|
-
* @type {string}
|
|
7886
|
-
* @memberof DocumentsDatabase
|
|
7887
|
-
*/
|
|
7888
|
-
ExportDate?: string;
|
|
7889
|
-
/**
|
|
7890
|
-
* Document database identifier
|
|
7891
|
-
* @type {string}
|
|
7892
|
-
* @memberof DocumentsDatabase
|
|
7893
|
-
*/
|
|
7894
|
-
ID?: string;
|
|
7895
|
-
/**
|
|
7896
|
-
* Document database version
|
|
7897
|
-
* @type {string}
|
|
7898
|
-
* @memberof DocumentsDatabase
|
|
7899
|
-
*/
|
|
7900
|
-
Version?: string;
|
|
7901
|
-
}
|
|
7902
7797
|
/**
|
|
7903
7798
|
* Regula Document Reader Web API
|
|
7904
7799
|
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
@@ -8009,10 +7904,10 @@ export interface FaceApi {
|
|
|
8009
7904
|
export interface GetTransactionsByTagResponse {
|
|
8010
7905
|
/**
|
|
8011
7906
|
* Transaction id
|
|
8012
|
-
* @type {
|
|
7907
|
+
* @type {number}
|
|
8013
7908
|
* @memberof GetTransactionsByTagResponse
|
|
8014
7909
|
*/
|
|
8015
|
-
id?:
|
|
7910
|
+
id?: number;
|
|
8016
7911
|
/**
|
|
8017
7912
|
* Transaction status
|
|
8018
7913
|
* @type {number}
|
|
@@ -8026,103 +7921,6 @@ export interface GetTransactionsByTagResponse {
|
|
|
8026
7921
|
*/
|
|
8027
7922
|
updatedAt?: string;
|
|
8028
7923
|
}
|
|
8029
|
-
/**
|
|
8030
|
-
* Regula Document Reader Web API
|
|
8031
|
-
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
8032
|
-
*
|
|
8033
|
-
* The version of the OpenAPI document: 7.2.0
|
|
8034
|
-
*
|
|
8035
|
-
*
|
|
8036
|
-
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8037
|
-
* https://openapi-generator.tech
|
|
8038
|
-
* Do not edit the class manually.
|
|
8039
|
-
*/
|
|
8040
|
-
/**
|
|
8041
|
-
* Database information.
|
|
8042
|
-
* @export
|
|
8043
|
-
* @interface HealthcheckDocumentsDatabase
|
|
8044
|
-
*/
|
|
8045
|
-
export interface HealthcheckDocumentsDatabase {
|
|
8046
|
-
/**
|
|
8047
|
-
* Database identifier.
|
|
8048
|
-
* @type {string}
|
|
8049
|
-
* @memberof HealthcheckDocumentsDatabase
|
|
8050
|
-
*/
|
|
8051
|
-
id: string | null;
|
|
8052
|
-
/**
|
|
8053
|
-
* Database version.
|
|
8054
|
-
* @type {string}
|
|
8055
|
-
* @memberof HealthcheckDocumentsDatabase
|
|
8056
|
-
*/
|
|
8057
|
-
version: string | null;
|
|
8058
|
-
/**
|
|
8059
|
-
* Date of database creation.
|
|
8060
|
-
* @type {string}
|
|
8061
|
-
* @memberof HealthcheckDocumentsDatabase
|
|
8062
|
-
*/
|
|
8063
|
-
exportDate: string | null;
|
|
8064
|
-
/**
|
|
8065
|
-
* Description of the database contents, such as the list of supported countries and documents.
|
|
8066
|
-
* @type {string}
|
|
8067
|
-
* @memberof HealthcheckDocumentsDatabase
|
|
8068
|
-
*/
|
|
8069
|
-
description: string | null;
|
|
8070
|
-
}
|
|
8071
|
-
/**
|
|
8072
|
-
*
|
|
8073
|
-
* @export
|
|
8074
|
-
* @interface Healthcheck
|
|
8075
|
-
*/
|
|
8076
|
-
export interface Healthcheck {
|
|
8077
|
-
/**
|
|
8078
|
-
* Application name.
|
|
8079
|
-
* @type {string}
|
|
8080
|
-
* @memberof Healthcheck
|
|
8081
|
-
*/
|
|
8082
|
-
app: string;
|
|
8083
|
-
/**
|
|
8084
|
-
* Unique license identifier.
|
|
8085
|
-
* @type {string}
|
|
8086
|
-
* @memberof Healthcheck
|
|
8087
|
-
*/
|
|
8088
|
-
licenseId: string | null;
|
|
8089
|
-
/**
|
|
8090
|
-
* License type.
|
|
8091
|
-
* @type {string}
|
|
8092
|
-
* @memberof Healthcheck
|
|
8093
|
-
*/
|
|
8094
|
-
licenseType: string | null;
|
|
8095
|
-
/**
|
|
8096
|
-
* License serial number.
|
|
8097
|
-
* @type {string}
|
|
8098
|
-
* @memberof Healthcheck
|
|
8099
|
-
*/
|
|
8100
|
-
licenseSerial: string | null;
|
|
8101
|
-
/**
|
|
8102
|
-
* License validity date.
|
|
8103
|
-
* @type {string}
|
|
8104
|
-
* @memberof Healthcheck
|
|
8105
|
-
*/
|
|
8106
|
-
licenseValidUntil: string | null;
|
|
8107
|
-
/**
|
|
8108
|
-
* List of supported scenarios.
|
|
8109
|
-
* @type {Array<string>}
|
|
8110
|
-
* @memberof Healthcheck
|
|
8111
|
-
*/
|
|
8112
|
-
scenarios: Array<string> | null;
|
|
8113
|
-
/**
|
|
8114
|
-
* Product version.
|
|
8115
|
-
* @type {string}
|
|
8116
|
-
* @memberof Healthcheck
|
|
8117
|
-
*/
|
|
8118
|
-
version: string | null;
|
|
8119
|
-
/**
|
|
8120
|
-
*
|
|
8121
|
-
* @type {HealthcheckDocumentsDatabase}
|
|
8122
|
-
* @memberof Healthcheck
|
|
8123
|
-
*/
|
|
8124
|
-
documentsDatabase?: HealthcheckDocumentsDatabase;
|
|
8125
|
-
}
|
|
8126
7924
|
/**
|
|
8127
7925
|
* Regula Document Reader Web API
|
|
8128
7926
|
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
@@ -8395,6 +8193,17 @@ export enum ProcessingStatus {
|
|
|
8395
8193
|
*/
|
|
8396
8194
|
TIMEOUT = 2
|
|
8397
8195
|
}
|
|
8196
|
+
/**
|
|
8197
|
+
* Regula Document Reader Web API
|
|
8198
|
+
* Documents recognition as easy as reading two bytes. # Clients: * [JavaScript](https://github.com/regulaforensics/DocumentReader-web-js-client) client for the browser and node.js based on axios * [Java](https://github.com/regulaforensics/DocumentReader-web-java-client) client compatible with jvm and android * [Python](https://github.com/regulaforensics/DocumentReader-web-python-client) 3.5+ client * [C#](https://github.com/regulaforensics/DocumentReader-web-csharp-client) client for .NET & .NET Core
|
|
8199
|
+
*
|
|
8200
|
+
* The version of the OpenAPI document: 7.2.0
|
|
8201
|
+
*
|
|
8202
|
+
*
|
|
8203
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
8204
|
+
* https://openapi-generator.tech
|
|
8205
|
+
* Do not edit the class manually.
|
|
8206
|
+
*/
|
|
8398
8207
|
/**
|
|
8399
8208
|
*
|
|
8400
8209
|
* @export
|
|
@@ -8402,53 +8211,29 @@ export enum ProcessingStatus {
|
|
|
8402
8211
|
*/
|
|
8403
8212
|
export interface TransactionInfo {
|
|
8404
8213
|
/**
|
|
8405
|
-
*
|
|
8214
|
+
*
|
|
8406
8215
|
* @type {string}
|
|
8407
8216
|
* @memberof TransactionInfo
|
|
8408
8217
|
*/
|
|
8409
8218
|
ComputerName?: string;
|
|
8410
8219
|
/**
|
|
8411
|
-
*
|
|
8220
|
+
*
|
|
8412
8221
|
* @type {string}
|
|
8413
8222
|
* @memberof TransactionInfo
|
|
8414
8223
|
*/
|
|
8415
8224
|
DateTime?: string;
|
|
8416
8225
|
/**
|
|
8417
8226
|
*
|
|
8418
|
-
* @type {DocumentsDatabase}
|
|
8419
|
-
* @memberof TransactionInfo
|
|
8420
|
-
*/
|
|
8421
|
-
DocumentsDatabase?: DocumentsDatabase;
|
|
8422
|
-
/**
|
|
8423
|
-
* System information
|
|
8424
|
-
* @type {string}
|
|
8425
|
-
* @memberof TransactionInfo
|
|
8426
|
-
*/
|
|
8427
|
-
SystemInfo?: string;
|
|
8428
|
-
/**
|
|
8429
|
-
* Transaction tag
|
|
8430
|
-
* @type {string}
|
|
8431
|
-
* @memberof TransactionInfo
|
|
8432
|
-
*/
|
|
8433
|
-
Tag?: string;
|
|
8434
|
-
/**
|
|
8435
|
-
* Transaction identifier
|
|
8436
8227
|
* @type {string}
|
|
8437
8228
|
* @memberof TransactionInfo
|
|
8438
8229
|
*/
|
|
8439
8230
|
TransactionID?: string;
|
|
8440
8231
|
/**
|
|
8441
|
-
*
|
|
8232
|
+
*
|
|
8442
8233
|
* @type {string}
|
|
8443
8234
|
* @memberof TransactionInfo
|
|
8444
8235
|
*/
|
|
8445
8236
|
UserName?: string;
|
|
8446
|
-
/**
|
|
8447
|
-
* SDK version
|
|
8448
|
-
* @type {string}
|
|
8449
|
-
* @memberof TransactionInfo
|
|
8450
|
-
*/
|
|
8451
|
-
Version?: string;
|
|
8452
8237
|
}
|
|
8453
8238
|
/**
|
|
8454
8239
|
*
|
|
@@ -9730,11 +9515,7 @@ export enum Result {
|
|
|
9730
9515
|
/**
|
|
9731
9516
|
* Contains RFID original graphics data
|
|
9732
9517
|
*/
|
|
9733
|
-
RFID_ORIGINAL_GRAPHICS = 105
|
|
9734
|
-
/**
|
|
9735
|
-
* Digital Travel Credential data
|
|
9736
|
-
*/
|
|
9737
|
-
DTC_VC = 109
|
|
9518
|
+
RFID_ORIGINAL_GRAPHICS = 105
|
|
9738
9519
|
}
|
|
9739
9520
|
/**
|
|
9740
9521
|
* Regula Document Reader Web API
|
|
@@ -9824,11 +9605,7 @@ export enum Scenario {
|
|
|
9824
9605
|
/**
|
|
9825
9606
|
* Scenario for obtaining an original image without any processing
|
|
9826
9607
|
*/
|
|
9827
|
-
CAPTURE = "Capture"
|
|
9828
|
-
/**
|
|
9829
|
-
* Processing scenario for Digital Travel Credentials (DTC-VC) data processing
|
|
9830
|
-
*/
|
|
9831
|
-
DTC = "DTC"
|
|
9608
|
+
CAPTURE = "Capture"
|
|
9832
9609
|
}
|
|
9833
9610
|
/**
|
|
9834
9611
|
* Regula Document Reader Web API
|
|
@@ -9870,12 +9647,6 @@ export enum TextPostProcessing {
|
|
|
9870
9647
|
* @interface ProcessParams
|
|
9871
9648
|
*/
|
|
9872
9649
|
export interface ProcessParams {
|
|
9873
|
-
/**
|
|
9874
|
-
* This parameter is used to generate separate DTC-VC data container from RFID session data.
|
|
9875
|
-
* @type {boolean}
|
|
9876
|
-
* @memberof ProcessParams
|
|
9877
|
-
*/
|
|
9878
|
-
generateDTCVC?: boolean;
|
|
9879
9650
|
/**
|
|
9880
9651
|
* The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.
|
|
9881
9652
|
* @type {Array<number>}
|
|
@@ -10049,17 +9820,10 @@ export interface ProcessParams {
|
|
|
10049
9820
|
*/
|
|
10050
9821
|
imageQa?: ImageQA;
|
|
10051
9822
|
/**
|
|
10052
|
-
* When enabled,
|
|
9823
|
+
* When enabled, image quality checks status affects document optical and overall status. Disabled by default.
|
|
10053
9824
|
* @type {boolean}
|
|
10054
9825
|
* @memberof ProcessParams
|
|
10055
9826
|
*/
|
|
10056
|
-
strictImageQuality?: boolean;
|
|
10057
|
-
/**
|
|
10058
|
-
* Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.
|
|
10059
|
-
* @type {boolean}
|
|
10060
|
-
* @memberof ProcessParams
|
|
10061
|
-
* @deprecated
|
|
10062
|
-
*/
|
|
10063
9827
|
respectImageQuality?: boolean;
|
|
10064
9828
|
/**
|
|
10065
9829
|
*
|
|
@@ -10211,18 +9975,6 @@ export interface ProcessParams {
|
|
|
10211
9975
|
* @memberof ProcessParams
|
|
10212
9976
|
*/
|
|
10213
9977
|
generateNumericCodes?: boolean;
|
|
10214
|
-
/**
|
|
10215
|
-
* This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed.
|
|
10216
|
-
* @type {boolean}
|
|
10217
|
-
* @memberof ProcessParams
|
|
10218
|
-
*/
|
|
10219
|
-
strictBarcodeDigitalSignatureCheck?: boolean;
|
|
10220
|
-
/**
|
|
10221
|
-
* Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc.
|
|
10222
|
-
* @type {boolean}
|
|
10223
|
-
* @memberof ProcessParams
|
|
10224
|
-
*/
|
|
10225
|
-
selectLongestNames?: boolean;
|
|
10226
9978
|
}
|
|
10227
9979
|
/**
|
|
10228
9980
|
*
|
|
@@ -10347,18 +10099,6 @@ export interface ProcessRequest {
|
|
|
10347
10099
|
passBackObject?: {
|
|
10348
10100
|
[key: string]: object;
|
|
10349
10101
|
};
|
|
10350
|
-
/**
|
|
10351
|
-
* Digital Travel Credential (DTC-VC) data in base64 format for processing
|
|
10352
|
-
* @type {string}
|
|
10353
|
-
* @memberof ProcessRequest
|
|
10354
|
-
*/
|
|
10355
|
-
dtc?: string;
|
|
10356
|
-
/**
|
|
10357
|
-
* URLs to the document images for processing.
|
|
10358
|
-
* @type {Array<string>}
|
|
10359
|
-
* @memberof ProcessRequest
|
|
10360
|
-
*/
|
|
10361
|
-
ImageUrls?: Array<string>;
|
|
10362
10102
|
}
|
|
10363
10103
|
/**
|
|
10364
10104
|
*
|
|
@@ -10438,10 +10178,10 @@ export interface TransactionImage {
|
|
|
10438
10178
|
export interface TransactionProcessGetResponse {
|
|
10439
10179
|
/**
|
|
10440
10180
|
*
|
|
10441
|
-
* @type {
|
|
10181
|
+
* @type {number}
|
|
10442
10182
|
* @memberof TransactionProcessGetResponse
|
|
10443
10183
|
*/
|
|
10444
|
-
transactionId?:
|
|
10184
|
+
transactionId?: number;
|
|
10445
10185
|
/**
|
|
10446
10186
|
*
|
|
10447
10187
|
* @type {string}
|
|
@@ -10511,12 +10251,6 @@ export interface TransactionProcessRequest {
|
|
|
10511
10251
|
passBackObject?: {
|
|
10512
10252
|
[key: string]: object;
|
|
10513
10253
|
};
|
|
10514
|
-
/**
|
|
10515
|
-
* Digital Travel Credential (DTC-VC) data in base64 format for processing
|
|
10516
|
-
* @type {string}
|
|
10517
|
-
* @memberof TransactionProcessRequest
|
|
10518
|
-
*/
|
|
10519
|
-
dtc?: string;
|
|
10520
10254
|
}
|
|
10521
10255
|
export class TextFieldExt implements TextField {
|
|
10522
10256
|
fieldType: TextFieldType;
|
|
@@ -10641,7 +10375,6 @@ export class Response {
|
|
|
10641
10375
|
status?: Status;
|
|
10642
10376
|
text?: TextExt;
|
|
10643
10377
|
images?: ImagesExt;
|
|
10644
|
-
TransactionInfo: TransactionInfo;
|
|
10645
10378
|
lowLvlResponse: LowLvlResponse;
|
|
10646
10379
|
rawResponse: ProcessResponse | InlineResponse2001;
|
|
10647
10380
|
constructor(original: ProcessResponse | InlineResponse2001);
|
|
@@ -10669,9 +10402,9 @@ export class LowLvlResponse implements ProcessResponse {
|
|
|
10669
10402
|
imagesResult(): ImagesResult | undefined;
|
|
10670
10403
|
barcodeResult(): DocBarCodeInfo | undefined;
|
|
10671
10404
|
documentTypeResults(): Array<ChosenDocumentTypeResult> | undefined;
|
|
10672
|
-
resultByType(type: Result):
|
|
10673
|
-
resultByTypeAndPage(type: Result, page_idx?: number):
|
|
10674
|
-
resultsByType(type: Result):
|
|
10405
|
+
resultByType(type: Result): ResultItem | undefined;
|
|
10406
|
+
resultByTypeAndPage(type: Result, page_idx?: number): ResultItem | undefined;
|
|
10407
|
+
resultsByType(type: Result): Array<ResultItem | AuthenticityResult | ImageQualityCheckList>;
|
|
10675
10408
|
}
|
|
10676
10409
|
export interface ProcessRequestImageWrapper extends Omit<ProcessRequestImage, 'ImageData'> {
|
|
10677
10410
|
ImageData: ArrayBuffer | Base64String;
|
|
@@ -10727,25 +10460,25 @@ export class DocumentReaderApi {
|
|
|
10727
10460
|
/**
|
|
10728
10461
|
*
|
|
10729
10462
|
* @summary Reprocess
|
|
10730
|
-
* @param {
|
|
10463
|
+
* @param {number} transactionId Transaction id
|
|
10731
10464
|
* @param {TransactionProcessRequest} transactionProcessRequest
|
|
10732
10465
|
* @param {*} [options] Override http request option.
|
|
10733
10466
|
* @throws {RequiredError}
|
|
10734
10467
|
*/
|
|
10735
|
-
reprocessTransaction(transactionId:
|
|
10468
|
+
reprocessTransaction(transactionId: number, transactionProcessRequest: TransactionProcessRequest, options?: any): Promise<AxiosResponse<InlineResponse200, any>>;
|
|
10736
10469
|
/**
|
|
10737
10470
|
*
|
|
10738
10471
|
* @summary Get Reprocess transaction result
|
|
10739
|
-
* @param {
|
|
10472
|
+
* @param {number} transactionId Transaction id
|
|
10740
10473
|
* @param {boolean} [withImages] With base64 images or url
|
|
10741
10474
|
* @param {*} [options] Override http request option.
|
|
10742
10475
|
* @throws {RequiredError}
|
|
10743
10476
|
*/
|
|
10744
|
-
getReprocessTransactionResult(transactionId:
|
|
10477
|
+
getReprocessTransactionResult(transactionId: number, withImages?: boolean, options?: any): Promise<Response>;
|
|
10745
10478
|
/**
|
|
10746
10479
|
*
|
|
10747
10480
|
* @summary Get transactions by tag
|
|
10748
|
-
* @param {
|
|
10481
|
+
* @param {number} tagId Tag id
|
|
10749
10482
|
* @param {*} [options] Override http request option.
|
|
10750
10483
|
* @throws {RequiredError}
|
|
10751
10484
|
*/
|
|
@@ -10753,27 +10486,27 @@ export class DocumentReaderApi {
|
|
|
10753
10486
|
/**
|
|
10754
10487
|
*
|
|
10755
10488
|
* @summary Delete Reprocess transactions by tag
|
|
10756
|
-
* @param {
|
|
10489
|
+
* @param {number} tagId Tag id
|
|
10757
10490
|
* @param {*} [options] Override http request option.
|
|
10758
10491
|
* @throws {RequiredError}
|
|
10759
10492
|
*/
|
|
10760
|
-
deleteReprocessTransactionsByTag(tagId:
|
|
10493
|
+
deleteReprocessTransactionsByTag(tagId: number, options?: any): Promise<AxiosResponse<object, any>>;
|
|
10761
10494
|
/**
|
|
10762
10495
|
*
|
|
10763
10496
|
* @summary Get Reprocess transaction file
|
|
10764
|
-
* @param {
|
|
10497
|
+
* @param {number} transactionId Transaction id
|
|
10765
10498
|
* @param {string} name File name
|
|
10766
10499
|
* @param {*} [options] Override http request option.
|
|
10767
10500
|
* @throws {RequiredError}
|
|
10768
10501
|
*/
|
|
10769
|
-
getReprocessTransactionFile(transactionId:
|
|
10502
|
+
getReprocessTransactionFile(transactionId: number, name: string, options?: any): Promise<AxiosResponse<any, any>>;
|
|
10770
10503
|
/**
|
|
10771
10504
|
*
|
|
10772
10505
|
* @summary Get Reprocess transaction data
|
|
10773
|
-
* @param {
|
|
10506
|
+
* @param {number} transactionId Transaction id
|
|
10774
10507
|
* @param {*} [options] Override http request option.
|
|
10775
10508
|
* @throws {RequiredError}
|
|
10776
10509
|
*/
|
|
10777
|
-
getReprocessTransactionData(transactionId:
|
|
10510
|
+
getReprocessTransactionData(transactionId: number, options?: any): Promise<AxiosResponse<TransactionProcessGetResponse, any>>;
|
|
10778
10511
|
}
|
|
10779
10512
|
export function requestToBaseRequest(request: ProcessRequestExt): ProcessRequest;
|
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
"> 0.2%",
|
|
6
6
|
"not dead"
|
|
7
7
|
],
|
|
8
|
-
"version": "7.5.
|
|
8
|
+
"version": "7.5.187-rc",
|
|
9
9
|
"description": "Regula Document Reader js client for the browser and node.js based on axios",
|
|
10
10
|
"author": "Regula Forensics, Inc.",
|
|
11
11
|
"keywords": [
|
|
@@ -51,8 +51,8 @@
|
|
|
51
51
|
"*.{js,ts}": "eslint --fix"
|
|
52
52
|
},
|
|
53
53
|
"dependencies": {
|
|
54
|
-
"@swc/helpers": "^0.5.
|
|
55
|
-
"axios": "^1.7.
|
|
54
|
+
"@swc/helpers": "^0.5.12",
|
|
55
|
+
"axios": "^1.7.4",
|
|
56
56
|
"base64-arraybuffer": "^1.0.2",
|
|
57
57
|
"pako": "^2.1.0"
|
|
58
58
|
},
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
"eslint-config-prettier": "^9.1.0",
|
|
67
67
|
"eslint-plugin-prettier": "^5.2.1",
|
|
68
68
|
"husky": "^9.1.5",
|
|
69
|
-
"lint-staged": "^15.2.
|
|
69
|
+
"lint-staged": "^15.2.9",
|
|
70
70
|
"parcel": "^2.12.0",
|
|
71
71
|
"prettier": "^3.3.3",
|
|
72
72
|
"typescript": "^5.3.2"
|