@regulaforensics/vp-frontend-face-components 2.0.1 → 3.0.1

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.
Files changed (238) hide show
  1. package/README.md +363 -167
  2. package/dist/main.js +1 -1
  3. package/dist/main.js.LICENSE.txt +18 -8
  4. package/lib/index.d.ts +232 -0
  5. package/package.json +5 -83
  6. package/lib/common/BackCameraIcon.d.ts +0 -6
  7. package/lib/common/Button.d.ts +0 -7
  8. package/lib/common/CameraChangeIcon.d.ts +0 -6
  9. package/lib/common/CameraIcon.d.ts +0 -6
  10. package/lib/common/CheckIcon.d.ts +0 -6
  11. package/lib/common/CrossIcon.d.ts +0 -6
  12. package/lib/common/DocReaderCameraDisabled.d.ts +0 -5
  13. package/lib/common/DocReaderCameraPreparing.d.ts +0 -5
  14. package/lib/common/DocReaderFlip.d.ts +0 -5
  15. package/lib/common/DocReaderProcessing.d.ts +0 -5
  16. package/lib/common/DocReaderProcessingError.d.ts +0 -5
  17. package/lib/common/DocReaderProcessingFinished.d.ts +0 -6
  18. package/lib/common/DocReaderSearch.d.ts +0 -5
  19. package/lib/common/ErrorIcon.d.ts +0 -6
  20. package/lib/common/FromCameraIcon.d.ts +0 -5
  21. package/lib/common/FromGalleryIcon.d.ts +0 -5
  22. package/lib/common/FrontCameraIcon.d.ts +0 -6
  23. package/lib/common/FullscreenExitIcon.d.ts +0 -6
  24. package/lib/common/FullscreenIcon.d.ts +0 -6
  25. package/lib/common/Icon.d.ts +0 -64
  26. package/lib/common/Message.d.ts +0 -8
  27. package/lib/common/NoGlareIconLivenessDetection.d.ts +0 -5
  28. package/lib/common/NoSmilingIconLivenessDetection.d.ts +0 -5
  29. package/lib/common/PortraitOrientationOnlyIcon.d.ts +0 -6
  30. package/lib/common/RegulaLogo.d.ts +0 -6
  31. package/lib/common/RegulaLogoLivenessDetection.d.ts +0 -5
  32. package/lib/common/SnapshotIcon.d.ts +0 -6
  33. package/lib/common/Spinner.d.ts +0 -3
  34. package/lib/common/SquareIcon.d.ts +0 -6
  35. package/lib/common/StopIcon.d.ts +0 -6
  36. package/lib/common/VerifiedIcon.d.ts +0 -6
  37. package/lib/components/ButtonFaceLiveness.d.ts +0 -7
  38. package/lib/components/CameraCapture.d.ts +0 -9
  39. package/lib/components/CameraSnapshot.d.ts +0 -2
  40. package/lib/components/CameraSnapshotFileCapture.d.ts +0 -10
  41. package/lib/components/DocumentCapture.d.ts +0 -11
  42. package/lib/components/DocumentContainer.d.ts +0 -11
  43. package/lib/components/DocumentReader.d.ts +0 -2
  44. package/lib/components/DocumentReaderFileCapture.d.ts +0 -12
  45. package/lib/components/DocumentReaderLayout.d.ts +0 -22
  46. package/lib/components/DocumentReaderStartScreen.d.ts +0 -10
  47. package/lib/components/ErrorBoundary.d.ts +0 -18
  48. package/lib/components/FaceCapture.d.ts +0 -25
  49. package/lib/components/FaceDetection.d.ts +0 -2
  50. package/lib/components/FaceFullScreenOverlay.d.ts +0 -10
  51. package/lib/components/FaceHintAnimaition.d.ts +0 -16
  52. package/lib/components/FaceLayout.d.ts +0 -23
  53. package/lib/components/FaceLiveness.d.ts +0 -2
  54. package/lib/components/InfoScreen.d.ts +0 -11
  55. package/lib/components/InfoScreenFaceLiveness.d.ts +0 -12
  56. package/lib/components/InstructionVideoScreen.d.ts +0 -9
  57. package/lib/components/ProcessScreen.d.ts +0 -6
  58. package/lib/components/ProcessScreenFaceLiveness.d.ts +0 -6
  59. package/lib/components/RetryScreenFaceLiveness.d.ts +0 -7
  60. package/lib/components/SectorAnimationSvg.d.ts +0 -11
  61. package/lib/components/WebCamera.d.ts +0 -19
  62. package/lib/constants.d.ts +0 -668
  63. package/lib/contexts/DocumentAttributesContext.d.ts +0 -25
  64. package/lib/contexts/DocumentSDKContext.d.ts +0 -8
  65. package/lib/contexts/FaceAttributesContext.d.ts +0 -26
  66. package/lib/hoc/withDocumentAttributesContext.d.ts +0 -4
  67. package/lib/hoc/withDocumentSDKContext.d.ts +0 -3
  68. package/lib/hoc/withFaceAttributesContext.d.ts +0 -4
  69. package/lib/hoc/withLocalize.d.ts +0 -8
  70. package/lib/hooks/useDocumentReaderSeries.d.ts +0 -19
  71. package/lib/hooks/useDocumentReaderSingle.d.ts +0 -14
  72. package/lib/hooks/useFaceLiveness.d.ts +0 -41
  73. package/lib/hooks/useImageInputParam.d.ts +0 -7
  74. package/lib/hooks/useOrientationChange.d.ts +0 -10
  75. package/lib/hooks/useStateCallback.d.ts +0 -1
  76. package/lib/hooks/useStream.d.ts +0 -10
  77. package/lib/hooks/useUserAgent.d.ts +0 -3
  78. package/lib/hooks/useWindowBlur.d.ts +0 -2
  79. package/lib/i18n/dictionaries/_dictionaries.d.ts +0 -2275
  80. package/lib/index-document.d.ts +0 -4
  81. package/lib/index-face.d.ts +0 -1
  82. package/lib/media-resources/resourcesBase64.d.ts +0 -7
  83. package/lib/models/CameraModel.d.ts +0 -9
  84. package/lib/models/CustomError.d.ts +0 -7
  85. package/lib/models/DocReaderWebclient/ext/authenticity/authenticity.d.ts +0 -32
  86. package/lib/models/DocReaderWebclient/ext/authenticity/fiber.d.ts +0 -7
  87. package/lib/models/DocReaderWebclient/ext/authenticity/ident.d.ts +0 -8
  88. package/lib/models/DocReaderWebclient/ext/authenticity/image-ident.d.ts +0 -7
  89. package/lib/models/DocReaderWebclient/ext/authenticity/index.d.ts +0 -5
  90. package/lib/models/DocReaderWebclient/ext/authenticity/ocr-security-text.d.ts +0 -7
  91. package/lib/models/DocReaderWebclient/ext/authenticity/security-feature.d.ts +0 -8
  92. package/lib/models/DocReaderWebclient/ext/images.d.ts +0 -16
  93. package/lib/models/DocReaderWebclient/ext/index.d.ts +0 -6
  94. package/lib/models/DocReaderWebclient/ext/process-request-image.d.ts +0 -5
  95. package/lib/models/DocReaderWebclient/ext/process-request.d.ts +0 -38
  96. package/lib/models/DocReaderWebclient/ext/process-response.d.ts +0 -36
  97. package/lib/models/DocReaderWebclient/ext/text-field.d.ts +0 -40
  98. package/lib/models/DocReaderWebclient/ext/text.d.ts +0 -14
  99. package/lib/models/DocReaderWebclient/models/area-array.d.ts +0 -32
  100. package/lib/models/DocReaderWebclient/models/area-container.d.ts +0 -38
  101. package/lib/models/DocReaderWebclient/models/authenticity-check-list.d.ts +0 -31
  102. package/lib/models/DocReaderWebclient/models/authenticity-check-result-item.d.ts +0 -38
  103. package/lib/models/DocReaderWebclient/models/authenticity-check-result.d.ts +0 -43
  104. package/lib/models/DocReaderWebclient/models/authenticity-result-all-of.d.ts +0 -25
  105. package/lib/models/DocReaderWebclient/models/authenticity-result-type.d.ts +0 -33
  106. package/lib/models/DocReaderWebclient/models/authenticity-result.d.ts +0 -18
  107. package/lib/models/DocReaderWebclient/models/bc-pdf417-info.d.ts +0 -54
  108. package/lib/models/DocReaderWebclient/models/bc-roidetect.d.ts +0 -42
  109. package/lib/models/DocReaderWebclient/models/check-diagnose.d.ts +0 -98
  110. package/lib/models/DocReaderWebclient/models/check-result.d.ts +0 -30
  111. package/lib/models/DocReaderWebclient/models/chosen-document-type-result-all-of.d.ts +0 -25
  112. package/lib/models/DocReaderWebclient/models/chosen-document-type-result.d.ts +0 -19
  113. package/lib/models/DocReaderWebclient/models/chosen-document-type.d.ts +0 -74
  114. package/lib/models/DocReaderWebclient/models/container-list.d.ts +0 -45
  115. package/lib/models/DocReaderWebclient/models/critical.d.ts +0 -26
  116. package/lib/models/DocReaderWebclient/models/cross-source-value-comparison.d.ts +0 -38
  117. package/lib/models/DocReaderWebclient/models/data-module.d.ts +0 -48
  118. package/lib/models/DocReaderWebclient/models/details-optical.d.ts +0 -67
  119. package/lib/models/DocReaderWebclient/models/details-rfid.d.ts +0 -61
  120. package/lib/models/DocReaderWebclient/models/device-info.d.ts +0 -54
  121. package/lib/models/DocReaderWebclient/models/doc-bar-code-info-all-of.d.ts +0 -31
  122. package/lib/models/DocReaderWebclient/models/doc-bar-code-info.d.ts +0 -19
  123. package/lib/models/DocReaderWebclient/models/doc-visual-extended-field.d.ts +0 -70
  124. package/lib/models/DocReaderWebclient/models/doc-visual-extended-info.d.ts +0 -25
  125. package/lib/models/DocReaderWebclient/models/document-format.d.ts +0 -70
  126. package/lib/models/DocReaderWebclient/models/document-image-result-all-of.d.ts +0 -25
  127. package/lib/models/DocReaderWebclient/models/document-image-result.d.ts +0 -18
  128. package/lib/models/DocReaderWebclient/models/document-image.d.ts +0 -24
  129. package/lib/models/DocReaderWebclient/models/document-position-result-all-of.d.ts +0 -25
  130. package/lib/models/DocReaderWebclient/models/document-position-result.d.ts +0 -19
  131. package/lib/models/DocReaderWebclient/models/document-position.d.ts +0 -80
  132. package/lib/models/DocReaderWebclient/models/document-type-recognition-result.d.ts +0 -30
  133. package/lib/models/DocReaderWebclient/models/document-type.d.ts +0 -246
  134. package/lib/models/DocReaderWebclient/models/document-types-candidates-list.d.ts +0 -32
  135. package/lib/models/DocReaderWebclient/models/document-types-candidates-result-all-of.d.ts +0 -25
  136. package/lib/models/DocReaderWebclient/models/document-types-candidates-result.d.ts +0 -18
  137. package/lib/models/DocReaderWebclient/models/document-types-candidates.d.ts +0 -32
  138. package/lib/models/DocReaderWebclient/models/encrypted-rclresult-all-of.d.ts +0 -24
  139. package/lib/models/DocReaderWebclient/models/encrypted-rclresult.d.ts +0 -18
  140. package/lib/models/DocReaderWebclient/models/fdsidlist.d.ts +0 -80
  141. package/lib/models/DocReaderWebclient/models/fiber-result-all-of.d.ts +0 -74
  142. package/lib/models/DocReaderWebclient/models/fiber-result.d.ts +0 -18
  143. package/lib/models/DocReaderWebclient/models/graphic-field-type.d.ts +0 -118
  144. package/lib/models/DocReaderWebclient/models/graphic-field.d.ts +0 -63
  145. package/lib/models/DocReaderWebclient/models/graphic-fields-list.d.ts +0 -25
  146. package/lib/models/DocReaderWebclient/models/graphics-result-all-of.d.ts +0 -25
  147. package/lib/models/DocReaderWebclient/models/graphics-result.d.ts +0 -19
  148. package/lib/models/DocReaderWebclient/models/ident-result-all-of.d.ts +0 -65
  149. package/lib/models/DocReaderWebclient/models/ident-result.d.ts +0 -18
  150. package/lib/models/DocReaderWebclient/models/image-data.d.ts +0 -24
  151. package/lib/models/DocReaderWebclient/models/image-qa.d.ts +0 -54
  152. package/lib/models/DocReaderWebclient/models/image-quality-check-list.d.ts +0 -32
  153. package/lib/models/DocReaderWebclient/models/image-quality-check-type.d.ts +0 -50
  154. package/lib/models/DocReaderWebclient/models/image-quality-check.d.ts +0 -64
  155. package/lib/models/DocReaderWebclient/models/image-quality-result-all-of.d.ts +0 -25
  156. package/lib/models/DocReaderWebclient/models/image-quality-result.d.ts +0 -18
  157. package/lib/models/DocReaderWebclient/models/images-available-source.d.ts +0 -31
  158. package/lib/models/DocReaderWebclient/models/images-field-value.d.ts +0 -70
  159. package/lib/models/DocReaderWebclient/models/images-field.d.ts +0 -38
  160. package/lib/models/DocReaderWebclient/models/images-result-all-of.d.ts +0 -25
  161. package/lib/models/DocReaderWebclient/models/images-result.d.ts +0 -18
  162. package/lib/models/DocReaderWebclient/models/images.d.ts +0 -32
  163. package/lib/models/DocReaderWebclient/models/index.d.ts +0 -123
  164. package/lib/models/DocReaderWebclient/models/lcid.d.ts +0 -582
  165. package/lib/models/DocReaderWebclient/models/lexical-analysis-result-all-of.d.ts +0 -25
  166. package/lib/models/DocReaderWebclient/models/lexical-analysis-result.d.ts +0 -19
  167. package/lib/models/DocReaderWebclient/models/license-result-all-of.d.ts +0 -24
  168. package/lib/models/DocReaderWebclient/models/license-result.d.ts +0 -18
  169. package/lib/models/DocReaderWebclient/models/light.d.ts +0 -34
  170. package/lib/models/DocReaderWebclient/models/list-verified-fields.d.ts +0 -25
  171. package/lib/models/DocReaderWebclient/models/log-level.d.ts +0 -23
  172. package/lib/models/DocReaderWebclient/models/measure-system.d.ts +0 -26
  173. package/lib/models/DocReaderWebclient/models/mrzformat.d.ts +0 -24
  174. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result-all-of.d.ts +0 -81
  175. package/lib/models/DocReaderWebclient/models/ocrsecurity-text-result.d.ts +0 -18
  176. package/lib/models/DocReaderWebclient/models/one-candidate.d.ts +0 -74
  177. package/lib/models/DocReaderWebclient/models/original-symbol.d.ts +0 -37
  178. package/lib/models/DocReaderWebclient/models/parray-field.d.ts +0 -81
  179. package/lib/models/DocReaderWebclient/models/per-document-config.d.ts +0 -30
  180. package/lib/models/DocReaderWebclient/models/photo-ident-result-all-of.d.ts +0 -76
  181. package/lib/models/DocReaderWebclient/models/photo-ident-result.d.ts +0 -18
  182. package/lib/models/DocReaderWebclient/models/point-array.d.ts +0 -25
  183. package/lib/models/DocReaderWebclient/models/point.d.ts +0 -30
  184. package/lib/models/DocReaderWebclient/models/points-container.d.ts +0 -31
  185. package/lib/models/DocReaderWebclient/models/process-params.d.ts +0 -254
  186. package/lib/models/DocReaderWebclient/models/process-request-image.d.ts +0 -38
  187. package/lib/models/DocReaderWebclient/models/process-request.d.ts +0 -60
  188. package/lib/models/DocReaderWebclient/models/process-response.d.ts +0 -66
  189. package/lib/models/DocReaderWebclient/models/process-system-info.d.ts +0 -30
  190. package/lib/models/DocReaderWebclient/models/processing-status.d.ts +0 -30
  191. package/lib/models/DocReaderWebclient/models/raw-image-container-list.d.ts +0 -31
  192. package/lib/models/DocReaderWebclient/models/rectangle-coordinates.d.ts +0 -42
  193. package/lib/models/DocReaderWebclient/models/result-item.d.ts +0 -48
  194. package/lib/models/DocReaderWebclient/models/result.d.ts +0 -98
  195. package/lib/models/DocReaderWebclient/models/rfid-location.d.ts +0 -30
  196. package/lib/models/DocReaderWebclient/models/rfid-origin.d.ts +0 -42
  197. package/lib/models/DocReaderWebclient/models/scenario.d.ts +0 -36
  198. package/lib/models/DocReaderWebclient/models/security-feature-result-all-of.d.ts +0 -59
  199. package/lib/models/DocReaderWebclient/models/security-feature-result.d.ts +0 -18
  200. package/lib/models/DocReaderWebclient/models/security-feature-type.d.ts +0 -49
  201. package/lib/models/DocReaderWebclient/models/source-validity.d.ts +0 -32
  202. package/lib/models/DocReaderWebclient/models/source.d.ts +0 -23
  203. package/lib/models/DocReaderWebclient/models/status-result-all-of.d.ts +0 -25
  204. package/lib/models/DocReaderWebclient/models/status-result.d.ts +0 -18
  205. package/lib/models/DocReaderWebclient/models/status.d.ts +0 -63
  206. package/lib/models/DocReaderWebclient/models/string-recognition-result.d.ts +0 -25
  207. package/lib/models/DocReaderWebclient/models/symbol-candidate.d.ts +0 -30
  208. package/lib/models/DocReaderWebclient/models/symbol-recognition-result.d.ts +0 -32
  209. package/lib/models/DocReaderWebclient/models/text-available-source.d.ts +0 -38
  210. package/lib/models/DocReaderWebclient/models/text-data-result-all-of.d.ts +0 -25
  211. package/lib/models/DocReaderWebclient/models/text-data-result.d.ts +0 -19
  212. package/lib/models/DocReaderWebclient/models/text-field-type.d.ts +0 -2386
  213. package/lib/models/DocReaderWebclient/models/text-field-value.d.ts +0 -70
  214. package/lib/models/DocReaderWebclient/models/text-field.d.ts +0 -84
  215. package/lib/models/DocReaderWebclient/models/text-post-processing.d.ts +0 -22
  216. package/lib/models/DocReaderWebclient/models/text-result-all-of.d.ts +0 -25
  217. package/lib/models/DocReaderWebclient/models/text-result.d.ts +0 -18
  218. package/lib/models/DocReaderWebclient/models/text.d.ts +0 -51
  219. package/lib/models/DocReaderWebclient/models/transaction-info.d.ts +0 -42
  220. package/lib/models/DocReaderWebclient/models/verification-result.d.ts +0 -38
  221. package/lib/models/DocReaderWebclient/models/verified-field-map.d.ts +0 -63
  222. package/lib/models/DocReaderWebclient/models/visibility.d.ts +0 -23
  223. package/lib/models/ImageModel.d.ts +0 -7
  224. package/lib/services/DebugService.d.ts +0 -17
  225. package/lib/services/DeviceOrientationService.d.ts +0 -18
  226. package/lib/services/DocumentReaderProcessor.d.ts +0 -43
  227. package/lib/services/DocumentReaderService.d.ts +0 -37
  228. package/lib/services/EventEmitter.d.ts +0 -9
  229. package/lib/services/FaceLivenessService.d.ts +0 -70
  230. package/lib/services/FaceService.d.ts +0 -39
  231. package/lib/services/StreamRecorderService.d.ts +0 -24
  232. package/lib/types.d.ts +0 -361
  233. package/lib/utils.d.ts +0 -30
  234. package/lib/web-components/CameraSnapshot.d.ts +0 -14
  235. package/lib/web-components/DocumentReader.d.ts +0 -14
  236. package/lib/web-components/FaceDetection.d.ts +0 -11
  237. package/lib/web-components/FaceLiveness.d.ts +0 -17
  238. package/lib/web-components/FullScreenContainer.d.ts +0 -4
@@ -1,25 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { DocumentTypesCandidatesList } from './document-types-candidates-list';
13
- /**
14
- *
15
- * @export
16
- * @interface DocumentTypesCandidatesResultAllOf
17
- */
18
- export interface DocumentTypesCandidatesResultAllOf {
19
- /**
20
- *
21
- * @type {DocumentTypesCandidatesList}
22
- * @memberof DocumentTypesCandidatesResultAllOf
23
- */
24
- CandidatesList?: DocumentTypesCandidatesList;
25
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { DocumentTypesCandidatesResultAllOf } from './document-types-candidates-result-all-of';
13
- import { ResultItem } from './result-item';
14
- /**
15
- * @type DocumentTypesCandidatesResult
16
- * @export
17
- */
18
- export declare type DocumentTypesCandidatesResult = DocumentTypesCandidatesResultAllOf & ResultItem;
@@ -1,32 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { DocumentTypeRecognitionResult } from './document-type-recognition-result';
13
- import { OneCandidate } from './one-candidate';
14
- /**
15
- *
16
- * @export
17
- * @interface DocumentTypesCandidates
18
- */
19
- export interface DocumentTypesCandidates {
20
- /**
21
- *
22
- * @type {DocumentTypeRecognitionResult}
23
- * @memberof DocumentTypesCandidates
24
- */
25
- RecResult?: DocumentTypeRecognitionResult;
26
- /**
27
- *
28
- * @type {Array<OneCandidate>}
29
- * @memberof DocumentTypesCandidates
30
- */
31
- Candidates?: Array<OneCandidate>;
32
- }
@@ -1,24 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- * Contains encrypted result container list
14
- * @export
15
- * @interface EncryptedRCLResultAllOf
16
- */
17
- export interface EncryptedRCLResultAllOf {
18
- /**
19
- * Base64 encoded data
20
- * @type {string}
21
- * @memberof EncryptedRCLResultAllOf
22
- */
23
- EncryptedRCL: string;
24
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { EncryptedRCLResultAllOf } from './encrypted-rclresult-all-of';
13
- import { ResultItem } from './result-item';
14
- /**
15
- * @type EncryptedRCLResult
16
- * @export
17
- */
18
- export declare type EncryptedRCLResult = EncryptedRCLResultAllOf & ResultItem;
@@ -1,80 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { DocumentFormat } from './document-format';
13
- import { DocumentType } from './document-type';
14
- /**
15
- * Extended document type info and Regula\'s \'Information Reference Systems\' links
16
- * @export
17
- * @interface FDSIDList
18
- */
19
- export interface FDSIDList {
20
- /**
21
- * ICAO code of the issuing country
22
- * @type {string}
23
- * @memberof FDSIDList
24
- */
25
- ICAOCode?: string;
26
- /**
27
- * Document identifiers in \'Information Reference Systems\'
28
- * @type {Array<number>}
29
- * @memberof FDSIDList
30
- */
31
- List?: Array<number>;
32
- /**
33
- *
34
- * @type {DocumentType}
35
- * @memberof FDSIDList
36
- */
37
- dType?: DocumentType;
38
- /**
39
- *
40
- * @type {DocumentFormat}
41
- * @memberof FDSIDList
42
- */
43
- dFormat?: DocumentFormat;
44
- /**
45
- * Flag indicating the presence of MRZ on the document
46
- * @type {boolean}
47
- * @memberof FDSIDList
48
- */
49
- dMRZ?: boolean;
50
- /**
51
- * Document description
52
- * @type {string}
53
- * @memberof FDSIDList
54
- */
55
- dDescription?: string;
56
- /**
57
- * Year of publication of the document
58
- * @type {string}
59
- * @memberof FDSIDList
60
- */
61
- dYear?: string;
62
- /**
63
- * Issuing country name
64
- * @type {string}
65
- * @memberof FDSIDList
66
- */
67
- dCountryName?: string;
68
- /**
69
- * Issuing state code
70
- * @type {string}
71
- * @memberof FDSIDList
72
- */
73
- dStateCode?: string;
74
- /**
75
- * Issuing state name
76
- * @type {string}
77
- * @memberof FDSIDList
78
- */
79
- dStateName?: string;
80
- }
@@ -1,74 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { Light } from './light';
13
- import { RectangleCoordinates } from './rectangle-coordinates';
14
- /**
15
- *
16
- * @export
17
- * @interface FiberResultAllOf
18
- */
19
- export interface FiberResultAllOf {
20
- /**
21
- * For UV_Fibers authenticity result type
22
- * @type {number}
23
- * @memberof FiberResultAllOf
24
- */
25
- RectCount?: number;
26
- /**
27
- * Expected fibers number. For UV_Fibers authentication result type
28
- * @type {number}
29
- * @memberof FiberResultAllOf
30
- */
31
- ExpectedCount?: number;
32
- /**
33
- *
34
- * @type {Light}
35
- * @memberof FiberResultAllOf
36
- */
37
- LightValue?: Light;
38
- /**
39
- * For UV_Background authentication result type
40
- * @type {number}
41
- * @memberof FiberResultAllOf
42
- */
43
- LightDisp?: number;
44
- /**
45
- * Coordinates of located areas for defined fibers type
46
- * @type {Array<RectangleCoordinates>}
47
- * @memberof FiberResultAllOf
48
- */
49
- RectArray?: Array<RectangleCoordinates>;
50
- /**
51
- * Fibers width value for located areas (in pixels)
52
- * @type {Array<number>}
53
- * @memberof FiberResultAllOf
54
- */
55
- Width?: Array<number>;
56
- /**
57
- * Fibers length value for located areas (in pixels)
58
- * @type {Array<number>}
59
- * @memberof FiberResultAllOf
60
- */
61
- Length?: Array<number>;
62
- /**
63
- * Fibers value for areas (in pixels)
64
- * @type {Array<number>}
65
- * @memberof FiberResultAllOf
66
- */
67
- Area?: Array<number>;
68
- /**
69
- * Fibers color value
70
- * @type {Array<number>}
71
- * @memberof FiberResultAllOf
72
- */
73
- ColorValues?: Array<number>;
74
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
13
- import { FiberResultAllOf } from './fiber-result-all-of';
14
- /**
15
- * @type FiberResult
16
- * @export
17
- */
18
- export declare type FiberResult = AuthenticityCheckResultItem & FiberResultAllOf;
@@ -1,118 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @enum {string}
16
- */
17
- export declare enum GraphicFieldType {
18
- /**
19
- * Document holder photo
20
- */
21
- PORTRAIT = 201,
22
- /**
23
- * Fingerprint of document holder
24
- */
25
- FINGERPRINT = 202,
26
- /**
27
- * Image of the iris of document holder
28
- */
29
- EYE = 203,
30
- /**
31
- * Signature of document holder
32
- */
33
- SIGNATURE = 204,
34
- /**
35
- * Barcode image
36
- */
37
- BAR_CODE = 205,
38
- /**
39
- * Image of document confirming owner citizenship
40
- */
41
- PROOF_OF_CITIZENSHIP = 206,
42
- /**
43
- * Cropped and rotated with perspective compensation (front side) of a document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most coordinates in other types defined on that image.
44
- */
45
- DOCUMENT_FRONT = 207,
46
- /**
47
- * Image of the rear side of the document
48
- */
49
- DOCUMENT_REAR = 208,
50
- /**
51
- * Area with dynamic color change
52
- */
53
- COLOR_DYNAMIC = 209,
54
- /**
55
- * Additional Portrait
56
- */
57
- GHOST_PORTRAIT = 210,
58
- /**
59
- * Stamp
60
- */
61
- STAMP = 211,
62
- /**
63
- * Undefined image type
64
- */
65
- OTHER = 250,
66
- /**
67
- * Fingerprint (thumb, left hand)
68
- */
69
- FINGER_LEFT_THUMB = 300,
70
- /**
71
- * Fingerprint (index, left hand)
72
- */
73
- FINGER_LEFT_INDEX = 301,
74
- /**
75
- * Fingerprint (middle, left hand)
76
- */
77
- FINGER_LEFT_MIDDLE = 302,
78
- /**
79
- * Fingerprint (ring, left hand)
80
- */
81
- FINGER_LEFT_RING = 303,
82
- /**
83
- * Fingerprint (little, left hand)
84
- */
85
- FINGER_LEFT_LITTLE = 304,
86
- /**
87
- * Fingerprint (thumb, right hand)
88
- */
89
- FINGER_RIGHT_THUMB = 305,
90
- /**
91
- * Fingerprint (index, right hand)
92
- */
93
- FINGER_RIGHT_INDEX = 306,
94
- /**
95
- * Fingerprint (middle, right hand)
96
- */
97
- FINGER_RIGHT_MIDDLE = 307,
98
- /**
99
- * Fingerprint (ring, right hand)
100
- */
101
- FINGER_RIGHT_RING = 308,
102
- /**
103
- * Fingerprint (little, right hand)
104
- */
105
- FINGER_RIGHT_LITTLE = 309,
106
- /**
107
- * Fingerprint (four without thumb on right hand)
108
- */
109
- FINGER_RIGHT_FOUR_FINGERS = 313,
110
- /**
111
- * Fingerprint (four without thumb on left hand
112
- */
113
- FINGER_LEFT_FOUR_FINGERS = 314,
114
- /**
115
- * Fingerprint (two thumbs)
116
- */
117
- FINGER_TWO_THUMBS = 315
118
- }
@@ -1,63 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { GraphicFieldType } from './graphic-field-type';
13
- import { ImageData } from './image-data';
14
- import { RectangleCoordinates } from './rectangle-coordinates';
15
- /**
16
- *
17
- * @export
18
- * @interface GraphicField
19
- */
20
- export interface GraphicField {
21
- /**
22
- *
23
- * @type {GraphicFieldType}
24
- * @memberof GraphicField
25
- */
26
- FieldType: GraphicFieldType;
27
- /**
28
- *
29
- * @type {ImageData}
30
- * @memberof GraphicField
31
- */
32
- image: ImageData;
33
- /**
34
- *
35
- * @type {RectangleCoordinates}
36
- * @memberof GraphicField
37
- */
38
- FieldRect?: RectangleCoordinates;
39
- /**
40
- * Source data group file. Only for Result.RFID_GRAPHICS result.
41
- * @type {number}
42
- * @memberof GraphicField
43
- */
44
- RFID_OriginDG?: number;
45
- /**
46
- * Index of the source record of the image with biometric information in the information data group. Only for Result.RFID_GRAPHICS result.
47
- * @type {number}
48
- * @memberof GraphicField
49
- */
50
- RFID_OriginDGTag?: number;
51
- /**
52
- * Index of the template in the record with biometric data. Only for Result.RFID_GRAPHICS result.
53
- * @type {number}
54
- * @memberof GraphicField
55
- */
56
- RFID_OriginTagEntry?: number;
57
- /**
58
- * Index of the variant of the biometric data template. Only for Result.RFID_GRAPHICS result.
59
- * @type {number}
60
- * @memberof GraphicField
61
- */
62
- RFID_OriginEntryView?: number;
63
- }
@@ -1,25 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { GraphicField } from './graphic-field';
13
- /**
14
- *
15
- * @export
16
- * @interface GraphicFieldsList
17
- */
18
- export interface GraphicFieldsList {
19
- /**
20
- *
21
- * @type {Array<GraphicField>}
22
- * @memberof GraphicFieldsList
23
- */
24
- pArrayFields: Array<GraphicField>;
25
- }
@@ -1,25 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { GraphicFieldsList } from './graphic-fields-list';
13
- /**
14
- *
15
- * @export
16
- * @interface GraphicsResultAllOf
17
- */
18
- export interface GraphicsResultAllOf {
19
- /**
20
- *
21
- * @type {GraphicFieldsList}
22
- * @memberof GraphicsResultAllOf
23
- */
24
- DocGraphicsInfo?: GraphicFieldsList;
25
- }
@@ -1,19 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { GraphicsResultAllOf } from './graphics-result-all-of';
13
- import { ResultItem } from './result-item';
14
- /**
15
- * @type GraphicsResult
16
- * Graphic fields extracted from one of the document sources. Returns separate results for each provided page.
17
- * @export
18
- */
19
- export declare type GraphicsResult = GraphicsResultAllOf & ResultItem;
@@ -1,65 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { AreaContainer } from './area-container';
13
- import { ImageData } from './image-data';
14
- import { Light } from './light';
15
- import { RectangleCoordinates } from './rectangle-coordinates';
16
- import { SecurityFeatureType } from './security-feature-type';
17
- /**
18
- *
19
- * @export
20
- * @interface IdentResultAllOf
21
- */
22
- export interface IdentResultAllOf {
23
- /**
24
- *
25
- * @type {SecurityFeatureType}
26
- * @memberof IdentResultAllOf
27
- */
28
- ElementType?: SecurityFeatureType;
29
- /**
30
- *
31
- * @type {Light}
32
- * @memberof IdentResultAllOf
33
- */
34
- LightIndex?: Light;
35
- /**
36
- *
37
- * @type {RectangleCoordinates}
38
- * @memberof IdentResultAllOf
39
- */
40
- Area?: RectangleCoordinates;
41
- /**
42
- *
43
- * @type {ImageData}
44
- * @memberof IdentResultAllOf
45
- */
46
- Image?: ImageData;
47
- /**
48
- *
49
- * @type {ImageData}
50
- * @memberof IdentResultAllOf
51
- */
52
- EtalonImage?: ImageData;
53
- /**
54
- * Probability percent for IMAGE_PATTERN check or element\'s visibility for IR_VISIBILITY
55
- * @type {number}
56
- * @memberof IdentResultAllOf
57
- */
58
- PercentValue?: number;
59
- /**
60
- *
61
- * @type {AreaContainer}
62
- * @memberof IdentResultAllOf
63
- */
64
- AreaList?: AreaContainer;
65
- }
@@ -1,18 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- import { AuthenticityCheckResultItem } from './authenticity-check-result-item';
13
- import { IdentResultAllOf } from './ident-result-all-of';
14
- /**
15
- * @type IdentResult
16
- * @export
17
- */
18
- export declare type IdentResult = AuthenticityCheckResultItem & IdentResultAllOf;
@@ -1,24 +0,0 @@
1
- /**
2
- * Regula Document Reader Web API
3
- * 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
4
- *
5
- * The version of the OpenAPI document: 6.5.0
6
- *
7
- *
8
- * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
- * https://openapi-generator.tech
10
- * Do not edit the class manually.
11
- */
12
- /**
13
- *
14
- * @export
15
- * @interface ImageData
16
- */
17
- export interface ImageData {
18
- /**
19
- * Base64 encoded image
20
- * @type {string}
21
- * @memberof ImageData
22
- */
23
- image: string;
24
- }