@regulaforensics/document-reader-webclient 5.5.1 → 5.5.5

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 (426) hide show
  1. package/.github/workflows/run-smoke-test.yml +1 -4
  2. package/.github/workflows/trivy-scan.yaml +24 -0
  3. package/dist/cjs-es5/api/default-api.js +16 -9
  4. package/dist/cjs-es5/api/process-api.js +16 -9
  5. package/dist/cjs-es5/base.js +1 -1
  6. package/dist/cjs-es5/configuration.js +1 -1
  7. package/dist/cjs-es5/ext/authenticity/authenticity.js +7 -1
  8. package/dist/cjs-es5/ext/document-reader.js +30 -7
  9. package/dist/cjs-es5/ext/images.js +23 -8
  10. package/dist/cjs-es5/ext/process-request.js +1 -1
  11. package/dist/cjs-es5/ext/process-response.js +60 -10
  12. package/dist/cjs-es5/ext/text-field.js +150 -1
  13. package/dist/cjs-es5/index.js +2 -1
  14. package/dist/cjs-es5/models/area-array.js +1 -1
  15. package/dist/cjs-es5/models/area-container.js +1 -1
  16. package/dist/cjs-es5/models/authenticity-check-list.js +1 -1
  17. package/dist/cjs-es5/models/authenticity-check-result-item.js +1 -1
  18. package/dist/cjs-es5/models/authenticity-check-result.js +1 -1
  19. package/dist/cjs-es5/models/authenticity-result-all-of.js +1 -1
  20. package/dist/cjs-es5/models/authenticity-result-type.js +72 -3
  21. package/dist/cjs-es5/models/authenticity-result.js +1 -1
  22. package/dist/cjs-es5/models/bc-pdf417-info.js +16 -0
  23. package/dist/cjs-es5/models/bc-roidetect.js +16 -0
  24. package/dist/cjs-es5/models/check-diagnose.js +37 -4
  25. package/dist/cjs-es5/models/check-result.js +1 -1
  26. package/dist/cjs-es5/models/chosen-document-type-result-all-of.js +1 -1
  27. package/dist/cjs-es5/models/chosen-document-type-result.js +1 -1
  28. package/dist/cjs-es5/models/chosen-document-type.js +1 -1
  29. package/dist/cjs-es5/models/container-list.js +1 -1
  30. package/dist/cjs-es5/models/critical.js +1 -1
  31. package/dist/cjs-es5/models/cross-source-value-comparison.js +1 -1
  32. package/dist/cjs-es5/models/data-module.js +16 -0
  33. package/dist/cjs-es5/models/details-optical.js +1 -1
  34. package/dist/cjs-es5/models/details-rfid.js +1 -1
  35. package/dist/cjs-es5/models/device-info.js +1 -1
  36. package/dist/cjs-es5/models/doc-bar-code-info-all-of.js +16 -0
  37. package/dist/cjs-es5/models/doc-bar-code-info.js +16 -0
  38. package/dist/cjs-es5/models/doc-visual-extended-field.js +1 -1
  39. package/dist/cjs-es5/models/doc-visual-extended-info.js +1 -1
  40. package/dist/cjs-es5/models/document-format.js +1 -1
  41. package/dist/cjs-es5/models/document-image-result-all-of.js +1 -1
  42. package/dist/cjs-es5/models/document-image-result.js +1 -1
  43. package/dist/cjs-es5/models/document-image.js +1 -1
  44. package/dist/cjs-es5/models/document-position-result-all-of.js +16 -0
  45. package/dist/cjs-es5/models/document-position-result.js +16 -0
  46. package/dist/cjs-es5/models/document-position.js +16 -0
  47. package/dist/cjs-es5/models/document-type-recognition-result.js +1 -1
  48. package/dist/cjs-es5/models/document-type.js +699 -5
  49. package/dist/cjs-es5/models/document-types-candidates-list.js +1 -1
  50. package/dist/cjs-es5/models/document-types-candidates-result-all-of.js +1 -1
  51. package/dist/cjs-es5/models/document-types-candidates-result.js +1 -1
  52. package/dist/cjs-es5/models/document-types-candidates.js +1 -1
  53. package/dist/cjs-es5/models/encrypted-rclresult-all-of.js +16 -0
  54. package/dist/cjs-es5/models/encrypted-rclresult.js +16 -0
  55. package/dist/cjs-es5/models/face-api-search.js +16 -0
  56. package/dist/cjs-es5/models/face-api.js +16 -0
  57. package/dist/cjs-es5/models/fdsidlist.js +1 -1
  58. package/dist/cjs-es5/models/fiber-result-all-of.js +1 -1
  59. package/dist/cjs-es5/models/fiber-result.js +1 -1
  60. package/dist/cjs-es5/models/graphic-field-type.js +14 -2
  61. package/dist/cjs-es5/models/graphic-field.js +1 -1
  62. package/dist/cjs-es5/models/graphic-fields-list.js +1 -1
  63. package/dist/cjs-es5/models/graphics-result-all-of.js +1 -1
  64. package/dist/cjs-es5/models/graphics-result.js +1 -1
  65. package/dist/cjs-es5/models/ident-result-all-of.js +1 -1
  66. package/dist/cjs-es5/models/ident-result.js +1 -1
  67. package/dist/cjs-es5/models/image-data.js +1 -1
  68. package/dist/cjs-es5/models/image-qa.js +1 -1
  69. package/dist/cjs-es5/models/image-quality-check-list.js +1 -1
  70. package/dist/cjs-es5/models/image-quality-check-type.js +10 -2
  71. package/dist/cjs-es5/models/image-quality-check.js +1 -1
  72. package/dist/cjs-es5/models/image-quality-result-all-of.js +1 -1
  73. package/dist/cjs-es5/models/image-quality-result.js +1 -1
  74. package/dist/cjs-es5/models/images-available-source.js +1 -1
  75. package/dist/cjs-es5/models/images-field-value.js +1 -1
  76. package/dist/cjs-es5/models/images-field.js +1 -1
  77. package/dist/cjs-es5/models/images-result-all-of.js +1 -1
  78. package/dist/cjs-es5/models/images-result.js +1 -1
  79. package/dist/cjs-es5/models/images.js +1 -1
  80. package/dist/cjs-es5/models/index.js +22 -1
  81. package/dist/cjs-es5/models/lcid.js +28 -28
  82. package/dist/cjs-es5/models/lexical-analysis-result-all-of.js +1 -1
  83. package/dist/cjs-es5/models/lexical-analysis-result.js +1 -1
  84. package/dist/cjs-es5/models/license-result-all-of.js +16 -0
  85. package/dist/cjs-es5/models/license-result.js +16 -0
  86. package/dist/cjs-es5/models/light.js +1 -1
  87. package/dist/cjs-es5/models/list-verified-fields.js +1 -1
  88. package/dist/cjs-es5/models/log-level.js +45 -0
  89. package/dist/cjs-es5/models/measure-system.js +1 -1
  90. package/dist/cjs-es5/models/mrzformat.js +49 -0
  91. package/dist/cjs-es5/models/ocrsecurity-text-result-all-of.js +1 -1
  92. package/dist/cjs-es5/models/ocrsecurity-text-result.js +1 -1
  93. package/dist/cjs-es5/models/one-candidate.js +1 -1
  94. package/dist/cjs-es5/models/original-symbol.js +1 -1
  95. package/dist/cjs-es5/models/parray-field.js +16 -0
  96. package/dist/cjs-es5/models/parsing-notification-codes.js +897 -0
  97. package/dist/cjs-es5/models/per-document-config.js +16 -0
  98. package/dist/cjs-es5/models/photo-ident-result-all-of.js +1 -1
  99. package/dist/cjs-es5/models/photo-ident-result.js +1 -1
  100. package/dist/cjs-es5/models/point-array.js +1 -1
  101. package/dist/cjs-es5/models/point.js +1 -1
  102. package/dist/cjs-es5/models/points-container.js +1 -1
  103. package/dist/cjs-es5/models/process-params-rfid.js +16 -0
  104. package/dist/cjs-es5/models/process-params.js +1 -1
  105. package/dist/cjs-es5/models/process-request-image.js +1 -1
  106. package/dist/cjs-es5/models/process-request.js +1 -1
  107. package/dist/cjs-es5/models/process-response.js +1 -1
  108. package/dist/cjs-es5/models/process-system-info.js +1 -1
  109. package/dist/cjs-es5/models/processing-status.js +1 -1
  110. package/dist/cjs-es5/models/raw-image-container-list.js +1 -1
  111. package/dist/cjs-es5/models/rectangle-coordinates.js +1 -1
  112. package/dist/cjs-es5/models/result-item.js +1 -1
  113. package/dist/cjs-es5/models/result.js +57 -29
  114. package/dist/cjs-es5/models/rfid-location.js +1 -1
  115. package/dist/cjs-es5/models/rfid-origin.js +1 -1
  116. package/dist/cjs-es5/models/scenario.js +57 -3
  117. package/dist/cjs-es5/models/security-feature-result-all-of.js +1 -1
  118. package/dist/cjs-es5/models/security-feature-result.js +1 -1
  119. package/dist/cjs-es5/models/security-feature-type.js +152 -3
  120. package/dist/cjs-es5/models/source-validity.js +1 -1
  121. package/dist/cjs-es5/models/source.js +17 -2
  122. package/dist/cjs-es5/models/status-result-all-of.js +1 -1
  123. package/dist/cjs-es5/models/status-result.js +1 -1
  124. package/dist/cjs-es5/models/status.js +1 -1
  125. package/dist/cjs-es5/models/string-recognition-result.js +1 -1
  126. package/dist/cjs-es5/models/symbol-candidate.js +1 -1
  127. package/dist/cjs-es5/models/symbol-recognition-result.js +1 -1
  128. package/dist/cjs-es5/models/text-available-source.js +1 -1
  129. package/dist/cjs-es5/models/text-data-result-all-of.js +1 -1
  130. package/dist/cjs-es5/models/text-data-result.js +1 -1
  131. package/dist/cjs-es5/models/text-field-type.js +651 -435
  132. package/dist/cjs-es5/models/text-field-value.js +1 -1
  133. package/dist/cjs-es5/models/text-field.js +1 -1
  134. package/dist/cjs-es5/models/text-post-processing.js +41 -0
  135. package/dist/cjs-es5/models/text-result-all-of.js +1 -1
  136. package/dist/cjs-es5/models/text-result.js +1 -1
  137. package/dist/cjs-es5/models/text.js +1 -1
  138. package/dist/cjs-es5/models/transaction-info.js +1 -1
  139. package/dist/cjs-es5/models/verification-result.js +1 -1
  140. package/dist/cjs-es5/models/verified-field-map.js +1 -1
  141. package/dist/cjs-es5/models/visibility.js +17 -2
  142. package/dist/esm-es5/api/default-api.js +16 -9
  143. package/dist/esm-es5/api/process-api.js +16 -9
  144. package/dist/esm-es5/base.js +1 -1
  145. package/dist/esm-es5/configuration.js +1 -1
  146. package/dist/esm-es5/ext/authenticity/authenticity.js +7 -1
  147. package/dist/esm-es5/ext/document-reader.js +10 -6
  148. package/dist/esm-es5/ext/images.js +4 -5
  149. package/dist/esm-es5/ext/process-request.js +1 -1
  150. package/dist/esm-es5/ext/process-response.js +41 -7
  151. package/dist/esm-es5/ext/text-field.js +150 -1
  152. package/dist/esm-es5/index.js +2 -1
  153. package/dist/esm-es5/models/area-array.js +1 -1
  154. package/dist/esm-es5/models/area-container.js +1 -1
  155. package/dist/esm-es5/models/authenticity-check-list.js +1 -1
  156. package/dist/esm-es5/models/authenticity-check-result-item.js +1 -1
  157. package/dist/esm-es5/models/authenticity-check-result.js +1 -1
  158. package/dist/esm-es5/models/authenticity-result-all-of.js +1 -1
  159. package/dist/esm-es5/models/authenticity-result-type.js +72 -3
  160. package/dist/esm-es5/models/authenticity-result.js +1 -1
  161. package/dist/esm-es5/models/bc-pdf417-info.js +14 -0
  162. package/dist/esm-es5/models/bc-roidetect.js +14 -0
  163. package/dist/esm-es5/models/check-diagnose.js +37 -4
  164. package/dist/esm-es5/models/check-result.js +1 -1
  165. package/dist/esm-es5/models/chosen-document-type-result-all-of.js +1 -1
  166. package/dist/esm-es5/models/chosen-document-type-result.js +1 -1
  167. package/dist/esm-es5/models/chosen-document-type.js +1 -1
  168. package/dist/esm-es5/models/container-list.js +1 -1
  169. package/dist/esm-es5/models/critical.js +1 -1
  170. package/dist/esm-es5/models/cross-source-value-comparison.js +1 -1
  171. package/dist/esm-es5/models/data-module.js +14 -0
  172. package/dist/esm-es5/models/details-optical.js +1 -1
  173. package/dist/esm-es5/models/details-rfid.js +1 -1
  174. package/dist/esm-es5/models/device-info.js +1 -1
  175. package/dist/esm-es5/models/doc-bar-code-info-all-of.js +14 -0
  176. package/dist/esm-es5/models/doc-bar-code-info.js +14 -0
  177. package/dist/esm-es5/models/doc-visual-extended-field.js +1 -1
  178. package/dist/esm-es5/models/doc-visual-extended-info.js +1 -1
  179. package/dist/esm-es5/models/document-format.js +1 -1
  180. package/dist/esm-es5/models/document-image-result-all-of.js +1 -1
  181. package/dist/esm-es5/models/document-image-result.js +1 -1
  182. package/dist/esm-es5/models/document-image.js +1 -1
  183. package/dist/esm-es5/models/document-position-result-all-of.js +14 -0
  184. package/dist/esm-es5/models/document-position-result.js +14 -0
  185. package/dist/esm-es5/models/document-position.js +14 -0
  186. package/dist/esm-es5/models/document-type-recognition-result.js +1 -1
  187. package/dist/esm-es5/models/document-type.js +699 -5
  188. package/dist/esm-es5/models/document-types-candidates-list.js +1 -1
  189. package/dist/esm-es5/models/document-types-candidates-result-all-of.js +1 -1
  190. package/dist/esm-es5/models/document-types-candidates-result.js +1 -1
  191. package/dist/esm-es5/models/document-types-candidates.js +1 -1
  192. package/dist/esm-es5/models/encrypted-rclresult-all-of.js +14 -0
  193. package/dist/esm-es5/models/encrypted-rclresult.js +14 -0
  194. package/dist/esm-es5/models/face-api-search.js +14 -0
  195. package/dist/esm-es5/models/face-api.js +14 -0
  196. package/dist/esm-es5/models/fdsidlist.js +1 -1
  197. package/dist/esm-es5/models/fiber-result-all-of.js +1 -1
  198. package/dist/esm-es5/models/fiber-result.js +1 -1
  199. package/dist/esm-es5/models/graphic-field-type.js +14 -2
  200. package/dist/esm-es5/models/graphic-field.js +1 -1
  201. package/dist/esm-es5/models/graphic-fields-list.js +1 -1
  202. package/dist/esm-es5/models/graphics-result-all-of.js +1 -1
  203. package/dist/esm-es5/models/graphics-result.js +1 -1
  204. package/dist/esm-es5/models/ident-result-all-of.js +1 -1
  205. package/dist/esm-es5/models/ident-result.js +1 -1
  206. package/dist/esm-es5/models/image-data.js +1 -1
  207. package/dist/esm-es5/models/image-qa.js +1 -1
  208. package/dist/esm-es5/models/image-quality-check-list.js +1 -1
  209. package/dist/esm-es5/models/image-quality-check-type.js +10 -2
  210. package/dist/esm-es5/models/image-quality-check.js +1 -1
  211. package/dist/esm-es5/models/image-quality-result-all-of.js +1 -1
  212. package/dist/esm-es5/models/image-quality-result.js +1 -1
  213. package/dist/esm-es5/models/images-available-source.js +1 -1
  214. package/dist/esm-es5/models/images-field-value.js +1 -1
  215. package/dist/esm-es5/models/images-field.js +1 -1
  216. package/dist/esm-es5/models/images-result-all-of.js +1 -1
  217. package/dist/esm-es5/models/images-result.js +1 -1
  218. package/dist/esm-es5/models/images.js +1 -1
  219. package/dist/esm-es5/models/index.js +22 -1
  220. package/dist/esm-es5/models/lcid.js +28 -28
  221. package/dist/esm-es5/models/lexical-analysis-result-all-of.js +1 -1
  222. package/dist/esm-es5/models/lexical-analysis-result.js +1 -1
  223. package/dist/esm-es5/models/license-result-all-of.js +14 -0
  224. package/dist/esm-es5/models/license-result.js +14 -0
  225. package/dist/esm-es5/models/light.js +1 -1
  226. package/dist/esm-es5/models/list-verified-fields.js +1 -1
  227. package/dist/esm-es5/models/log-level.js +42 -0
  228. package/dist/esm-es5/models/measure-system.js +1 -1
  229. package/dist/esm-es5/models/mrzformat.js +46 -0
  230. package/dist/esm-es5/models/ocrsecurity-text-result-all-of.js +1 -1
  231. package/dist/esm-es5/models/ocrsecurity-text-result.js +1 -1
  232. package/dist/esm-es5/models/one-candidate.js +1 -1
  233. package/dist/esm-es5/models/original-symbol.js +1 -1
  234. package/dist/esm-es5/models/parray-field.js +14 -0
  235. package/dist/esm-es5/models/parsing-notification-codes.js +894 -0
  236. package/dist/esm-es5/models/per-document-config.js +14 -0
  237. package/dist/esm-es5/models/photo-ident-result-all-of.js +1 -1
  238. package/dist/esm-es5/models/photo-ident-result.js +1 -1
  239. package/dist/esm-es5/models/point-array.js +1 -1
  240. package/dist/esm-es5/models/point.js +1 -1
  241. package/dist/esm-es5/models/points-container.js +1 -1
  242. package/dist/esm-es5/models/process-params-rfid.js +14 -0
  243. package/dist/esm-es5/models/process-params.js +1 -1
  244. package/dist/esm-es5/models/process-request-image.js +1 -1
  245. package/dist/esm-es5/models/process-request.js +1 -1
  246. package/dist/esm-es5/models/process-response.js +1 -1
  247. package/dist/esm-es5/models/process-system-info.js +1 -1
  248. package/dist/esm-es5/models/processing-status.js +1 -1
  249. package/dist/esm-es5/models/raw-image-container-list.js +1 -1
  250. package/dist/esm-es5/models/rectangle-coordinates.js +1 -1
  251. package/dist/esm-es5/models/result-item.js +1 -1
  252. package/dist/esm-es5/models/result.js +57 -29
  253. package/dist/esm-es5/models/rfid-location.js +1 -1
  254. package/dist/esm-es5/models/rfid-origin.js +1 -1
  255. package/dist/esm-es5/models/scenario.js +57 -3
  256. package/dist/esm-es5/models/security-feature-result-all-of.js +1 -1
  257. package/dist/esm-es5/models/security-feature-result.js +1 -1
  258. package/dist/esm-es5/models/security-feature-type.js +152 -3
  259. package/dist/esm-es5/models/source-validity.js +1 -1
  260. package/dist/esm-es5/models/source.js +17 -2
  261. package/dist/esm-es5/models/status-result-all-of.js +1 -1
  262. package/dist/esm-es5/models/status-result.js +1 -1
  263. package/dist/esm-es5/models/status.js +1 -1
  264. package/dist/esm-es5/models/string-recognition-result.js +1 -1
  265. package/dist/esm-es5/models/symbol-candidate.js +1 -1
  266. package/dist/esm-es5/models/symbol-recognition-result.js +1 -1
  267. package/dist/esm-es5/models/text-available-source.js +1 -1
  268. package/dist/esm-es5/models/text-data-result-all-of.js +1 -1
  269. package/dist/esm-es5/models/text-data-result.js +1 -1
  270. package/dist/esm-es5/models/text-field-type.js +651 -435
  271. package/dist/esm-es5/models/text-field-value.js +1 -1
  272. package/dist/esm-es5/models/text-field.js +1 -1
  273. package/dist/esm-es5/models/text-post-processing.js +38 -0
  274. package/dist/esm-es5/models/text-result-all-of.js +1 -1
  275. package/dist/esm-es5/models/text-result.js +1 -1
  276. package/dist/esm-es5/models/text.js +1 -1
  277. package/dist/esm-es5/models/transaction-info.js +1 -1
  278. package/dist/esm-es5/models/verification-result.js +1 -1
  279. package/dist/esm-es5/models/verified-field-map.js +1 -1
  280. package/dist/esm-es5/models/visibility.js +17 -2
  281. package/package.json +5 -3
  282. package/setup.sh +11 -0
  283. package/src/api/default-api.ts +16 -8
  284. package/src/api/process-api.ts +16 -8
  285. package/src/base.ts +1 -1
  286. package/src/configuration.ts +1 -1
  287. package/src/ext/authenticity/authenticity.ts +8 -1
  288. package/src/ext/document-reader.ts +18 -7
  289. package/src/ext/images.ts +3 -5
  290. package/src/ext/process-request-image.ts +1 -1
  291. package/src/ext/process-request.ts +8 -2
  292. package/src/ext/process-response.ts +56 -12
  293. package/src/ext/result-item.ts +5 -5
  294. package/src/ext/text-field.ts +168 -18
  295. package/src/index.ts +1 -0
  296. package/src/models/area-array.ts +3 -3
  297. package/src/models/area-container.ts +1 -1
  298. package/src/models/authenticity-check-list.ts +7 -1
  299. package/src/models/authenticity-check-result-item.ts +2 -2
  300. package/src/models/authenticity-check-result.ts +1 -1
  301. package/src/models/authenticity-result-all-of.ts +1 -1
  302. package/src/models/authenticity-result-type.ts +72 -3
  303. package/src/models/authenticity-result.ts +5 -1
  304. package/src/models/bc-pdf417-info.ts +61 -0
  305. package/src/models/bc-roidetect.ts +49 -0
  306. package/src/models/check-diagnose.ts +36 -3
  307. package/src/models/check-result.ts +1 -1
  308. package/src/models/chosen-document-type-result-all-of.ts +1 -1
  309. package/src/models/chosen-document-type-result.ts +5 -1
  310. package/src/models/chosen-document-type.ts +1 -1
  311. package/src/models/container-list.ts +13 -3
  312. package/src/models/critical.ts +1 -1
  313. package/src/models/cross-source-value-comparison.ts +1 -1
  314. package/src/models/data-module.ts +55 -0
  315. package/src/models/details-optical.ts +1 -1
  316. package/src/models/details-rfid.ts +1 -1
  317. package/src/models/device-info.ts +1 -1
  318. package/src/models/doc-bar-code-info-all-of.ts +38 -0
  319. package/src/models/doc-bar-code-info.ts +42 -0
  320. package/src/models/doc-visual-extended-field.ts +1 -1
  321. package/src/models/doc-visual-extended-info.ts +1 -1
  322. package/src/models/document-format.ts +1 -1
  323. package/src/models/document-image-result-all-of.ts +1 -1
  324. package/src/models/document-image-result.ts +5 -1
  325. package/src/models/document-image.ts +1 -1
  326. package/src/models/document-position-result-all-of.ts +32 -0
  327. package/src/models/document-position-result.ts +42 -0
  328. package/src/models/document-position.ts +87 -0
  329. package/src/models/document-type-recognition-result.ts +1 -1
  330. package/src/models/document-type.ts +699 -5
  331. package/src/models/document-types-candidates-list.ts +1 -1
  332. package/src/models/document-types-candidates-result-all-of.ts +1 -1
  333. package/src/models/document-types-candidates-result.ts +5 -1
  334. package/src/models/document-types-candidates.ts +1 -1
  335. package/src/models/encrypted-rclresult-all-of.ts +31 -0
  336. package/src/models/encrypted-rclresult.ts +40 -0
  337. package/src/models/face-api-search.ts +43 -0
  338. package/src/models/face-api.ts +74 -0
  339. package/src/models/fdsidlist.ts +1 -1
  340. package/src/models/fiber-result-all-of.ts +1 -1
  341. package/src/models/fiber-result.ts +1 -1
  342. package/src/models/graphic-field-type.ts +14 -2
  343. package/src/models/graphic-field.ts +1 -1
  344. package/src/models/graphic-fields-list.ts +1 -1
  345. package/src/models/graphics-result-all-of.ts +1 -1
  346. package/src/models/graphics-result.ts +5 -1
  347. package/src/models/ident-result-all-of.ts +3 -3
  348. package/src/models/ident-result.ts +1 -1
  349. package/src/models/image-data.ts +1 -1
  350. package/src/models/image-qa.ts +31 -1
  351. package/src/models/image-quality-check-list.ts +1 -1
  352. package/src/models/image-quality-check-type.ts +10 -2
  353. package/src/models/image-quality-check.ts +1 -1
  354. package/src/models/image-quality-result-all-of.ts +1 -1
  355. package/src/models/image-quality-result.ts +5 -1
  356. package/src/models/images-available-source.ts +1 -1
  357. package/src/models/images-field-value.ts +7 -1
  358. package/src/models/images-field.ts +1 -1
  359. package/src/models/images-result-all-of.ts +1 -1
  360. package/src/models/images-result.ts +5 -1
  361. package/src/models/images.ts +1 -1
  362. package/src/models/index.ts +21 -0
  363. package/src/models/lcid.ts +27 -27
  364. package/src/models/lexical-analysis-result-all-of.ts +1 -1
  365. package/src/models/lexical-analysis-result.ts +6 -2
  366. package/src/models/license-result-all-of.ts +31 -0
  367. package/src/models/license-result.ts +40 -0
  368. package/src/models/light.ts +1 -1
  369. package/src/models/list-verified-fields.ts +1 -1
  370. package/src/models/log-level.ts +46 -0
  371. package/src/models/measure-system.ts +1 -1
  372. package/src/models/mrzformat.ts +50 -0
  373. package/src/models/ocrsecurity-text-result-all-of.ts +1 -1
  374. package/src/models/ocrsecurity-text-result.ts +1 -1
  375. package/src/models/one-candidate.ts +1 -1
  376. package/src/models/original-symbol.ts +1 -1
  377. package/src/models/parray-field.ts +88 -0
  378. package/src/models/parsing-notification-codes.ts +898 -0
  379. package/src/models/per-document-config.ts +37 -0
  380. package/src/models/photo-ident-result-all-of.ts +1 -1
  381. package/src/models/photo-ident-result.ts +1 -1
  382. package/src/models/point-array.ts +1 -1
  383. package/src/models/point.ts +1 -1
  384. package/src/models/points-container.ts +1 -1
  385. package/src/models/process-params-rfid.ts +32 -0
  386. package/src/models/process-params.ts +213 -18
  387. package/src/models/process-request-image.ts +1 -1
  388. package/src/models/process-request.ts +27 -2
  389. package/src/models/process-response.ts +13 -1
  390. package/src/models/process-system-info.ts +1 -1
  391. package/src/models/processing-status.ts +1 -1
  392. package/src/models/raw-image-container-list.ts +1 -1
  393. package/src/models/rectangle-coordinates.ts +1 -1
  394. package/src/models/result-item.ts +5 -1
  395. package/src/models/result.ts +56 -28
  396. package/src/models/rfid-location.ts +1 -1
  397. package/src/models/rfid-origin.ts +1 -1
  398. package/src/models/scenario.ts +56 -2
  399. package/src/models/security-feature-result-all-of.ts +3 -3
  400. package/src/models/security-feature-result.ts +1 -1
  401. package/src/models/security-feature-type.ts +152 -3
  402. package/src/models/source-validity.ts +1 -1
  403. package/src/models/source.ts +16 -1
  404. package/src/models/status-result-all-of.ts +1 -1
  405. package/src/models/status-result.ts +5 -1
  406. package/src/models/status.ts +1 -1
  407. package/src/models/string-recognition-result.ts +1 -1
  408. package/src/models/symbol-candidate.ts +1 -1
  409. package/src/models/symbol-recognition-result.ts +1 -1
  410. package/src/models/text-available-source.ts +1 -1
  411. package/src/models/text-data-result-all-of.ts +1 -1
  412. package/src/models/text-data-result.ts +5 -1
  413. package/src/models/text-field-type.ts +651 -435
  414. package/src/models/text-field-value.ts +1 -1
  415. package/src/models/text-field.ts +1 -1
  416. package/src/models/text-post-processing.ts +42 -0
  417. package/src/models/text-result-all-of.ts +1 -1
  418. package/src/models/text-result.ts +5 -1
  419. package/src/models/text.ts +1 -1
  420. package/src/models/transaction-info.ts +1 -1
  421. package/src/models/verification-result.ts +1 -1
  422. package/src/models/verified-field-map.ts +1 -1
  423. package/src/models/visibility.ts +16 -1
  424. package/tsconfig.commonjs.json +1 -1
  425. package/tsconfig.esm.json +1 -1
  426. package/update-models.sh +1 -0
@@ -0,0 +1,37 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula Document Reader Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 6.8.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface PerDocumentConfig
21
+ */
22
+ export interface PerDocumentConfig {
23
+ /**
24
+ * Specific template IDs, for which apply current custom configuration
25
+ * @type {Array<number>}
26
+ * @memberof PerDocumentConfig
27
+ */
28
+ docID?: Array<number>;
29
+ /**
30
+ * Contains items from AuthenticityResultType as sum via OR operation
31
+ * @type {number}
32
+ * @memberof PerDocumentConfig
33
+ */
34
+ excludeAuthChecks?: number;
35
+ }
36
+
37
+
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -0,0 +1,32 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * Regula Document Reader Web API
5
+ * 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
6
+ *
7
+ * The version of the OpenAPI document: 6.8.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { ParsingNotificationCodes } from './parsing-notification-codes';
17
+
18
+ /**
19
+ * Params for the RFID chip data reprocessing
20
+ * @export
21
+ * @interface ProcessParamsRfid
22
+ */
23
+ export interface ProcessParamsRfid {
24
+ /**
25
+ * A list of notification codes that should be ignored during passive authentication (PA)
26
+ * @type {Array<ParsingNotificationCodes>}
27
+ * @memberof ProcessParamsRfid
28
+ */
29
+ paSensitiveCodesDisable?: Array<ParsingNotificationCodes>;
30
+ }
31
+
32
+
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,11 +13,20 @@
13
13
  */
14
14
 
15
15
 
16
+ import { AuthenticityResultType } from './authenticity-result-type';
17
+ import { DocumentFormat } from './document-format';
18
+ import { DocumentType } from './document-type';
19
+ import { FaceApi } from './face-api';
16
20
  import { ImageQA } from './image-qa';
21
+ import { LogLevel } from './log-level';
22
+ import { MRZFormat } from './mrzformat';
17
23
  import { MeasureSystem } from './measure-system';
24
+ import { PerDocumentConfig } from './per-document-config';
25
+ import { ProcessParamsRfid } from './process-params-rfid';
18
26
  import { Result } from './result';
19
27
  import { Scenario } from './scenario';
20
28
  import { TextFieldType } from './text-field-type';
29
+ import { TextPostProcessing } from './text-post-processing';
21
30
 
22
31
  /**
23
32
  *
@@ -25,6 +34,42 @@ import { TextFieldType } from './text-field-type';
25
34
  * @interface ProcessParams
26
35
  */
27
36
  export interface ProcessParams {
37
+ /**
38
+ * This parameter allows processing an image that contains a person and a document and compare the portrait photo from the document with the person\'s face
39
+ * @type {boolean}
40
+ * @memberof ProcessParams
41
+ */
42
+ oneShotIdentification?: boolean;
43
+ /**
44
+ * This parameter allows comparing faces on Regula Face Web Service
45
+ * @type {boolean}
46
+ * @memberof ProcessParams
47
+ */
48
+ useFaceApi?: boolean;
49
+ /**
50
+ *
51
+ * @type {FaceApi}
52
+ * @memberof ProcessParams
53
+ */
54
+ faceApi?: FaceApi;
55
+ /**
56
+ * This parameter allows enabling the CAN (Card Access Number) detection and recognition when using scenarios with document location and MRZ reading, such as the MrzAndLocate scenario.
57
+ * @type {boolean}
58
+ * @memberof ProcessParams
59
+ */
60
+ doDetectCan?: boolean;
61
+ /**
62
+ * This parameter allows setting maximum height in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.
63
+ * @type {number}
64
+ * @memberof ProcessParams
65
+ */
66
+ imageOutputMaxHeight?: number;
67
+ /**
68
+ * This parameter allows setting maximum width in pixels of output images and thus reducing image size to desired. Does not change the aspect ratio. Changes disabled if equals to 0. Default 0.
69
+ * @type {number}
70
+ * @memberof ProcessParams
71
+ */
72
+ imageOutputMaxWidth?: number;
28
73
  /**
29
74
  *
30
75
  * @type {Scenario}
@@ -38,13 +83,19 @@ export interface ProcessParams {
38
83
  */
39
84
  resultTypeOutput?: Array<Result>;
40
85
  /**
41
- * This option can be set to true if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. By default is set to false.
86
+ * Enable this option if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages, like Russian domestic passport, or some others. Disabled by default.
42
87
  * @type {boolean}
43
88
  * @memberof ProcessParams
44
89
  */
45
90
  doublePageSpread?: boolean;
46
91
  /**
47
- * List of text field types to extract. If empty, all text fields from template will be extracted. Narrowing the list can shorten processing time. By default is empty.
92
+ * When enabled together with \"doublePageSpread\" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner. Disabled by default.
93
+ * @type {boolean}
94
+ * @memberof ProcessParams
95
+ */
96
+ generateDoublePageSpreadImage?: boolean;
97
+ /**
98
+ * List of text field types to extract. If empty, all text fields from template will be extracted. Narrowing the list can shorten processing time. Empty by default.
48
99
  * @type {Array<TextFieldType>}
49
100
  * @memberof ProcessParams
50
101
  */
@@ -62,29 +113,41 @@ export interface ProcessParams {
62
113
  */
63
114
  measureSystem?: MeasureSystem;
64
115
  /**
65
- * This option controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi.
116
+ * This parameter controls maximum resolution in dpi of output images. Resolution will remain original in case 0 is supplied. By default is set to return images in response with resolution not greater than 300 dpi for all scenarios except FullAuth. In FullAuth scenario this limit is 1000 dpi by default.
66
117
  * @type {number}
67
118
  * @memberof ProcessParams
68
119
  */
69
120
  imageDpiOutMax?: number;
70
121
  /**
71
- * This option can be set to true if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. By default is set to false.
122
+ * This option can be enabled if you know for sure that the image you provide contains already cropped document by its edges. This was designed to process on the server side images captured and cropped on mobile. Disabled by default.
72
123
  * @type {boolean}
73
124
  * @memberof ProcessParams
74
125
  */
75
126
  alreadyCropped?: boolean;
76
127
  /**
77
- * This option allows to pass custom processing parameters that can be implemented in future without changing API.
128
+ * This option allows passing custom processing parameters that can be implemented in future without changing API.
78
129
  * @type {{ [key: string]: object; }}
79
130
  * @memberof ProcessParams
80
131
  */
81
132
  customParams?: { [key: string]: object; };
82
133
  /**
83
- * This option can be set to true if you need to get base64 string of transaction processing log.
134
+ * This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration.
135
+ * @type {Array<PerDocumentConfig>}
136
+ * @memberof ProcessParams
137
+ */
138
+ config?: Array<PerDocumentConfig>;
139
+ /**
140
+ * When enabled, results will contain transaction processing log. Disabled by default
84
141
  * @type {boolean}
85
142
  * @memberof ProcessParams
86
143
  */
87
144
  log?: boolean;
145
+ /**
146
+ *
147
+ * @type {LogLevel}
148
+ * @memberof ProcessParams
149
+ */
150
+ logLevel?: LogLevel;
88
151
  /**
89
152
  * Force use of specific template ID and skip document type identification step.
90
153
  * @type {number}
@@ -92,47 +155,179 @@ export interface ProcessParams {
92
155
  */
93
156
  forceDocID?: number;
94
157
  /**
95
- * When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template.
158
+ * When disabled, text field OCR will be done as is and then the recognized value will be matched to the field mask for validity. If enabled, we are trying to read a field value with maximum efforts to match the mask and provide a correctly formatted value, making assumptions based on the provided field mask in the template. Enabled by default.
96
159
  * @type {boolean}
97
160
  * @memberof ProcessParams
98
161
  */
99
162
  matchTextFieldMask?: boolean;
100
163
  /**
101
- * When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds.
164
+ * When enabled, shorten the list of candidates to process during document detection in a single image process mode. Reduces processing time for specific backgrounds. Enabled by default.
102
165
  * @type {boolean}
103
166
  * @memberof ProcessParams
104
167
  */
105
168
  fastDocDetect?: boolean;
106
169
  /**
107
- * When enabled, fail OCR field validity, if there is a glare over the text field on the image.
170
+ * When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default.
108
171
  * @type {boolean}
109
172
  * @memberof ProcessParams
110
173
  */
111
174
  updateOCRValidityByGlare?: boolean;
112
175
  /**
113
- * When enabled together with \"doublePageSpread\" and there is a passport with two pages spread in the image, pages will be cropped, straightened and aligned together, as if the document was captured on a flatbed scanner.
176
+ * When enabled, each field in template will be checked for value presence and if the field is marked as required, but has no value, it will have \'error\' in validity status. Disabled by default.
114
177
  * @type {boolean}
115
178
  * @memberof ProcessParams
116
179
  */
117
- generateDoublePageSpreadImage?: boolean;
180
+ checkRequiredTextFields?: boolean;
118
181
  /**
119
- * When enabled, each field in template will be checked for value presence and if the field is marked as required, but has no value, it will have \"error\" in validity status.
182
+ * When enabled, returns cropped barcode images for unknown documents. Disabled by default.
120
183
  * @type {boolean}
121
184
  * @memberof ProcessParams
122
185
  */
123
- checkRequiredTextFields?: boolean;
186
+ returnCroppedBarcode?: boolean;
124
187
  /**
125
- * When enabled, returns cropped barcode images for unknown documents
188
+ *
189
+ * @type {ImageQA}
190
+ * @memberof ProcessParams
191
+ */
192
+ imageQa?: ImageQA;
193
+ /**
194
+ * When enabled, image quality checks status affects document optical and overall status. Disabled by default.
126
195
  * @type {boolean}
127
196
  * @memberof ProcessParams
128
197
  */
129
- returnCroppedBarcode?: boolean;
198
+ respectImageQuality?: boolean;
130
199
  /**
131
200
  *
132
- * @type {ImageQA}
201
+ * @type {DocumentFormat}
202
+ * @memberof ProcessParams
203
+ */
204
+ forceDocFormat?: DocumentFormat;
205
+ /**
206
+ * When enabled, no graphic fields will be cropped from document image. Disabled by default.
207
+ * @type {boolean}
208
+ * @memberof ProcessParams
209
+ */
210
+ noGraphics?: boolean;
211
+ /**
212
+ * Specifies minimal area of the image that document should cover to be treated as candidate when locating. Value should be in range from 0 to 1, where 1 is when document should fully cover the image.
213
+ * @type {number}
214
+ * @memberof ProcessParams
215
+ */
216
+ documentAreaMin?: number;
217
+ /**
218
+ * When enabled, all personal data will be forcibly removed from the logs. Disabled by default.
219
+ * @type {boolean}
220
+ * @memberof ProcessParams
221
+ */
222
+ depersonalizeLog?: boolean;
223
+ /**
224
+ * This option allows locating and cropping multiple documents from one image if enabled. Disabled by default.
225
+ * @type {boolean}
226
+ * @memberof ProcessParams
227
+ */
228
+ multiDocOnImage?: boolean;
229
+ /**
230
+ * This option allows shifting the date of expiry into the future or past for number of months specified. This is useful, for example, in some cases when document might be still valid for some period after original expiration date to prevent negative validity status for such documents. Or by shifting the date to the past will set negative validity for the documents that is about to expire in a specified number of months. 0 by default
231
+ * @type {number}
232
+ * @memberof ProcessParams
233
+ */
234
+ shiftExpiryDate?: number;
235
+ /**
236
+ * This options allows specifying the minimal age in years of the document holder for the document to be considered valid.
237
+ * @type {number}
238
+ * @memberof ProcessParams
239
+ */
240
+ minimalHolderAge?: number;
241
+ /**
242
+ * When enabled, returns input images in output. Disabled by default.
243
+ * @type {boolean}
244
+ * @memberof ProcessParams
245
+ */
246
+ returnUncroppedImage?: boolean;
247
+ /**
248
+ * This option allows limiting MRZ formats to be recognized by specifying them in array.
249
+ * @type {Array<MRZFormat>}
250
+ * @memberof ProcessParams
251
+ */
252
+ mrzFormatsFilter?: Array<MRZFormat>;
253
+ /**
254
+ * When enabled, make sure that in series processing MRZ is located fully inside the result document image, if present on the document. Enabling this option may add extra processing time, by disabling optimizations, but allows more stability in output image quality. Disabled by default.
255
+ * @type {boolean}
256
+ * @memberof ProcessParams
257
+ */
258
+ forceReadMrzBeforeLocate?: boolean;
259
+ /**
260
+ * This option can be disabled to stop parsing after barcode is read. Enabled by default.
261
+ * @type {boolean}
262
+ * @memberof ProcessParams
263
+ */
264
+ parseBarcodes?: boolean;
265
+ /**
266
+ *
267
+ * @type {TextPostProcessing}
268
+ * @memberof ProcessParams
269
+ */
270
+ convertCase?: TextPostProcessing;
271
+ /**
272
+ * When enabled, the Surname and GivenNames field will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.
273
+ * @type {boolean}
274
+ * @memberof ProcessParams
275
+ */
276
+ splitNames?: boolean;
277
+ /**
278
+ * When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default.
279
+ * @type {boolean}
280
+ * @memberof ProcessParams
281
+ */
282
+ disablePerforationOCR?: boolean;
283
+ /**
284
+ * List of specific eligible document types from DocumentType enum to recognize from. You may, for example, specify only passports to be recognized by setting this property. Empty by default.
285
+ * @type {Array<DocumentType>}
286
+ * @memberof ProcessParams
287
+ */
288
+ documentGroupFilter?: Array<DocumentType>;
289
+ /**
290
+ *
291
+ * @type {AuthenticityResultType<object>}
292
+ * @memberof ProcessParams
293
+ */
294
+ processAuth?: number;
295
+ /**
296
+ * This parameter is used to specify the document reader device type from which input images were captured. Default 0.
297
+ * @type {number}
298
+ * @memberof ProcessParams
299
+ */
300
+ deviceId?: number;
301
+ /**
302
+ * This parameter is used to specify the document reader device type from which input images were captured. Default 0.
303
+ * @type {number}
304
+ * @memberof ProcessParams
305
+ */
306
+ deviceType?: number;
307
+ /**
308
+ * This parameter is used to specify the document reader device type from which input images were captured
309
+ * @type {string}
310
+ * @memberof ProcessParams
311
+ */
312
+ deviceTypeHex?: string;
313
+ /**
314
+ * This parameter is used to tell the processing engine to ignore any parameters saved in the image when scanned from the document reader device. Default false
315
+ * @type {boolean}
316
+ * @memberof ProcessParams
317
+ */
318
+ ignoreDeviceIdFromImage?: boolean;
319
+ /**
320
+ * List of the document ID\'s to process. All documents will be processed, if empty.
321
+ * @type {Array<number>}
322
+ * @memberof ProcessParams
323
+ */
324
+ documentIdList?: Array<number>;
325
+ /**
326
+ *
327
+ * @type {ProcessParamsRfid}
133
328
  * @memberof ProcessParams
134
329
  */
135
- imageQA?: ImageQA;
330
+ rfid?: ProcessParamsRfid;
136
331
  }
137
332
 
138
333
 
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -13,6 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
+ import { ContainerList } from './container-list';
16
17
  import { ProcessParams } from './process-params';
17
18
  import { ProcessRequestImage } from './process-request-image';
18
19
  import { ProcessSystemInfo } from './process-system-info';
@@ -23,6 +24,12 @@ import { ProcessSystemInfo } from './process-system-info';
23
24
  * @interface ProcessRequest
24
25
  */
25
26
  export interface ProcessRequest {
27
+ /**
28
+ * session id
29
+ * @type {string}
30
+ * @memberof ProcessRequest
31
+ */
32
+ tag?: string;
26
33
  /**
27
34
  *
28
35
  * @type {ProcessParams}
@@ -34,7 +41,25 @@ export interface ProcessRequest {
34
41
  * @type {Array<ProcessRequestImage>}
35
42
  * @memberof ProcessRequest
36
43
  */
37
- List: Array<ProcessRequestImage>;
44
+ List?: Array<ProcessRequestImage>;
45
+ /**
46
+ * Live portrait photo
47
+ * @type {string}
48
+ * @memberof ProcessRequest
49
+ */
50
+ livePortrait?: string;
51
+ /**
52
+ * Portrait photo from an external source
53
+ * @type {string}
54
+ * @memberof ProcessRequest
55
+ */
56
+ extPortrait?: string;
57
+ /**
58
+ *
59
+ * @type {ContainerList}
60
+ * @memberof ProcessRequest
61
+ */
62
+ ContainerList?: ContainerList;
38
63
  /**
39
64
  *
40
65
  * @type {ProcessSystemInfo}
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -60,6 +60,18 @@ export interface ProcessResponse {
60
60
  * @memberof ProcessResponse
61
61
  */
62
62
  passBackObject?: { [key: string]: object; };
63
+ /**
64
+ *
65
+ * @type {number}
66
+ * @memberof ProcessResponse
67
+ */
68
+ morePagesAvailable?: number;
69
+ /**
70
+ * Time the document processing has taken, ms.
71
+ * @type {number}
72
+ * @memberof ProcessResponse
73
+ */
74
+ elapsedTime?: number;
63
75
  }
64
76
 
65
77
 
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -4,7 +4,7 @@
4
4
  * Regula Document Reader Web API
5
5
  * 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
6
6
  *
7
- * The version of the OpenAPI document: 5.5.0
7
+ * The version of the OpenAPI document: 6.8.0
8
8
  *
9
9
  *
10
10
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -15,12 +15,16 @@
15
15
 
16
16
  import { AuthenticityResult } from './authenticity-result';
17
17
  import { ChosenDocumentTypeResult } from './chosen-document-type-result';
18
+ import { DocBarCodeInfo } from './doc-bar-code-info';
18
19
  import { DocumentImageResult } from './document-image-result';
20
+ import { DocumentPositionResult } from './document-position-result';
19
21
  import { DocumentTypesCandidatesResult } from './document-types-candidates-result';
22
+ import { EncryptedRCLResult } from './encrypted-rclresult';
20
23
  import { GraphicsResult } from './graphics-result';
21
24
  import { ImageQualityResult } from './image-quality-result';
22
25
  import { ImagesResult } from './images-result';
23
26
  import { LexicalAnalysisResult } from './lexical-analysis-result';
27
+ import { LicenseResult } from './license-result';
24
28
  import { StatusResult } from './status-result';
25
29
  import { TextDataResult } from './text-data-result';
26
30
  import { TextResult } from './text-result';