regula-documentreader-webclient 8.1.354.dev0__py3-none-any.whl → 8.1.355rc0__py3-none-any.whl

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.

Potentially problematic release.


This version of regula-documentreader-webclient might be problematic. Click here for more details.

Files changed (289) hide show
  1. regula/documentreader/webclient/ext/__init__.py +1 -0
  2. regula/documentreader/webclient/ext/api/document_reader_api.py +2 -2
  3. regula/documentreader/webclient/ext/models/__init__.py +2 -0
  4. regula/documentreader/webclient/ext/models/authenticity/authenticity_check_list.py +19 -64
  5. regula/documentreader/webclient/ext/models/authenticity/fiber.py +7 -7
  6. regula/documentreader/webclient/ext/models/authenticity/ident.py +9 -10
  7. regula/documentreader/webclient/ext/models/authenticity/image_ident.py +7 -8
  8. regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py +7 -7
  9. regula/documentreader/webclient/ext/models/authenticity/security_feature.py +8 -10
  10. regula/documentreader/webclient/ext/models/images.py +4 -4
  11. regula/documentreader/webclient/ext/models/raw_authenticity_result_item.py +27 -0
  12. regula/documentreader/webclient/ext/models/raw_result_item.py +26 -0
  13. regula/documentreader/webclient/ext/models/recognition_request.py +24 -23
  14. regula/documentreader/webclient/ext/models/recognition_response.py +8 -6
  15. regula/documentreader/webclient/ext/models/text.py +12 -7
  16. regula/documentreader/webclient/gen/__init__.py +26 -100
  17. regula/documentreader/webclient/gen/api/__init__.py +2 -1
  18. regula/documentreader/webclient/gen/api/default_api.py +160 -0
  19. regula/documentreader/webclient/gen/api/healthcheck_api.py +298 -687
  20. regula/documentreader/webclient/gen/api/process_api.py +125 -270
  21. regula/documentreader/webclient/gen/api/transaction_api.py +673 -1472
  22. regula/documentreader/webclient/gen/api_client.py +462 -583
  23. regula/documentreader/webclient/gen/configuration.py +99 -222
  24. regula/documentreader/webclient/gen/exceptions.py +30 -81
  25. regula/documentreader/webclient/gen/models/__init__.py +25 -98
  26. regula/documentreader/webclient/gen/models/area_array.py +131 -85
  27. regula/documentreader/webclient/gen/models/area_container.py +157 -85
  28. regula/documentreader/webclient/gen/models/auth_params.py +526 -100
  29. regula/documentreader/webclient/gen/models/authenticity_check_list.py +136 -75
  30. regula/documentreader/webclient/gen/models/authenticity_check_result.py +160 -81
  31. regula/documentreader/webclient/gen/models/authenticity_check_result_item.py +217 -154
  32. regula/documentreader/webclient/gen/models/authenticity_result.py +231 -68
  33. regula/documentreader/webclient/gen/models/authenticity_result_all_of.py +120 -0
  34. regula/documentreader/webclient/gen/models/authenticity_result_type.py +123 -35
  35. regula/documentreader/webclient/gen/models/bc_pdf417_info.py +235 -75
  36. regula/documentreader/webclient/gen/models/bc_roidetect.py +183 -71
  37. regula/documentreader/webclient/gen/models/byte_array_result.py +233 -64
  38. regula/documentreader/webclient/gen/models/byte_array_result_all_of.py +122 -0
  39. regula/documentreader/webclient/gen/models/check_diagnose.py +329 -138
  40. regula/documentreader/webclient/gen/models/check_result.py +84 -15
  41. regula/documentreader/webclient/gen/models/chosen_document_type.py +334 -94
  42. regula/documentreader/webclient/gen/models/chosen_document_type_result.py +264 -80
  43. regula/documentreader/webclient/gen/models/chosen_document_type_result_all_of.py +145 -0
  44. regula/documentreader/webclient/gen/models/container_list.py +134 -75
  45. regula/documentreader/webclient/gen/models/critical.py +82 -14
  46. regula/documentreader/webclient/gen/models/cross_source_value_comparison.py +156 -67
  47. regula/documentreader/webclient/gen/models/data_module.py +209 -74
  48. regula/documentreader/webclient/gen/models/details_optical.py +298 -83
  49. regula/documentreader/webclient/gen/models/details_rfid.py +268 -78
  50. regula/documentreader/webclient/gen/models/device_info.py +235 -76
  51. regula/documentreader/webclient/gen/models/device_info2.py +275 -0
  52. regula/documentreader/webclient/gen/models/doc_bar_code_info.py +230 -68
  53. regula/documentreader/webclient/gen/models/doc_bar_code_info_all_of.py +119 -0
  54. regula/documentreader/webclient/gen/models/doc_bar_code_info_fields_list.py +135 -75
  55. regula/documentreader/webclient/gen/models/doc_visual_extended_field.py +301 -105
  56. regula/documentreader/webclient/gen/models/doc_visual_extended_info.py +106 -75
  57. regula/documentreader/webclient/gen/models/document_format.py +105 -27
  58. regula/documentreader/webclient/gen/models/document_image.py +132 -63
  59. regula/documentreader/webclient/gen/models/document_image_result.py +231 -68
  60. regula/documentreader/webclient/gen/models/document_image_result_all_of.py +120 -0
  61. regula/documentreader/webclient/gen/models/document_position.py +340 -111
  62. regula/documentreader/webclient/gen/models/document_position_result.py +230 -68
  63. regula/documentreader/webclient/gen/models/document_position_result_all_of.py +119 -0
  64. regula/documentreader/webclient/gen/models/document_type.py +539 -243
  65. regula/documentreader/webclient/gen/models/document_type_recognition_result.py +84 -15
  66. regula/documentreader/webclient/gen/models/document_types_candidates.py +131 -76
  67. regula/documentreader/webclient/gen/models/document_types_candidates_list.py +131 -76
  68. regula/documentreader/webclient/gen/models/document_types_candidates_result.py +230 -68
  69. regula/documentreader/webclient/gen/models/document_types_candidates_result_all_of.py +119 -0
  70. regula/documentreader/webclient/gen/models/documents_database.py +191 -71
  71. regula/documentreader/webclient/gen/models/encrypted_rcl_result.py +233 -64
  72. regula/documentreader/webclient/gen/models/encrypted_rcl_result_all_of.py +122 -0
  73. regula/documentreader/webclient/gen/models/face_api.py +358 -88
  74. regula/documentreader/webclient/gen/models/face_api_search.py +159 -65
  75. regula/documentreader/webclient/gen/models/fdsid_list.py +390 -91
  76. regula/documentreader/webclient/gen/models/fiber_result.py +439 -103
  77. regula/documentreader/webclient/gen/models/fiber_result_all_of.py +343 -0
  78. regula/documentreader/webclient/gen/models/get_transactions_by_tag_response.py +159 -66
  79. regula/documentreader/webclient/gen/models/graphic_field.py +271 -80
  80. regula/documentreader/webclient/gen/models/graphic_field_type.py +131 -40
  81. regula/documentreader/webclient/gen/models/graphic_fields_list.py +106 -75
  82. regula/documentreader/webclient/gen/models/graphics_result.py +231 -68
  83. regula/documentreader/webclient/gen/models/graphics_result_all_of.py +119 -0
  84. regula/documentreader/webclient/gen/models/healthcheck.py +297 -117
  85. regula/documentreader/webclient/gen/models/healthcheck_documents_database.py +187 -91
  86. regula/documentreader/webclient/gen/models/ident_result.py +345 -107
  87. regula/documentreader/webclient/gen/models/ident_result_all_of.py +249 -0
  88. regula/documentreader/webclient/gen/models/image_data.py +132 -63
  89. regula/documentreader/webclient/gen/models/image_qa.py +304 -83
  90. regula/documentreader/webclient/gen/models/image_quality_check.py +263 -86
  91. regula/documentreader/webclient/gen/models/image_quality_check_list.py +133 -78
  92. regula/documentreader/webclient/gen/models/image_quality_check_type.py +97 -22
  93. regula/documentreader/webclient/gen/models/image_quality_result.py +231 -68
  94. regula/documentreader/webclient/gen/models/image_quality_result_all_of.py +120 -0
  95. regula/documentreader/webclient/gen/models/image_transaction_data.py +97 -61
  96. regula/documentreader/webclient/gen/models/images.py +133 -87
  97. regula/documentreader/webclient/gen/models/images_available_source.py +130 -64
  98. regula/documentreader/webclient/gen/models/images_field.py +162 -80
  99. regula/documentreader/webclient/gen/models/images_field_value.py +331 -94
  100. regula/documentreader/webclient/gen/models/images_result.py +231 -68
  101. regula/documentreader/webclient/gen/models/images_result_all_of.py +120 -0
  102. regula/documentreader/webclient/gen/models/in_data.py +131 -79
  103. regula/documentreader/webclient/gen/models/in_data_rfid_session.py +121 -0
  104. regula/documentreader/webclient/gen/models/in_data_transaction_images_field_value.py +187 -72
  105. regula/documentreader/webclient/gen/models/in_data_video.py +131 -63
  106. regula/documentreader/webclient/gen/models/inline_response200.py +197 -0
  107. regula/documentreader/webclient/gen/models/inline_response2001.py +333 -0
  108. regula/documentreader/webclient/gen/models/input_barcode_type.py +119 -33
  109. regula/documentreader/webclient/gen/models/input_image_quality_checks.py +97 -22
  110. regula/documentreader/webclient/gen/models/lcid.py +402 -179
  111. regula/documentreader/webclient/gen/models/lexical_analysis_result.py +234 -68
  112. regula/documentreader/webclient/gen/models/lexical_analysis_result_all_of.py +119 -0
  113. regula/documentreader/webclient/gen/models/license_result.py +233 -64
  114. regula/documentreader/webclient/gen/models/license_result_all_of.py +122 -0
  115. regula/documentreader/webclient/gen/models/light.py +87 -61
  116. regula/documentreader/webclient/gen/models/list_transactions_by_tag_response.py +131 -75
  117. regula/documentreader/webclient/gen/models/list_verified_fields.py +105 -77
  118. regula/documentreader/webclient/gen/models/liveness_params.py +247 -77
  119. regula/documentreader/webclient/gen/models/log_level.py +88 -17
  120. regula/documentreader/webclient/gen/models/measure_system.py +82 -14
  121. regula/documentreader/webclient/gen/models/mrz_detect_mode_enum.py +84 -15
  122. regula/documentreader/webclient/gen/models/mrz_format.py +90 -18
  123. regula/documentreader/webclient/gen/models/ocr_security_text_result.py +449 -107
  124. regula/documentreader/webclient/gen/models/ocr_security_text_result_all_of.py +353 -0
  125. regula/documentreader/webclient/gen/models/one_candidate.py +334 -94
  126. regula/documentreader/webclient/gen/models/original_symbol.py +167 -74
  127. regula/documentreader/webclient/gen/models/out_data.py +133 -75
  128. regula/documentreader/webclient/gen/models/out_data_transaction_images_field_value.py +213 -75
  129. regula/documentreader/webclient/gen/models/p_array_field.py +342 -103
  130. regula/documentreader/webclient/gen/models/parsing_notification_codes.py +523 -235
  131. regula/documentreader/webclient/gen/models/per_document_config.py +131 -63
  132. regula/documentreader/webclient/gen/models/photo_ident_result.py +423 -107
  133. regula/documentreader/webclient/gen/models/photo_ident_result_all_of.py +327 -0
  134. regula/documentreader/webclient/gen/models/point.py +127 -63
  135. regula/documentreader/webclient/gen/models/point_array.py +97 -65
  136. regula/documentreader/webclient/gen/models/points_container.py +131 -75
  137. regula/documentreader/webclient/gen/models/process_params.py +1743 -229
  138. regula/documentreader/webclient/gen/models/process_params_rfid.py +97 -56
  139. regula/documentreader/webclient/gen/models/process_request.py +411 -113
  140. regula/documentreader/webclient/gen/models/process_request_image.py +159 -74
  141. regula/documentreader/webclient/gen/models/process_response.py +299 -96
  142. regula/documentreader/webclient/gen/models/process_system_info.py +131 -63
  143. regula/documentreader/webclient/gen/models/processing_status.py +84 -15
  144. regula/documentreader/webclient/gen/models/raw_image_container_list.py +131 -75
  145. regula/documentreader/webclient/gen/models/rectangle_coordinates.py +187 -71
  146. regula/documentreader/webclient/gen/models/result.py +133 -49
  147. regula/documentreader/webclient/gen/models/result_item.py +245 -195
  148. regula/documentreader/webclient/gen/models/rfid_location.py +84 -15
  149. regula/documentreader/webclient/gen/models/rfid_origin.py +192 -71
  150. regula/documentreader/webclient/gen/models/scenario.py +117 -33
  151. regula/documentreader/webclient/gen/models/security_feature_result.py +345 -99
  152. regula/documentreader/webclient/gen/models/security_feature_result_all_of.py +249 -0
  153. regula/documentreader/webclient/gen/models/security_feature_type.py +185 -68
  154. regula/documentreader/webclient/gen/models/source.py +88 -18
  155. regula/documentreader/webclient/gen/models/source_validity.py +129 -65
  156. regula/documentreader/webclient/gen/models/status.py +264 -86
  157. regula/documentreader/webclient/gen/models/status_result.py +231 -68
  158. regula/documentreader/webclient/gen/models/status_result_all_of.py +120 -0
  159. regula/documentreader/webclient/gen/models/string_recognition_result.py +108 -81
  160. regula/documentreader/webclient/gen/models/symbol_candidate.py +143 -72
  161. regula/documentreader/webclient/gen/models/symbol_recognition_result.py +135 -87
  162. regula/documentreader/webclient/gen/models/text.py +214 -92
  163. regula/documentreader/webclient/gen/models/text_available_source.py +157 -67
  164. regula/documentreader/webclient/gen/models/text_data_result.py +230 -68
  165. regula/documentreader/webclient/gen/models/text_data_result_all_of.py +119 -0
  166. regula/documentreader/webclient/gen/models/text_field.py +357 -115
  167. regula/documentreader/webclient/gen/models/text_field_type.py +1367 -660
  168. regula/documentreader/webclient/gen/models/text_field_value.py +307 -105
  169. regula/documentreader/webclient/gen/models/text_post_processing.py +86 -16
  170. regula/documentreader/webclient/gen/models/text_result.py +231 -68
  171. regula/documentreader/webclient/gen/models/text_result_all_of.py +120 -0
  172. regula/documentreader/webclient/gen/models/tfdsid_list.py +372 -0
  173. regula/documentreader/webclient/gen/models/transaction_image.py +97 -61
  174. regula/documentreader/webclient/gen/models/transaction_images_field_value.py +227 -0
  175. regula/documentreader/webclient/gen/models/transaction_info.py +302 -84
  176. regula/documentreader/webclient/gen/models/transaction_process_get_response.py +183 -79
  177. regula/documentreader/webclient/gen/models/transaction_process_request.py +299 -108
  178. regula/documentreader/webclient/gen/models/transaction_scenario_request.py +119 -0
  179. regula/documentreader/webclient/gen/models/verification_result.py +88 -17
  180. regula/documentreader/webclient/gen/models/verified_field_map.py +273 -85
  181. regula/documentreader/webclient/gen/models/visibility.py +88 -17
  182. regula/documentreader/webclient/gen/rest.py +174 -132
  183. {regula_documentreader_webclient-8.1.354.dev0.dist-info → regula_documentreader_webclient-8.1.355rc0.dist-info}/METADATA +4 -6
  184. regula_documentreader_webclient-8.1.355rc0.dist-info/RECORD +192 -0
  185. regula/documentreader/webclient/gen/api_response.py +0 -21
  186. regula/documentreader/webclient/gen/models/authenticity_check_list_item.py +0 -83
  187. regula/documentreader/webclient/gen/models/authenticity_check_result_list_inner.py +0 -174
  188. regula/documentreader/webclient/gen/models/bar_code_module_type.py +0 -32
  189. regula/documentreader/webclient/gen/models/barcode_type.py +0 -47
  190. regula/documentreader/webclient/gen/models/binary_data.py +0 -218
  191. regula/documentreader/webclient/gen/models/byte_array_item.py +0 -79
  192. regula/documentreader/webclient/gen/models/candidates_list_item.py +0 -83
  193. regula/documentreader/webclient/gen/models/certificate_data.py +0 -81
  194. regula/documentreader/webclient/gen/models/container_list_list_inner.py +0 -426
  195. regula/documentreader/webclient/gen/models/doc_bar_code_info_item.py +0 -83
  196. regula/documentreader/webclient/gen/models/doc_graphics_info_item.py +0 -83
  197. regula/documentreader/webclient/gen/models/doc_visual_extended_field_item.py +0 -83
  198. regula/documentreader/webclient/gen/models/doc_visual_extended_info_item.py +0 -83
  199. regula/documentreader/webclient/gen/models/document_binary_info_result.py +0 -90
  200. regula/documentreader/webclient/gen/models/document_position_item.py +0 -83
  201. regula/documentreader/webclient/gen/models/encrypted_rcl_item.py +0 -79
  202. regula/documentreader/webclient/gen/models/error_coordinates.py +0 -85
  203. regula/documentreader/webclient/gen/models/face_detection.py +0 -95
  204. regula/documentreader/webclient/gen/models/face_detection_item.py +0 -83
  205. regula/documentreader/webclient/gen/models/face_detection_result.py +0 -90
  206. regula/documentreader/webclient/gen/models/face_item.py +0 -109
  207. regula/documentreader/webclient/gen/models/fiber_item.py +0 -106
  208. regula/documentreader/webclient/gen/models/field_item.py +0 -89
  209. regula/documentreader/webclient/gen/models/file_image.py +0 -81
  210. regula/documentreader/webclient/gen/models/graph_data.py +0 -95
  211. regula/documentreader/webclient/gen/models/ident_item.py +0 -110
  212. regula/documentreader/webclient/gen/models/image_quality_check_list_item.py +0 -83
  213. regula/documentreader/webclient/gen/models/images_item.py +0 -83
  214. regula/documentreader/webclient/gen/models/license_item.py +0 -79
  215. regula/documentreader/webclient/gen/models/list_verified_fields_item.py +0 -83
  216. regula/documentreader/webclient/gen/models/mrz_detector_result.py +0 -90
  217. regula/documentreader/webclient/gen/models/mrz_position.py +0 -124
  218. regula/documentreader/webclient/gen/models/mrz_position_item.py +0 -83
  219. regula/documentreader/webclient/gen/models/mrz_position_result.py +0 -90
  220. regula/documentreader/webclient/gen/models/mrz_rows_item.py +0 -91
  221. regula/documentreader/webclient/gen/models/mrz_test_quality.py +0 -105
  222. regula/documentreader/webclient/gen/models/mrz_test_quality_item.py +0 -83
  223. regula/documentreader/webclient/gen/models/mrz_test_quality_result.py +0 -90
  224. regula/documentreader/webclient/gen/models/ocr_security_text_item.py +0 -110
  225. regula/documentreader/webclient/gen/models/one_candidate_item.py +0 -87
  226. regula/documentreader/webclient/gen/models/parsed_data.py +0 -79
  227. regula/documentreader/webclient/gen/models/parsing_error_codes.py +0 -153
  228. regula/documentreader/webclient/gen/models/photo_ident_item.py +0 -110
  229. regula/documentreader/webclient/gen/models/raw_image_container_item.py +0 -83
  230. regula/documentreader/webclient/gen/models/result_mrz_detector.py +0 -93
  231. regula/documentreader/webclient/gen/models/result_mrz_detector_item.py +0 -83
  232. regula/documentreader/webclient/gen/models/rfid_a_chip.py +0 -33
  233. regula/documentreader/webclient/gen/models/rfid_access_control_info.py +0 -90
  234. regula/documentreader/webclient/gen/models/rfid_access_control_procedure_type.py +0 -35
  235. regula/documentreader/webclient/gen/models/rfid_access_key.py +0 -87
  236. regula/documentreader/webclient/gen/models/rfid_application.py +0 -101
  237. regula/documentreader/webclient/gen/models/rfid_application_type.py +0 -37
  238. regula/documentreader/webclient/gen/models/rfid_attribute_data.py +0 -81
  239. regula/documentreader/webclient/gen/models/rfid_attribute_name.py +0 -85
  240. regula/documentreader/webclient/gen/models/rfid_authentication_procedure_type.py +0 -31
  241. regula/documentreader/webclient/gen/models/rfid_baud_rate.py +0 -32
  242. regula/documentreader/webclient/gen/models/rfid_card_properties_ext.py +0 -123
  243. regula/documentreader/webclient/gen/models/rfid_certificate_ex.py +0 -130
  244. regula/documentreader/webclient/gen/models/rfid_certificate_origin.py +0 -36
  245. regula/documentreader/webclient/gen/models/rfid_certificate_type.py +0 -35
  246. regula/documentreader/webclient/gen/models/rfid_data_file.py +0 -118
  247. regula/documentreader/webclient/gen/models/rfid_data_file_type.py +0 -119
  248. regula/documentreader/webclient/gen/models/rfid_data_group_type_tag.py +0 -82
  249. regula/documentreader/webclient/gen/models/rfid_dg1.py +0 -111
  250. regula/documentreader/webclient/gen/models/rfid_distinguished_name.py +0 -95
  251. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field.py +0 -120
  252. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_field_item.py +0 -85
  253. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_info.py +0 -89
  254. regula/documentreader/webclient/gen/models/rfid_doc_visual_extended_info_item.py +0 -83
  255. regula/documentreader/webclient/gen/models/rfid_error_codes.py +0 -141
  256. regula/documentreader/webclient/gen/models/rfid_graphics_info_result.py +0 -90
  257. regula/documentreader/webclient/gen/models/rfid_password_type.py +0 -34
  258. regula/documentreader/webclient/gen/models/rfid_pki_extension.py +0 -81
  259. regula/documentreader/webclient/gen/models/rfid_raw_data.py +0 -81
  260. regula/documentreader/webclient/gen/models/rfid_security_object.py +0 -96
  261. regula/documentreader/webclient/gen/models/rfid_session_data.py +0 -150
  262. regula/documentreader/webclient/gen/models/rfid_signer_info_ex.py +0 -133
  263. regula/documentreader/webclient/gen/models/rfid_terminal.py +0 -84
  264. regula/documentreader/webclient/gen/models/rfid_terminal_type.py +0 -32
  265. regula/documentreader/webclient/gen/models/rfid_text_data_result.py +0 -90
  266. regula/documentreader/webclient/gen/models/rfid_type.py +0 -30
  267. regula/documentreader/webclient/gen/models/rfid_validity.py +0 -88
  268. regula/documentreader/webclient/gen/models/rfidpkd_resource_type.py +0 -35
  269. regula/documentreader/webclient/gen/models/security_feature_item.py +0 -102
  270. regula/documentreader/webclient/gen/models/security_object_certificates.py +0 -83
  271. regula/documentreader/webclient/gen/models/status_item.py +0 -83
  272. regula/documentreader/webclient/gen/models/string_item.py +0 -135
  273. regula/documentreader/webclient/gen/models/symbol.py +0 -79
  274. regula/documentreader/webclient/gen/models/symbol_estimation_item.py +0 -115
  275. regula/documentreader/webclient/gen/models/t_doc_binary_info.py +0 -93
  276. regula/documentreader/webclient/gen/models/t_doc_binary_info_item.py +0 -83
  277. regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info.py +0 -87
  278. regula/documentreader/webclient/gen/models/t_original_rfid_graphics_info_item.py +0 -83
  279. regula/documentreader/webclient/gen/models/text_item.py +0 -83
  280. regula/documentreader/webclient/gen/models/transaction_process_response.py +0 -107
  281. regula/documentreader/webclient/gen/models/transaction_process_response_item.py +0 -79
  282. regula/documentreader/webclient/gen/models/transaction_process_result.py +0 -93
  283. regula/documentreader/webclient/gen/models/trf_ft_bytes.py +0 -90
  284. regula/documentreader/webclient/gen/models/trf_ft_string.py +0 -85
  285. regula/documentreader/webclient/gen/models/visual_extended_field_item.py +0 -112
  286. regula/documentreader/webclient/gen/py.typed +0 -0
  287. regula_documentreader_webclient-8.1.354.dev0.dist-info/RECORD +0 -263
  288. {regula_documentreader_webclient-8.1.354.dev0.dist-info → regula_documentreader_webclient-8.1.355rc0.dist-info}/WHEEL +0 -0
  289. {regula_documentreader_webclient-8.1.354.dev0.dist-info → regula_documentreader_webclient-8.1.355rc0.dist-info}/top_level.txt +0 -0
@@ -4,237 +4,1751 @@
4
4
  Generated by: https://openapi-generator.tech
5
5
  """
6
6
 
7
- from __future__ import annotations
8
7
  import pprint
9
8
  import re # noqa: F401
10
- import json
11
-
12
- from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
13
- from typing import Any, ClassVar, Dict, List, Optional
14
- from regula.documentreader.webclient.gen.models.auth_params import AuthParams
15
- from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
16
- from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
17
- from regula.documentreader.webclient.gen.models.document_type import DocumentType
18
- from regula.documentreader.webclient.gen.models.face_api import FaceApi
19
- from regula.documentreader.webclient.gen.models.image_qa import ImageQA
20
- from regula.documentreader.webclient.gen.models.input_barcode_type import InputBarcodeType
21
- from regula.documentreader.webclient.gen.models.lcid import LCID
22
- from regula.documentreader.webclient.gen.models.log_level import LogLevel
23
- from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
24
- from regula.documentreader.webclient.gen.models.mrz_detect_mode_enum import MrzDetectModeEnum
25
- from regula.documentreader.webclient.gen.models.mrz_format import MRZFormat
26
- from regula.documentreader.webclient.gen.models.per_document_config import PerDocumentConfig
27
- from regula.documentreader.webclient.gen.models.process_params_rfid import ProcessParamsRfid
28
- from regula.documentreader.webclient.gen.models.result import Result
29
- from regula.documentreader.webclient.gen.models.scenario import Scenario
30
- from regula.documentreader.webclient.gen.models.text_field_type import TextFieldType
31
- from regula.documentreader.webclient.gen.models.text_post_processing import TextPostProcessing
32
- from typing import Optional, Set
33
- from typing_extensions import Self
34
-
35
- class ProcessParams(BaseModel):
9
+
10
+ import six
11
+
12
+ from regula.documentreader.webclient.gen.configuration import Configuration
13
+ # this line was added to enable pycharm type hinting
14
+ from regula.documentreader.webclient.gen.models import *
15
+
16
+
17
+ """
18
+
19
+ """
20
+ class ProcessParams(object):
21
+ """NOTE: This class is auto generated by OpenAPI Generator.
22
+ Ref: https://openapi-generator.tech
23
+
24
+ Do not edit the class manually.
36
25
  """
37
- ProcessParams
38
- """ # noqa: E501
39
- generate_dtcvc: Optional[StrictBool] = Field(default=None, description="This parameter is used to generate separate DTC-VC data container from RFID session data.", alias="generateDTCVC")
40
- lcid_filter: Optional[List[LCID]] = Field(default=None, description="The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default.", alias="lcidFilter")
41
- check_liveness: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable document liveness check.", alias="checkLiveness")
42
- lcid_ignore_filter: Optional[List[LCID]] = Field(default=None, description="The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default.", alias="lcidIgnoreFilter")
43
- one_shot_identification: Optional[StrictBool] = Field(default=None, description="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", alias="oneShotIdentification")
44
- use_face_api: Optional[StrictBool] = Field(default=None, description="This parameter allows comparing faces on Regula Face Web Service", alias="useFaceApi")
45
- face_api: Optional[FaceApi] = Field(default=None, alias="faceApi")
46
- do_detect_can: Optional[StrictBool] = Field(default=None, description="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.", alias="doDetectCan")
47
- image_output_max_height: Optional[StrictInt] = Field(default=None, description="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.", alias="imageOutputMaxHeight")
48
- image_output_max_width: Optional[StrictInt] = Field(default=None, description="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.", alias="imageOutputMaxWidth")
49
- scenario: Scenario
50
- result_type_output: Optional[List[Result]] = Field(default=None, description="Types of results to return in response. See 'Result' enum for available options", alias="resultTypeOutput")
51
- double_page_spread: Optional[StrictBool] = Field(default=None, description="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.", alias="doublePageSpread")
52
- generate_double_page_spread_image: Optional[StrictBool] = Field(default=None, description="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.", alias="generateDoublePageSpreadImage")
53
- field_types_filter: Optional[List[TextFieldType]] = Field(default=None, description="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.", alias="fieldTypesFilter")
54
- date_format: Optional[StrictStr] = Field(default=None, description="This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running).", alias="dateFormat")
55
- measure_system: Optional[MeasureSystem] = Field(default=None, alias="measureSystem")
56
- image_dpi_out_max: Optional[StrictInt] = Field(default=None, description="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.", alias="imageDpiOutMax")
57
- already_cropped: Optional[StrictBool] = Field(default=None, description="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.", alias="alreadyCropped")
58
- custom_params: Optional[Dict[str, Any]] = Field(default=None, description="This option allows passing custom processing parameters that can be implemented in future without changing API.", alias="customParams")
59
- config: Optional[List[PerDocumentConfig]] = Field(default=None, description="This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration.")
60
- log: Optional[StrictBool] = Field(default=None, description="When enabled, results will contain transaction processing log. Disabled by default")
61
- log_level: Optional[LogLevel] = Field(default=None, alias="logLevel")
62
- force_doc_id: Optional[StrictInt] = Field(default=None, description="Force use of specific template ID and skip document type identification step.", alias="forceDocID")
63
- match_text_field_mask: Optional[StrictBool] = Field(default=None, description="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.", alias="matchTextFieldMask")
64
- fast_doc_detect: Optional[StrictBool] = Field(default=None, description="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.", alias="fastDocDetect")
65
- update_ocr_validity_by_glare: Optional[StrictBool] = Field(default=None, description="When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default.", alias="updateOCRValidityByGlare")
66
- check_required_text_fields: Optional[StrictBool] = Field(default=None, description="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.", alias="checkRequiredTextFields")
67
- return_cropped_barcode: Optional[StrictBool] = Field(default=None, description="When enabled, returns cropped barcode images for unknown documents. Disabled by default.", alias="returnCroppedBarcode")
68
- image_qa: Optional[ImageQA] = Field(default=None, alias="imageQa")
69
- strict_image_quality: Optional[StrictBool] = Field(default=None, description="When enabled, the image quality check status affects the document optical and overall status. Disabled by default.", alias="strictImageQuality")
70
- respect_image_quality: Optional[StrictBool] = Field(default=None, description="Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default.", alias="respectImageQuality")
71
- force_doc_format: Optional[DocumentFormat] = Field(default=None, alias="forceDocFormat")
72
- no_graphics: Optional[StrictBool] = Field(default=None, description="When enabled, no graphic fields will be cropped from document image. Disabled by default.", alias="noGraphics")
73
- depersonalize_log: Optional[StrictBool] = Field(default=None, description="When enabled, all personal data will be forcibly removed from the logs. Disabled by default.", alias="depersonalizeLog")
74
- multi_doc_on_image: Optional[StrictBool] = Field(default=None, description="This option allows locating and cropping multiple documents from one image if enabled. Disabled by default.", alias="multiDocOnImage")
75
- shift_expiry_date: Optional[StrictInt] = Field(default=None, description="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", alias="shiftExpiryDate")
76
- minimal_holder_age: Optional[StrictInt] = Field(default=None, description="This options allows specifying the minimal age in years of the document holder for the document to be considered valid.", alias="minimalHolderAge")
77
- return_uncropped_image: Optional[StrictBool] = Field(default=None, description="When enabled, returns input images in output. Disabled by default.", alias="returnUncroppedImage")
78
- mrz_formats_filter: Optional[List[MRZFormat]] = Field(default=None, description="This option allows limiting MRZ formats to be recognized by specifying them in array.", alias="mrzFormatsFilter")
79
- force_read_mrz_before_locate: Optional[StrictBool] = Field(default=None, description="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.", alias="forceReadMrzBeforeLocate")
80
- parse_barcodes: Optional[StrictBool] = Field(default=None, description="This option can be disabled to stop parsing after barcode is read. Enabled by default.", alias="parseBarcodes")
81
- convert_case: Optional[TextPostProcessing] = Field(default=None, alias="convertCase")
82
- split_names: Optional[StrictBool] = Field(default=None, description="When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default.", alias="splitNames")
83
- disable_perforation_ocr: Optional[StrictBool] = Field(default=None, description="When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default.", alias="disablePerforationOCR")
84
- document_group_filter: Optional[List[DocumentType]] = Field(default=None, description="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.", alias="documentGroupFilter")
85
- process_auth: Optional[AuthenticityResultType] = Field(default=None, alias="processAuth")
86
- device_id: Optional[StrictInt] = Field(default=None, description="This parameter is used to specify the document reader device type from which input images were captured. Default 0.", alias="deviceId")
87
- device_type: Optional[StrictInt] = Field(default=None, description="This parameter is used to specify the document reader device type from which input images were captured. Default 0.", alias="deviceType")
88
- device_type_hex: Optional[StrictStr] = Field(default=None, description="This parameter is used to specify the document reader device type from which input images were captured", alias="deviceTypeHex")
89
- ignore_device_id_from_image: Optional[StrictBool] = Field(default=None, description="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", alias="ignoreDeviceIdFromImage")
90
- document_id_list: Optional[List[StrictInt]] = Field(default=None, description="List of the document ID's to process. All documents will be processed, if empty.", alias="documentIdList")
91
- rfid: Optional[ProcessParamsRfid] = None
92
- check_auth: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable authenticity checks", alias="checkAuth")
93
- auth_params: Optional[AuthParams] = Field(default=None, alias="authParams")
94
- mrz_detect_mode: Optional[MrzDetectModeEnum] = Field(default=None, alias="mrzDetectMode")
95
- generate_numeric_codes: Optional[StrictBool] = Field(default=None, description="This parameter is used to generate numeric representation for issuing state and nationality codes", alias="generateNumericCodes")
96
- strict_barcode_digital_signature_check: Optional[StrictBool] = Field(default=None, description="This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed.", alias="strictBarcodeDigitalSignatureCheck")
97
- select_longest_names: Optional[StrictBool] = Field(default=None, description="Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc.", alias="selectLongestNames")
98
- do_barcodes: Optional[List[InputBarcodeType]] = Field(default=None, description="Set the types of barcodes to process.", alias="doBarcodes")
99
- strict_dl_category_expiry: Optional[StrictBool] = Field(default=None, description="Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases.", alias="strictDLCategoryExpiry")
100
- generate_alpha2_codes: Optional[StrictBool] = Field(default=None, description="Set to generate Alpha-2 codes for nationality and issuing state fields.", alias="generateAlpha2Codes")
101
- pdf_pages_limit: Optional[StrictInt] = Field(default=None, description="Limits the number of pages to be processed from a PDF file.", alias="pdfPagesLimit")
102
- __properties: ClassVar[List[str]] = ["generateDTCVC", "lcidFilter", "checkLiveness", "lcidIgnoreFilter", "oneShotIdentification", "useFaceApi", "faceApi", "doDetectCan", "imageOutputMaxHeight", "imageOutputMaxWidth", "scenario", "resultTypeOutput", "doublePageSpread", "generateDoublePageSpreadImage", "fieldTypesFilter", "dateFormat", "measureSystem", "imageDpiOutMax", "alreadyCropped", "customParams", "config", "log", "logLevel", "forceDocID", "matchTextFieldMask", "fastDocDetect", "updateOCRValidityByGlare", "checkRequiredTextFields", "returnCroppedBarcode", "imageQa", "strictImageQuality", "respectImageQuality", "forceDocFormat", "noGraphics", "depersonalizeLog", "multiDocOnImage", "shiftExpiryDate", "minimalHolderAge", "returnUncroppedImage", "mrzFormatsFilter", "forceReadMrzBeforeLocate", "parseBarcodes", "convertCase", "splitNames", "disablePerforationOCR", "documentGroupFilter", "processAuth", "deviceId", "deviceType", "deviceTypeHex", "ignoreDeviceIdFromImage", "documentIdList", "rfid", "checkAuth", "authParams", "mrzDetectMode", "generateNumericCodes", "strictBarcodeDigitalSignatureCheck", "selectLongestNames", "doBarcodes", "strictDLCategoryExpiry", "generateAlpha2Codes", "pdfPagesLimit"]
103
-
104
- model_config = ConfigDict(
105
- populate_by_name=True,
106
- validate_assignment=True,
107
- protected_namespaces=(),
108
- )
109
-
110
-
111
- def to_str(self) -> str:
112
- """Returns the string representation of the model using alias"""
113
- return pprint.pformat(self.model_dump(by_alias=True))
114
-
115
- def to_json(self) -> str:
116
- """Returns the JSON representation of the model using alias"""
117
- # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
118
- return json.dumps(self.to_dict())
119
-
120
- @classmethod
121
- def from_json(cls, json_str: str) -> Optional[Self]:
122
- """Create an instance of ProcessParams from a JSON string"""
123
- return cls.from_dict(json.loads(json_str))
124
-
125
- def to_dict(self) -> Dict[str, Any]:
126
- """Return the dictionary representation of the model using alias.
127
-
128
- This has the following differences from calling pydantic's
129
- `self.model_dump(by_alias=True)`:
130
-
131
- * `None` is only added to the output dict for nullable fields that
132
- were set at model initialization. Other fields with value `None`
133
- are ignored.
134
- """
135
- excluded_fields: Set[str] = set([
136
- ])
137
-
138
- _dict = self.model_dump(
139
- by_alias=True,
140
- exclude=excluded_fields,
141
- exclude_none=True,
142
- )
143
- # override the default output from pydantic by calling `to_dict()` of face_api
144
- if self.face_api:
145
- _dict['faceApi'] = self.face_api.to_dict()
146
- # override the default output from pydantic by calling `to_dict()` of each item in config (list)
147
- _items = []
148
- if self.config:
149
- for _item_config in self.config:
150
- if _item_config:
151
- _items.append(_item_config.to_dict())
152
- _dict['config'] = _items
153
- # override the default output from pydantic by calling `to_dict()` of image_qa
154
- if self.image_qa:
155
- _dict['imageQa'] = self.image_qa.to_dict()
156
- # override the default output from pydantic by calling `to_dict()` of rfid
157
- if self.rfid:
158
- _dict['rfid'] = self.rfid.to_dict()
159
- # override the default output from pydantic by calling `to_dict()` of auth_params
160
- if self.auth_params:
161
- _dict['authParams'] = self.auth_params.to_dict()
162
- return _dict
163
-
164
- @classmethod
165
- def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
166
- """Create an instance of ProcessParams from a dict"""
167
- if obj is None:
168
- return None
169
-
170
- if not isinstance(obj, dict):
171
- return cls.model_validate(obj)
172
-
173
- _obj = cls.model_validate({
174
- "generateDTCVC": obj.get("generateDTCVC"),
175
- "lcidFilter": obj.get("lcidFilter"),
176
- "checkLiveness": obj.get("checkLiveness"),
177
- "lcidIgnoreFilter": obj.get("lcidIgnoreFilter"),
178
- "oneShotIdentification": obj.get("oneShotIdentification"),
179
- "useFaceApi": obj.get("useFaceApi"),
180
- "faceApi": FaceApi.from_dict(obj["faceApi"]) if obj.get("faceApi") is not None else None,
181
- "doDetectCan": obj.get("doDetectCan"),
182
- "imageOutputMaxHeight": obj.get("imageOutputMaxHeight"),
183
- "imageOutputMaxWidth": obj.get("imageOutputMaxWidth"),
184
- "scenario": obj.get("scenario"),
185
- "resultTypeOutput": obj.get("resultTypeOutput"),
186
- "doublePageSpread": obj.get("doublePageSpread"),
187
- "generateDoublePageSpreadImage": obj.get("generateDoublePageSpreadImage"),
188
- "fieldTypesFilter": obj.get("fieldTypesFilter"),
189
- "dateFormat": obj.get("dateFormat"),
190
- "measureSystem": obj.get("measureSystem"),
191
- "imageDpiOutMax": obj.get("imageDpiOutMax"),
192
- "alreadyCropped": obj.get("alreadyCropped"),
193
- "customParams": obj.get("customParams"),
194
- "config": [PerDocumentConfig.from_dict(_item) for _item in obj["config"]] if obj.get("config") is not None else None,
195
- "log": obj.get("log"),
196
- "logLevel": obj.get("logLevel"),
197
- "forceDocID": obj.get("forceDocID"),
198
- "matchTextFieldMask": obj.get("matchTextFieldMask"),
199
- "fastDocDetect": obj.get("fastDocDetect"),
200
- "updateOCRValidityByGlare": obj.get("updateOCRValidityByGlare"),
201
- "checkRequiredTextFields": obj.get("checkRequiredTextFields"),
202
- "returnCroppedBarcode": obj.get("returnCroppedBarcode"),
203
- "imageQa": ImageQA.from_dict(obj["imageQa"]) if obj.get("imageQa") is not None else None,
204
- "strictImageQuality": obj.get("strictImageQuality"),
205
- "respectImageQuality": obj.get("respectImageQuality"),
206
- "forceDocFormat": obj.get("forceDocFormat"),
207
- "noGraphics": obj.get("noGraphics"),
208
- "depersonalizeLog": obj.get("depersonalizeLog"),
209
- "multiDocOnImage": obj.get("multiDocOnImage"),
210
- "shiftExpiryDate": obj.get("shiftExpiryDate"),
211
- "minimalHolderAge": obj.get("minimalHolderAge"),
212
- "returnUncroppedImage": obj.get("returnUncroppedImage"),
213
- "mrzFormatsFilter": obj.get("mrzFormatsFilter"),
214
- "forceReadMrzBeforeLocate": obj.get("forceReadMrzBeforeLocate"),
215
- "parseBarcodes": obj.get("parseBarcodes"),
216
- "convertCase": obj.get("convertCase"),
217
- "splitNames": obj.get("splitNames"),
218
- "disablePerforationOCR": obj.get("disablePerforationOCR"),
219
- "documentGroupFilter": obj.get("documentGroupFilter"),
220
- "processAuth": obj.get("processAuth"),
221
- "deviceId": obj.get("deviceId"),
222
- "deviceType": obj.get("deviceType"),
223
- "deviceTypeHex": obj.get("deviceTypeHex"),
224
- "ignoreDeviceIdFromImage": obj.get("ignoreDeviceIdFromImage"),
225
- "documentIdList": obj.get("documentIdList"),
226
- "rfid": ProcessParamsRfid.from_dict(obj["rfid"]) if obj.get("rfid") is not None else None,
227
- "checkAuth": obj.get("checkAuth"),
228
- "authParams": AuthParams.from_dict(obj["authParams"]) if obj.get("authParams") is not None else None,
229
- "mrzDetectMode": obj.get("mrzDetectMode"),
230
- "generateNumericCodes": obj.get("generateNumericCodes"),
231
- "strictBarcodeDigitalSignatureCheck": obj.get("strictBarcodeDigitalSignatureCheck"),
232
- "selectLongestNames": obj.get("selectLongestNames"),
233
- "doBarcodes": obj.get("doBarcodes"),
234
- "strictDLCategoryExpiry": obj.get("strictDLCategoryExpiry"),
235
- "generateAlpha2Codes": obj.get("generateAlpha2Codes"),
236
- "pdfPagesLimit": obj.get("pdfPagesLimit")
237
- })
238
- return _obj
239
26
 
27
+ """
28
+ Attributes:
29
+ openapi_types (dict): The key is attribute name
30
+ and the value is attribute type.
31
+ attribute_map (dict): The key is attribute name
32
+ and the value is json key in definition.
33
+ """
34
+ openapi_types = {
35
+ 'generate_dtcvc': 'bool',
36
+ 'lcid_filter': 'list[int]',
37
+ 'lcid_ignore_filter': 'list[int]',
38
+ 'one_shot_identification': 'bool',
39
+ 'use_face_api': 'bool',
40
+ 'face_api': 'FaceApi',
41
+ 'do_detect_can': 'bool',
42
+ 'image_output_max_height': 'int',
43
+ 'image_output_max_width': 'int',
44
+ 'scenario': 'Scenario',
45
+ 'result_type_output': 'list[Result]',
46
+ 'double_page_spread': 'bool',
47
+ 'generate_double_page_spread_image': 'bool',
48
+ 'field_types_filter': 'list[TextFieldType]',
49
+ 'date_format': 'str',
50
+ 'measure_system': 'MeasureSystem',
51
+ 'image_dpi_out_max': 'int',
52
+ 'already_cropped': 'bool',
53
+ 'custom_params': 'dict(str, object)',
54
+ 'config': 'list[PerDocumentConfig]',
55
+ 'log': 'bool',
56
+ 'log_level': 'LogLevel',
57
+ 'force_doc_id': 'int',
58
+ 'match_text_field_mask': 'bool',
59
+ 'fast_doc_detect': 'bool',
60
+ 'update_ocr_validity_by_glare': 'bool',
61
+ 'check_required_text_fields': 'bool',
62
+ 'return_cropped_barcode': 'bool',
63
+ 'image_qa': 'ImageQA',
64
+ 'strict_image_quality': 'bool',
65
+ 'respect_image_quality': 'bool',
66
+ 'force_doc_format': 'DocumentFormat',
67
+ 'no_graphics': 'bool',
68
+ 'depersonalize_log': 'bool',
69
+ 'multi_doc_on_image': 'bool',
70
+ 'shift_expiry_date': 'int',
71
+ 'minimal_holder_age': 'int',
72
+ 'return_uncropped_image': 'bool',
73
+ 'mrz_formats_filter': 'list[MRZFormat]',
74
+ 'force_read_mrz_before_locate': 'bool',
75
+ 'parse_barcodes': 'bool',
76
+ 'convert_case': 'TextPostProcessing',
77
+ 'split_names': 'bool',
78
+ 'disable_perforation_ocr': 'bool',
79
+ 'document_group_filter': 'list[DocumentType]',
80
+ 'process_auth': 'int',
81
+ 'device_id': 'int',
82
+ 'device_type': 'int',
83
+ 'device_type_hex': 'str',
84
+ 'ignore_device_id_from_image': 'bool',
85
+ 'document_id_list': 'list[int]',
86
+ 'rfid': 'ProcessParamsRfid',
87
+ 'check_auth': 'bool',
88
+ 'auth_params': 'AuthParams',
89
+ 'mrz_detect_mode': 'MrzDetectModeEnum',
90
+ 'generate_numeric_codes': 'bool',
91
+ 'strict_barcode_digital_signature_check': 'bool',
92
+ 'select_longest_names': 'bool',
93
+ 'do_barcodes': 'list[InputBarcodeType]',
94
+ 'strict_dl_category_expiry': 'bool'
95
+ }
96
+
97
+ attribute_map = {
98
+ 'generate_dtcvc': 'generateDTCVC',
99
+ 'lcid_filter': 'lcidFilter',
100
+ 'lcid_ignore_filter': 'lcidIgnoreFilter',
101
+ 'one_shot_identification': 'oneShotIdentification',
102
+ 'use_face_api': 'useFaceApi',
103
+ 'face_api': 'faceApi',
104
+ 'do_detect_can': 'doDetectCan',
105
+ 'image_output_max_height': 'imageOutputMaxHeight',
106
+ 'image_output_max_width': 'imageOutputMaxWidth',
107
+ 'scenario': 'scenario',
108
+ 'result_type_output': 'resultTypeOutput',
109
+ 'double_page_spread': 'doublePageSpread',
110
+ 'generate_double_page_spread_image': 'generateDoublePageSpreadImage',
111
+ 'field_types_filter': 'fieldTypesFilter',
112
+ 'date_format': 'dateFormat',
113
+ 'measure_system': 'measureSystem',
114
+ 'image_dpi_out_max': 'imageDpiOutMax',
115
+ 'already_cropped': 'alreadyCropped',
116
+ 'custom_params': 'customParams',
117
+ 'config': 'config',
118
+ 'log': 'log',
119
+ 'log_level': 'logLevel',
120
+ 'force_doc_id': 'forceDocID',
121
+ 'match_text_field_mask': 'matchTextFieldMask',
122
+ 'fast_doc_detect': 'fastDocDetect',
123
+ 'update_ocr_validity_by_glare': 'updateOCRValidityByGlare',
124
+ 'check_required_text_fields': 'checkRequiredTextFields',
125
+ 'return_cropped_barcode': 'returnCroppedBarcode',
126
+ 'image_qa': 'imageQa',
127
+ 'strict_image_quality': 'strictImageQuality',
128
+ 'respect_image_quality': 'respectImageQuality',
129
+ 'force_doc_format': 'forceDocFormat',
130
+ 'no_graphics': 'noGraphics',
131
+ 'depersonalize_log': 'depersonalizeLog',
132
+ 'multi_doc_on_image': 'multiDocOnImage',
133
+ 'shift_expiry_date': 'shiftExpiryDate',
134
+ 'minimal_holder_age': 'minimalHolderAge',
135
+ 'return_uncropped_image': 'returnUncroppedImage',
136
+ 'mrz_formats_filter': 'mrzFormatsFilter',
137
+ 'force_read_mrz_before_locate': 'forceReadMrzBeforeLocate',
138
+ 'parse_barcodes': 'parseBarcodes',
139
+ 'convert_case': 'convertCase',
140
+ 'split_names': 'splitNames',
141
+ 'disable_perforation_ocr': 'disablePerforationOCR',
142
+ 'document_group_filter': 'documentGroupFilter',
143
+ 'process_auth': 'processAuth',
144
+ 'device_id': 'deviceId',
145
+ 'device_type': 'deviceType',
146
+ 'device_type_hex': 'deviceTypeHex',
147
+ 'ignore_device_id_from_image': 'ignoreDeviceIdFromImage',
148
+ 'document_id_list': 'documentIdList',
149
+ 'rfid': 'rfid',
150
+ 'check_auth': 'checkAuth',
151
+ 'auth_params': 'authParams',
152
+ 'mrz_detect_mode': 'mrzDetectMode',
153
+ 'generate_numeric_codes': 'generateNumericCodes',
154
+ 'strict_barcode_digital_signature_check': 'strictBarcodeDigitalSignatureCheck',
155
+ 'select_longest_names': 'selectLongestNames',
156
+ 'do_barcodes': 'doBarcodes',
157
+ 'strict_dl_category_expiry': 'strictDLCategoryExpiry'
158
+ }
159
+
160
+ def __init__(self, generate_dtcvc=None, lcid_filter=None, lcid_ignore_filter=None, one_shot_identification=None, use_face_api=None, face_api=None, do_detect_can=None, image_output_max_height=None, image_output_max_width=None, scenario=None, result_type_output=None, double_page_spread=None, generate_double_page_spread_image=None, field_types_filter=None, date_format=None, measure_system=None, image_dpi_out_max=None, already_cropped=None, custom_params=None, config=None, log=None, log_level=None, force_doc_id=None, match_text_field_mask=None, fast_doc_detect=None, update_ocr_validity_by_glare=None, check_required_text_fields=None, return_cropped_barcode=None, image_qa=None, strict_image_quality=None, respect_image_quality=None, force_doc_format=None, no_graphics=None, depersonalize_log=None, multi_doc_on_image=None, shift_expiry_date=None, minimal_holder_age=None, return_uncropped_image=None, mrz_formats_filter=None, force_read_mrz_before_locate=None, parse_barcodes=None, convert_case=None, split_names=None, disable_perforation_ocr=None, document_group_filter=None, process_auth=None, device_id=None, device_type=None, device_type_hex=None, ignore_device_id_from_image=None, document_id_list=None, rfid=None, check_auth=None, auth_params=None, mrz_detect_mode=None, generate_numeric_codes=None, strict_barcode_digital_signature_check=None, select_longest_names=None, do_barcodes=None, strict_dl_category_expiry=None, local_vars_configuration=None): # noqa: E501
161
+ """ProcessParams - a model defined in OpenAPI""" # noqa: E501
162
+ if local_vars_configuration is None:
163
+ local_vars_configuration = Configuration()
164
+ self.local_vars_configuration = local_vars_configuration
165
+
166
+ self._generate_dtcvc = None
167
+ self._lcid_filter = None
168
+ self._lcid_ignore_filter = None
169
+ self._one_shot_identification = None
170
+ self._use_face_api = None
171
+ self._face_api = None
172
+ self._do_detect_can = None
173
+ self._image_output_max_height = None
174
+ self._image_output_max_width = None
175
+ self._scenario = None
176
+ self._result_type_output = None
177
+ self._double_page_spread = None
178
+ self._generate_double_page_spread_image = None
179
+ self._field_types_filter = None
180
+ self._date_format = None
181
+ self._measure_system = None
182
+ self._image_dpi_out_max = None
183
+ self._already_cropped = None
184
+ self._custom_params = None
185
+ self._config = None
186
+ self._log = None
187
+ self._log_level = None
188
+ self._force_doc_id = None
189
+ self._match_text_field_mask = None
190
+ self._fast_doc_detect = None
191
+ self._update_ocr_validity_by_glare = None
192
+ self._check_required_text_fields = None
193
+ self._return_cropped_barcode = None
194
+ self._image_qa = None
195
+ self._strict_image_quality = None
196
+ self._respect_image_quality = None
197
+ self._force_doc_format = None
198
+ self._no_graphics = None
199
+ self._depersonalize_log = None
200
+ self._multi_doc_on_image = None
201
+ self._shift_expiry_date = None
202
+ self._minimal_holder_age = None
203
+ self._return_uncropped_image = None
204
+ self._mrz_formats_filter = None
205
+ self._force_read_mrz_before_locate = None
206
+ self._parse_barcodes = None
207
+ self._convert_case = None
208
+ self._split_names = None
209
+ self._disable_perforation_ocr = None
210
+ self._document_group_filter = None
211
+ self._process_auth = None
212
+ self._device_id = None
213
+ self._device_type = None
214
+ self._device_type_hex = None
215
+ self._ignore_device_id_from_image = None
216
+ self._document_id_list = None
217
+ self._rfid = None
218
+ self._check_auth = None
219
+ self._auth_params = None
220
+ self._mrz_detect_mode = None
221
+ self._generate_numeric_codes = None
222
+ self._strict_barcode_digital_signature_check = None
223
+ self._select_longest_names = None
224
+ self._do_barcodes = None
225
+ self._strict_dl_category_expiry = None
226
+ self.discriminator = None
227
+
228
+ if generate_dtcvc is not None:
229
+ self.generate_dtcvc = generate_dtcvc
230
+ if lcid_filter is not None:
231
+ self.lcid_filter = lcid_filter
232
+ if lcid_ignore_filter is not None:
233
+ self.lcid_ignore_filter = lcid_ignore_filter
234
+ if one_shot_identification is not None:
235
+ self.one_shot_identification = one_shot_identification
236
+ if use_face_api is not None:
237
+ self.use_face_api = use_face_api
238
+ if face_api is not None:
239
+ self.face_api = face_api
240
+ if do_detect_can is not None:
241
+ self.do_detect_can = do_detect_can
242
+ if image_output_max_height is not None:
243
+ self.image_output_max_height = image_output_max_height
244
+ if image_output_max_width is not None:
245
+ self.image_output_max_width = image_output_max_width
246
+ self.scenario = scenario
247
+ if result_type_output is not None:
248
+ self.result_type_output = result_type_output
249
+ if double_page_spread is not None:
250
+ self.double_page_spread = double_page_spread
251
+ if generate_double_page_spread_image is not None:
252
+ self.generate_double_page_spread_image = generate_double_page_spread_image
253
+ if field_types_filter is not None:
254
+ self.field_types_filter = field_types_filter
255
+ if date_format is not None:
256
+ self.date_format = date_format
257
+ if measure_system is not None:
258
+ self.measure_system = measure_system
259
+ if image_dpi_out_max is not None:
260
+ self.image_dpi_out_max = image_dpi_out_max
261
+ if already_cropped is not None:
262
+ self.already_cropped = already_cropped
263
+ if custom_params is not None:
264
+ self.custom_params = custom_params
265
+ if config is not None:
266
+ self.config = config
267
+ if log is not None:
268
+ self.log = log
269
+ if log_level is not None:
270
+ self.log_level = log_level
271
+ if force_doc_id is not None:
272
+ self.force_doc_id = force_doc_id
273
+ if match_text_field_mask is not None:
274
+ self.match_text_field_mask = match_text_field_mask
275
+ if fast_doc_detect is not None:
276
+ self.fast_doc_detect = fast_doc_detect
277
+ if update_ocr_validity_by_glare is not None:
278
+ self.update_ocr_validity_by_glare = update_ocr_validity_by_glare
279
+ if check_required_text_fields is not None:
280
+ self.check_required_text_fields = check_required_text_fields
281
+ if return_cropped_barcode is not None:
282
+ self.return_cropped_barcode = return_cropped_barcode
283
+ if image_qa is not None:
284
+ self.image_qa = image_qa
285
+ if strict_image_quality is not None:
286
+ self.strict_image_quality = strict_image_quality
287
+ if respect_image_quality is not None:
288
+ self.respect_image_quality = respect_image_quality
289
+ if force_doc_format is not None:
290
+ self.force_doc_format = force_doc_format
291
+ if no_graphics is not None:
292
+ self.no_graphics = no_graphics
293
+ if depersonalize_log is not None:
294
+ self.depersonalize_log = depersonalize_log
295
+ if multi_doc_on_image is not None:
296
+ self.multi_doc_on_image = multi_doc_on_image
297
+ if shift_expiry_date is not None:
298
+ self.shift_expiry_date = shift_expiry_date
299
+ if minimal_holder_age is not None:
300
+ self.minimal_holder_age = minimal_holder_age
301
+ if return_uncropped_image is not None:
302
+ self.return_uncropped_image = return_uncropped_image
303
+ if mrz_formats_filter is not None:
304
+ self.mrz_formats_filter = mrz_formats_filter
305
+ if force_read_mrz_before_locate is not None:
306
+ self.force_read_mrz_before_locate = force_read_mrz_before_locate
307
+ if parse_barcodes is not None:
308
+ self.parse_barcodes = parse_barcodes
309
+ if convert_case is not None:
310
+ self.convert_case = convert_case
311
+ if split_names is not None:
312
+ self.split_names = split_names
313
+ if disable_perforation_ocr is not None:
314
+ self.disable_perforation_ocr = disable_perforation_ocr
315
+ if document_group_filter is not None:
316
+ self.document_group_filter = document_group_filter
317
+ if process_auth is not None:
318
+ self.process_auth = process_auth
319
+ if device_id is not None:
320
+ self.device_id = device_id
321
+ if device_type is not None:
322
+ self.device_type = device_type
323
+ if device_type_hex is not None:
324
+ self.device_type_hex = device_type_hex
325
+ if ignore_device_id_from_image is not None:
326
+ self.ignore_device_id_from_image = ignore_device_id_from_image
327
+ if document_id_list is not None:
328
+ self.document_id_list = document_id_list
329
+ if rfid is not None:
330
+ self.rfid = rfid
331
+ if check_auth is not None:
332
+ self.check_auth = check_auth
333
+ if auth_params is not None:
334
+ self.auth_params = auth_params
335
+ if mrz_detect_mode is not None:
336
+ self.mrz_detect_mode = mrz_detect_mode
337
+ if generate_numeric_codes is not None:
338
+ self.generate_numeric_codes = generate_numeric_codes
339
+ if strict_barcode_digital_signature_check is not None:
340
+ self.strict_barcode_digital_signature_check = strict_barcode_digital_signature_check
341
+ if select_longest_names is not None:
342
+ self.select_longest_names = select_longest_names
343
+ if do_barcodes is not None:
344
+ self.do_barcodes = do_barcodes
345
+ if strict_dl_category_expiry is not None:
346
+ self.strict_dl_category_expiry = strict_dl_category_expiry
347
+
348
+ @property
349
+ def generate_dtcvc(self):
350
+ """Gets the generate_dtcvc of this ProcessParams. # noqa: E501
351
+
352
+ This parameter is used to generate separate DTC-VC data container from RFID session data. # noqa: E501
353
+
354
+ :return: The generate_dtcvc of this ProcessParams. # noqa: E501
355
+ :rtype: bool
356
+ """
357
+ return self._generate_dtcvc
358
+
359
+ @generate_dtcvc.setter
360
+ def generate_dtcvc(self, generate_dtcvc):
361
+ """Sets the generate_dtcvc of this ProcessParams.
362
+
363
+ This parameter is used to generate separate DTC-VC data container from RFID session data. # noqa: E501
364
+
365
+ :param generate_dtcvc: The generate_dtcvc of this ProcessParams. # noqa: E501
366
+ :type generate_dtcvc: bool
367
+ """
368
+
369
+ self._generate_dtcvc = generate_dtcvc
370
+
371
+ @property
372
+ def lcid_filter(self):
373
+ """Gets the lcid_filter of this ProcessParams. # noqa: E501
374
+
375
+ The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default. # noqa: E501
376
+
377
+ :return: The lcid_filter of this ProcessParams. # noqa: E501
378
+ :rtype: list[int]
379
+ """
380
+ return self._lcid_filter
381
+
382
+ @lcid_filter.setter
383
+ def lcid_filter(self, lcid_filter):
384
+ """Sets the lcid_filter of this ProcessParams.
385
+
386
+ The list of LCID types to recognize. If empty, values with all LCID types will be extracted. Empty by default. # noqa: E501
387
+
388
+ :param lcid_filter: The lcid_filter of this ProcessParams. # noqa: E501
389
+ :type lcid_filter: list[int]
390
+ """
391
+
392
+ self._lcid_filter = lcid_filter
393
+
394
+ @property
395
+ def lcid_ignore_filter(self):
396
+ """Gets the lcid_ignore_filter of this ProcessParams. # noqa: E501
397
+
398
+ The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default. # noqa: E501
399
+
400
+ :return: The lcid_ignore_filter of this ProcessParams. # noqa: E501
401
+ :rtype: list[int]
402
+ """
403
+ return self._lcid_ignore_filter
404
+
405
+ @lcid_ignore_filter.setter
406
+ def lcid_ignore_filter(self, lcid_ignore_filter):
407
+ """Sets the lcid_ignore_filter of this ProcessParams.
408
+
409
+ The list of LCID types to ignore during the recognition. If empty, values with all LCID types will be extracted. Narrowing down the list can reduce processing time. Empty by default. # noqa: E501
410
+
411
+ :param lcid_ignore_filter: The lcid_ignore_filter of this ProcessParams. # noqa: E501
412
+ :type lcid_ignore_filter: list[int]
413
+ """
414
+
415
+ self._lcid_ignore_filter = lcid_ignore_filter
416
+
417
+ @property
418
+ def one_shot_identification(self):
419
+ """Gets the one_shot_identification of this ProcessParams. # noqa: E501
420
+
421
+ 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 # noqa: E501
422
+
423
+ :return: The one_shot_identification of this ProcessParams. # noqa: E501
424
+ :rtype: bool
425
+ """
426
+ return self._one_shot_identification
427
+
428
+ @one_shot_identification.setter
429
+ def one_shot_identification(self, one_shot_identification):
430
+ """Sets the one_shot_identification of this ProcessParams.
431
+
432
+ 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 # noqa: E501
433
+
434
+ :param one_shot_identification: The one_shot_identification of this ProcessParams. # noqa: E501
435
+ :type one_shot_identification: bool
436
+ """
437
+
438
+ self._one_shot_identification = one_shot_identification
439
+
440
+ @property
441
+ def use_face_api(self):
442
+ """Gets the use_face_api of this ProcessParams. # noqa: E501
443
+
444
+ This parameter allows comparing faces on Regula Face Web Service # noqa: E501
445
+
446
+ :return: The use_face_api of this ProcessParams. # noqa: E501
447
+ :rtype: bool
448
+ """
449
+ return self._use_face_api
450
+
451
+ @use_face_api.setter
452
+ def use_face_api(self, use_face_api):
453
+ """Sets the use_face_api of this ProcessParams.
454
+
455
+ This parameter allows comparing faces on Regula Face Web Service # noqa: E501
456
+
457
+ :param use_face_api: The use_face_api of this ProcessParams. # noqa: E501
458
+ :type use_face_api: bool
459
+ """
460
+
461
+ self._use_face_api = use_face_api
462
+
463
+ @property
464
+ def face_api(self):
465
+ """Gets the face_api of this ProcessParams. # noqa: E501
466
+
467
+
468
+ :return: The face_api of this ProcessParams. # noqa: E501
469
+ :rtype: FaceApi
470
+ """
471
+ return self._face_api
472
+
473
+ @face_api.setter
474
+ def face_api(self, face_api):
475
+ """Sets the face_api of this ProcessParams.
476
+
477
+
478
+ :param face_api: The face_api of this ProcessParams. # noqa: E501
479
+ :type face_api: FaceApi
480
+ """
481
+
482
+ self._face_api = face_api
483
+
484
+ @property
485
+ def do_detect_can(self):
486
+ """Gets the do_detect_can of this ProcessParams. # noqa: E501
487
+
488
+ 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. # noqa: E501
489
+
490
+ :return: The do_detect_can of this ProcessParams. # noqa: E501
491
+ :rtype: bool
492
+ """
493
+ return self._do_detect_can
494
+
495
+ @do_detect_can.setter
496
+ def do_detect_can(self, do_detect_can):
497
+ """Sets the do_detect_can of this ProcessParams.
498
+
499
+ 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. # noqa: E501
500
+
501
+ :param do_detect_can: The do_detect_can of this ProcessParams. # noqa: E501
502
+ :type do_detect_can: bool
503
+ """
504
+
505
+ self._do_detect_can = do_detect_can
506
+
507
+ @property
508
+ def image_output_max_height(self):
509
+ """Gets the image_output_max_height of this ProcessParams. # noqa: E501
510
+
511
+ 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. # noqa: E501
512
+
513
+ :return: The image_output_max_height of this ProcessParams. # noqa: E501
514
+ :rtype: int
515
+ """
516
+ return self._image_output_max_height
517
+
518
+ @image_output_max_height.setter
519
+ def image_output_max_height(self, image_output_max_height):
520
+ """Sets the image_output_max_height of this ProcessParams.
521
+
522
+ 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. # noqa: E501
523
+
524
+ :param image_output_max_height: The image_output_max_height of this ProcessParams. # noqa: E501
525
+ :type image_output_max_height: int
526
+ """
527
+
528
+ self._image_output_max_height = image_output_max_height
529
+
530
+ @property
531
+ def image_output_max_width(self):
532
+ """Gets the image_output_max_width of this ProcessParams. # noqa: E501
533
+
534
+ 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. # noqa: E501
535
+
536
+ :return: The image_output_max_width of this ProcessParams. # noqa: E501
537
+ :rtype: int
538
+ """
539
+ return self._image_output_max_width
540
+
541
+ @image_output_max_width.setter
542
+ def image_output_max_width(self, image_output_max_width):
543
+ """Sets the image_output_max_width of this ProcessParams.
544
+
545
+ 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. # noqa: E501
546
+
547
+ :param image_output_max_width: The image_output_max_width of this ProcessParams. # noqa: E501
548
+ :type image_output_max_width: int
549
+ """
550
+
551
+ self._image_output_max_width = image_output_max_width
552
+
553
+ @property
554
+ def scenario(self):
555
+ """Gets the scenario of this ProcessParams. # noqa: E501
556
+
557
+
558
+ :return: The scenario of this ProcessParams. # noqa: E501
559
+ :rtype: Scenario
560
+ """
561
+ return self._scenario
562
+
563
+ @scenario.setter
564
+ def scenario(self, scenario):
565
+ """Sets the scenario of this ProcessParams.
566
+
567
+
568
+ :param scenario: The scenario of this ProcessParams. # noqa: E501
569
+ :type scenario: Scenario
570
+ """
571
+ if self.local_vars_configuration.client_side_validation and scenario is None: # noqa: E501
572
+ raise ValueError("Invalid value for `scenario`, must not be `None`") # noqa: E501
573
+
574
+ self._scenario = scenario
575
+
576
+ @property
577
+ def result_type_output(self):
578
+ """Gets the result_type_output of this ProcessParams. # noqa: E501
579
+
580
+ Types of results to return in response. See 'Result' enum for available options # noqa: E501
581
+
582
+ :return: The result_type_output of this ProcessParams. # noqa: E501
583
+ :rtype: list[Result]
584
+ """
585
+ return self._result_type_output
586
+
587
+ @result_type_output.setter
588
+ def result_type_output(self, result_type_output):
589
+ """Sets the result_type_output of this ProcessParams.
590
+
591
+ Types of results to return in response. See 'Result' enum for available options # noqa: E501
592
+
593
+ :param result_type_output: The result_type_output of this ProcessParams. # noqa: E501
594
+ :type result_type_output: list[Result]
595
+ """
596
+
597
+ self._result_type_output = result_type_output
598
+
599
+ @property
600
+ def double_page_spread(self):
601
+ """Gets the double_page_spread of this ProcessParams. # noqa: E501
602
+
603
+ 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. # noqa: E501
604
+
605
+ :return: The double_page_spread of this ProcessParams. # noqa: E501
606
+ :rtype: bool
607
+ """
608
+ return self._double_page_spread
609
+
610
+ @double_page_spread.setter
611
+ def double_page_spread(self, double_page_spread):
612
+ """Sets the double_page_spread of this ProcessParams.
613
+
614
+ 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. # noqa: E501
615
+
616
+ :param double_page_spread: The double_page_spread of this ProcessParams. # noqa: E501
617
+ :type double_page_spread: bool
618
+ """
619
+
620
+ self._double_page_spread = double_page_spread
621
+
622
+ @property
623
+ def generate_double_page_spread_image(self):
624
+ """Gets the generate_double_page_spread_image of this ProcessParams. # noqa: E501
625
+
626
+ 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. # noqa: E501
627
+
628
+ :return: The generate_double_page_spread_image of this ProcessParams. # noqa: E501
629
+ :rtype: bool
630
+ """
631
+ return self._generate_double_page_spread_image
632
+
633
+ @generate_double_page_spread_image.setter
634
+ def generate_double_page_spread_image(self, generate_double_page_spread_image):
635
+ """Sets the generate_double_page_spread_image of this ProcessParams.
636
+
637
+ 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. # noqa: E501
638
+
639
+ :param generate_double_page_spread_image: The generate_double_page_spread_image of this ProcessParams. # noqa: E501
640
+ :type generate_double_page_spread_image: bool
641
+ """
642
+
643
+ self._generate_double_page_spread_image = generate_double_page_spread_image
644
+
645
+ @property
646
+ def field_types_filter(self):
647
+ """Gets the field_types_filter of this ProcessParams. # noqa: E501
648
+
649
+ 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. # noqa: E501
650
+
651
+ :return: The field_types_filter of this ProcessParams. # noqa: E501
652
+ :rtype: list[TextFieldType]
653
+ """
654
+ return self._field_types_filter
655
+
656
+ @field_types_filter.setter
657
+ def field_types_filter(self, field_types_filter):
658
+ """Sets the field_types_filter of this ProcessParams.
659
+
660
+ 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. # noqa: E501
661
+
662
+ :param field_types_filter: The field_types_filter of this ProcessParams. # noqa: E501
663
+ :type field_types_filter: list[TextFieldType]
664
+ """
665
+
666
+ self._field_types_filter = field_types_filter
667
+
668
+ @property
669
+ def date_format(self):
670
+ """Gets the date_format of this ProcessParams. # noqa: E501
671
+
672
+ This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running). # noqa: E501
673
+
674
+ :return: The date_format of this ProcessParams. # noqa: E501
675
+ :rtype: str
676
+ """
677
+ return self._date_format
678
+
679
+ @date_format.setter
680
+ def date_format(self, date_format):
681
+ """Sets the date_format of this ProcessParams.
682
+
683
+ This option allows you to set dates format so that solution will return dates in this format. For example, if you supply 'MM/dd/yyyy', and document have printed date '09 JUL 2020' for the date os issue, you will get '07/09/2020' as a result. By default it is set to system locale default (where the service is running). # noqa: E501
684
+
685
+ :param date_format: The date_format of this ProcessParams. # noqa: E501
686
+ :type date_format: str
687
+ """
688
+
689
+ self._date_format = date_format
690
+
691
+ @property
692
+ def measure_system(self):
693
+ """Gets the measure_system of this ProcessParams. # noqa: E501
694
+
695
+
696
+ :return: The measure_system of this ProcessParams. # noqa: E501
697
+ :rtype: MeasureSystem
698
+ """
699
+ return self._measure_system
700
+
701
+ @measure_system.setter
702
+ def measure_system(self, measure_system):
703
+ """Sets the measure_system of this ProcessParams.
704
+
705
+
706
+ :param measure_system: The measure_system of this ProcessParams. # noqa: E501
707
+ :type measure_system: MeasureSystem
708
+ """
709
+
710
+ self._measure_system = measure_system
711
+
712
+ @property
713
+ def image_dpi_out_max(self):
714
+ """Gets the image_dpi_out_max of this ProcessParams. # noqa: E501
715
+
716
+ 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. # noqa: E501
717
+
718
+ :return: The image_dpi_out_max of this ProcessParams. # noqa: E501
719
+ :rtype: int
720
+ """
721
+ return self._image_dpi_out_max
722
+
723
+ @image_dpi_out_max.setter
724
+ def image_dpi_out_max(self, image_dpi_out_max):
725
+ """Sets the image_dpi_out_max of this ProcessParams.
726
+
727
+ 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. # noqa: E501
728
+
729
+ :param image_dpi_out_max: The image_dpi_out_max of this ProcessParams. # noqa: E501
730
+ :type image_dpi_out_max: int
731
+ """
732
+
733
+ self._image_dpi_out_max = image_dpi_out_max
734
+
735
+ @property
736
+ def already_cropped(self):
737
+ """Gets the already_cropped of this ProcessParams. # noqa: E501
738
+
739
+ 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. # noqa: E501
740
+
741
+ :return: The already_cropped of this ProcessParams. # noqa: E501
742
+ :rtype: bool
743
+ """
744
+ return self._already_cropped
745
+
746
+ @already_cropped.setter
747
+ def already_cropped(self, already_cropped):
748
+ """Sets the already_cropped of this ProcessParams.
749
+
750
+ 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. # noqa: E501
751
+
752
+ :param already_cropped: The already_cropped of this ProcessParams. # noqa: E501
753
+ :type already_cropped: bool
754
+ """
755
+
756
+ self._already_cropped = already_cropped
757
+
758
+ @property
759
+ def custom_params(self):
760
+ """Gets the custom_params of this ProcessParams. # noqa: E501
761
+
762
+ This option allows passing custom processing parameters that can be implemented in future without changing API. # noqa: E501
763
+
764
+ :return: The custom_params of this ProcessParams. # noqa: E501
765
+ :rtype: dict(str, object)
766
+ """
767
+ return self._custom_params
768
+
769
+ @custom_params.setter
770
+ def custom_params(self, custom_params):
771
+ """Sets the custom_params of this ProcessParams.
772
+
773
+ This option allows passing custom processing parameters that can be implemented in future without changing API. # noqa: E501
774
+
775
+ :param custom_params: The custom_params of this ProcessParams. # noqa: E501
776
+ :type custom_params: dict(str, object)
777
+ """
778
+
779
+ self._custom_params = custom_params
780
+
781
+ @property
782
+ def config(self):
783
+ """Gets the config of this ProcessParams. # noqa: E501
784
+
785
+ This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration. # noqa: E501
786
+
787
+ :return: The config of this ProcessParams. # noqa: E501
788
+ :rtype: list[PerDocumentConfig]
789
+ """
790
+ return self._config
791
+
792
+ @config.setter
793
+ def config(self, config):
794
+ """Sets the config of this ProcessParams.
795
+
796
+ This option allows setting additional custom configuration per document type. If recognized document has ID specified in config, processing adjusts according to designated configuration. # noqa: E501
797
+
798
+ :param config: The config of this ProcessParams. # noqa: E501
799
+ :type config: list[PerDocumentConfig]
800
+ """
801
+
802
+ self._config = config
803
+
804
+ @property
805
+ def log(self):
806
+ """Gets the log of this ProcessParams. # noqa: E501
807
+
808
+ When enabled, results will contain transaction processing log. Disabled by default # noqa: E501
809
+
810
+ :return: The log of this ProcessParams. # noqa: E501
811
+ :rtype: bool
812
+ """
813
+ return self._log
814
+
815
+ @log.setter
816
+ def log(self, log):
817
+ """Sets the log of this ProcessParams.
818
+
819
+ When enabled, results will contain transaction processing log. Disabled by default # noqa: E501
820
+
821
+ :param log: The log of this ProcessParams. # noqa: E501
822
+ :type log: bool
823
+ """
824
+
825
+ self._log = log
826
+
827
+ @property
828
+ def log_level(self):
829
+ """Gets the log_level of this ProcessParams. # noqa: E501
830
+
831
+
832
+ :return: The log_level of this ProcessParams. # noqa: E501
833
+ :rtype: LogLevel
834
+ """
835
+ return self._log_level
836
+
837
+ @log_level.setter
838
+ def log_level(self, log_level):
839
+ """Sets the log_level of this ProcessParams.
840
+
841
+
842
+ :param log_level: The log_level of this ProcessParams. # noqa: E501
843
+ :type log_level: LogLevel
844
+ """
845
+
846
+ self._log_level = log_level
847
+
848
+ @property
849
+ def force_doc_id(self):
850
+ """Gets the force_doc_id of this ProcessParams. # noqa: E501
851
+
852
+ Force use of specific template ID and skip document type identification step. # noqa: E501
853
+
854
+ :return: The force_doc_id of this ProcessParams. # noqa: E501
855
+ :rtype: int
856
+ """
857
+ return self._force_doc_id
858
+
859
+ @force_doc_id.setter
860
+ def force_doc_id(self, force_doc_id):
861
+ """Sets the force_doc_id of this ProcessParams.
862
+
863
+ Force use of specific template ID and skip document type identification step. # noqa: E501
864
+
865
+ :param force_doc_id: The force_doc_id of this ProcessParams. # noqa: E501
866
+ :type force_doc_id: int
867
+ """
868
+
869
+ self._force_doc_id = force_doc_id
870
+
871
+ @property
872
+ def match_text_field_mask(self):
873
+ """Gets the match_text_field_mask of this ProcessParams. # noqa: E501
874
+
875
+ 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. # noqa: E501
876
+
877
+ :return: The match_text_field_mask of this ProcessParams. # noqa: E501
878
+ :rtype: bool
879
+ """
880
+ return self._match_text_field_mask
881
+
882
+ @match_text_field_mask.setter
883
+ def match_text_field_mask(self, match_text_field_mask):
884
+ """Sets the match_text_field_mask of this ProcessParams.
885
+
886
+ 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. # noqa: E501
887
+
888
+ :param match_text_field_mask: The match_text_field_mask of this ProcessParams. # noqa: E501
889
+ :type match_text_field_mask: bool
890
+ """
891
+
892
+ self._match_text_field_mask = match_text_field_mask
893
+
894
+ @property
895
+ def fast_doc_detect(self):
896
+ """Gets the fast_doc_detect of this ProcessParams. # noqa: E501
897
+
898
+ 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. # noqa: E501
899
+
900
+ :return: The fast_doc_detect of this ProcessParams. # noqa: E501
901
+ :rtype: bool
902
+ """
903
+ return self._fast_doc_detect
904
+
905
+ @fast_doc_detect.setter
906
+ def fast_doc_detect(self, fast_doc_detect):
907
+ """Sets the fast_doc_detect of this ProcessParams.
908
+
909
+ 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. # noqa: E501
910
+
911
+ :param fast_doc_detect: The fast_doc_detect of this ProcessParams. # noqa: E501
912
+ :type fast_doc_detect: bool
913
+ """
914
+
915
+ self._fast_doc_detect = fast_doc_detect
916
+
917
+ @property
918
+ def update_ocr_validity_by_glare(self):
919
+ """Gets the update_ocr_validity_by_glare of this ProcessParams. # noqa: E501
920
+
921
+ When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default. # noqa: E501
922
+
923
+ :return: The update_ocr_validity_by_glare of this ProcessParams. # noqa: E501
924
+ :rtype: bool
925
+ """
926
+ return self._update_ocr_validity_by_glare
927
+
928
+ @update_ocr_validity_by_glare.setter
929
+ def update_ocr_validity_by_glare(self, update_ocr_validity_by_glare):
930
+ """Sets the update_ocr_validity_by_glare of this ProcessParams.
931
+
932
+ When enabled, fail OCR field validity, if there is a glare over the text field on the image. Disabled by default. # noqa: E501
933
+
934
+ :param update_ocr_validity_by_glare: The update_ocr_validity_by_glare of this ProcessParams. # noqa: E501
935
+ :type update_ocr_validity_by_glare: bool
936
+ """
937
+
938
+ self._update_ocr_validity_by_glare = update_ocr_validity_by_glare
939
+
940
+ @property
941
+ def check_required_text_fields(self):
942
+ """Gets the check_required_text_fields of this ProcessParams. # noqa: E501
943
+
944
+ 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. # noqa: E501
945
+
946
+ :return: The check_required_text_fields of this ProcessParams. # noqa: E501
947
+ :rtype: bool
948
+ """
949
+ return self._check_required_text_fields
950
+
951
+ @check_required_text_fields.setter
952
+ def check_required_text_fields(self, check_required_text_fields):
953
+ """Sets the check_required_text_fields of this ProcessParams.
954
+
955
+ 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. # noqa: E501
956
+
957
+ :param check_required_text_fields: The check_required_text_fields of this ProcessParams. # noqa: E501
958
+ :type check_required_text_fields: bool
959
+ """
960
+
961
+ self._check_required_text_fields = check_required_text_fields
962
+
963
+ @property
964
+ def return_cropped_barcode(self):
965
+ """Gets the return_cropped_barcode of this ProcessParams. # noqa: E501
966
+
967
+ When enabled, returns cropped barcode images for unknown documents. Disabled by default. # noqa: E501
968
+
969
+ :return: The return_cropped_barcode of this ProcessParams. # noqa: E501
970
+ :rtype: bool
971
+ """
972
+ return self._return_cropped_barcode
973
+
974
+ @return_cropped_barcode.setter
975
+ def return_cropped_barcode(self, return_cropped_barcode):
976
+ """Sets the return_cropped_barcode of this ProcessParams.
977
+
978
+ When enabled, returns cropped barcode images for unknown documents. Disabled by default. # noqa: E501
979
+
980
+ :param return_cropped_barcode: The return_cropped_barcode of this ProcessParams. # noqa: E501
981
+ :type return_cropped_barcode: bool
982
+ """
983
+
984
+ self._return_cropped_barcode = return_cropped_barcode
985
+
986
+ @property
987
+ def image_qa(self):
988
+ """Gets the image_qa of this ProcessParams. # noqa: E501
989
+
990
+
991
+ :return: The image_qa of this ProcessParams. # noqa: E501
992
+ :rtype: ImageQA
993
+ """
994
+ return self._image_qa
995
+
996
+ @image_qa.setter
997
+ def image_qa(self, image_qa):
998
+ """Sets the image_qa of this ProcessParams.
999
+
1000
+
1001
+ :param image_qa: The image_qa of this ProcessParams. # noqa: E501
1002
+ :type image_qa: ImageQA
1003
+ """
1004
+
1005
+ self._image_qa = image_qa
1006
+
1007
+ @property
1008
+ def strict_image_quality(self):
1009
+ """Gets the strict_image_quality of this ProcessParams. # noqa: E501
1010
+
1011
+ When enabled, the image quality check status affects the document optical and overall status. Disabled by default. # noqa: E501
1012
+
1013
+ :return: The strict_image_quality of this ProcessParams. # noqa: E501
1014
+ :rtype: bool
1015
+ """
1016
+ return self._strict_image_quality
1017
+
1018
+ @strict_image_quality.setter
1019
+ def strict_image_quality(self, strict_image_quality):
1020
+ """Sets the strict_image_quality of this ProcessParams.
1021
+
1022
+ When enabled, the image quality check status affects the document optical and overall status. Disabled by default. # noqa: E501
1023
+
1024
+ :param strict_image_quality: The strict_image_quality of this ProcessParams. # noqa: E501
1025
+ :type strict_image_quality: bool
1026
+ """
1027
+
1028
+ self._strict_image_quality = strict_image_quality
1029
+
1030
+ @property
1031
+ def respect_image_quality(self):
1032
+ """Gets the respect_image_quality of this ProcessParams. # noqa: E501
1033
+
1034
+ Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default. # noqa: E501
1035
+
1036
+ :return: The respect_image_quality of this ProcessParams. # noqa: E501
1037
+ :rtype: bool
1038
+ """
1039
+ return self._respect_image_quality
1040
+
1041
+ @respect_image_quality.setter
1042
+ def respect_image_quality(self, respect_image_quality):
1043
+ """Sets the respect_image_quality of this ProcessParams.
1044
+
1045
+ Deprecated. Please use strictImageQuality instead. When enabled, image quality checks status affects document optical and overall status. Disabled by default. # noqa: E501
1046
+
1047
+ :param respect_image_quality: The respect_image_quality of this ProcessParams. # noqa: E501
1048
+ :type respect_image_quality: bool
1049
+ """
1050
+
1051
+ self._respect_image_quality = respect_image_quality
1052
+
1053
+ @property
1054
+ def force_doc_format(self):
1055
+ """Gets the force_doc_format of this ProcessParams. # noqa: E501
1056
+
1057
+
1058
+ :return: The force_doc_format of this ProcessParams. # noqa: E501
1059
+ :rtype: DocumentFormat
1060
+ """
1061
+ return self._force_doc_format
1062
+
1063
+ @force_doc_format.setter
1064
+ def force_doc_format(self, force_doc_format):
1065
+ """Sets the force_doc_format of this ProcessParams.
1066
+
1067
+
1068
+ :param force_doc_format: The force_doc_format of this ProcessParams. # noqa: E501
1069
+ :type force_doc_format: DocumentFormat
1070
+ """
1071
+
1072
+ self._force_doc_format = force_doc_format
1073
+
1074
+ @property
1075
+ def no_graphics(self):
1076
+ """Gets the no_graphics of this ProcessParams. # noqa: E501
1077
+
1078
+ When enabled, no graphic fields will be cropped from document image. Disabled by default. # noqa: E501
1079
+
1080
+ :return: The no_graphics of this ProcessParams. # noqa: E501
1081
+ :rtype: bool
1082
+ """
1083
+ return self._no_graphics
1084
+
1085
+ @no_graphics.setter
1086
+ def no_graphics(self, no_graphics):
1087
+ """Sets the no_graphics of this ProcessParams.
1088
+
1089
+ When enabled, no graphic fields will be cropped from document image. Disabled by default. # noqa: E501
1090
+
1091
+ :param no_graphics: The no_graphics of this ProcessParams. # noqa: E501
1092
+ :type no_graphics: bool
1093
+ """
1094
+
1095
+ self._no_graphics = no_graphics
1096
+
1097
+ @property
1098
+ def depersonalize_log(self):
1099
+ """Gets the depersonalize_log of this ProcessParams. # noqa: E501
1100
+
1101
+ When enabled, all personal data will be forcibly removed from the logs. Disabled by default. # noqa: E501
1102
+
1103
+ :return: The depersonalize_log of this ProcessParams. # noqa: E501
1104
+ :rtype: bool
1105
+ """
1106
+ return self._depersonalize_log
1107
+
1108
+ @depersonalize_log.setter
1109
+ def depersonalize_log(self, depersonalize_log):
1110
+ """Sets the depersonalize_log of this ProcessParams.
1111
+
1112
+ When enabled, all personal data will be forcibly removed from the logs. Disabled by default. # noqa: E501
1113
+
1114
+ :param depersonalize_log: The depersonalize_log of this ProcessParams. # noqa: E501
1115
+ :type depersonalize_log: bool
1116
+ """
1117
+
1118
+ self._depersonalize_log = depersonalize_log
1119
+
1120
+ @property
1121
+ def multi_doc_on_image(self):
1122
+ """Gets the multi_doc_on_image of this ProcessParams. # noqa: E501
1123
+
1124
+ This option allows locating and cropping multiple documents from one image if enabled. Disabled by default. # noqa: E501
1125
+
1126
+ :return: The multi_doc_on_image of this ProcessParams. # noqa: E501
1127
+ :rtype: bool
1128
+ """
1129
+ return self._multi_doc_on_image
1130
+
1131
+ @multi_doc_on_image.setter
1132
+ def multi_doc_on_image(self, multi_doc_on_image):
1133
+ """Sets the multi_doc_on_image of this ProcessParams.
1134
+
1135
+ This option allows locating and cropping multiple documents from one image if enabled. Disabled by default. # noqa: E501
1136
+
1137
+ :param multi_doc_on_image: The multi_doc_on_image of this ProcessParams. # noqa: E501
1138
+ :type multi_doc_on_image: bool
1139
+ """
1140
+
1141
+ self._multi_doc_on_image = multi_doc_on_image
1142
+
1143
+ @property
1144
+ def shift_expiry_date(self):
1145
+ """Gets the shift_expiry_date of this ProcessParams. # noqa: E501
1146
+
1147
+ 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 # noqa: E501
1148
+
1149
+ :return: The shift_expiry_date of this ProcessParams. # noqa: E501
1150
+ :rtype: int
1151
+ """
1152
+ return self._shift_expiry_date
1153
+
1154
+ @shift_expiry_date.setter
1155
+ def shift_expiry_date(self, shift_expiry_date):
1156
+ """Sets the shift_expiry_date of this ProcessParams.
1157
+
1158
+ 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 # noqa: E501
1159
+
1160
+ :param shift_expiry_date: The shift_expiry_date of this ProcessParams. # noqa: E501
1161
+ :type shift_expiry_date: int
1162
+ """
1163
+
1164
+ self._shift_expiry_date = shift_expiry_date
1165
+
1166
+ @property
1167
+ def minimal_holder_age(self):
1168
+ """Gets the minimal_holder_age of this ProcessParams. # noqa: E501
1169
+
1170
+ This options allows specifying the minimal age in years of the document holder for the document to be considered valid. # noqa: E501
1171
+
1172
+ :return: The minimal_holder_age of this ProcessParams. # noqa: E501
1173
+ :rtype: int
1174
+ """
1175
+ return self._minimal_holder_age
1176
+
1177
+ @minimal_holder_age.setter
1178
+ def minimal_holder_age(self, minimal_holder_age):
1179
+ """Sets the minimal_holder_age of this ProcessParams.
1180
+
1181
+ This options allows specifying the minimal age in years of the document holder for the document to be considered valid. # noqa: E501
1182
+
1183
+ :param minimal_holder_age: The minimal_holder_age of this ProcessParams. # noqa: E501
1184
+ :type minimal_holder_age: int
1185
+ """
1186
+
1187
+ self._minimal_holder_age = minimal_holder_age
1188
+
1189
+ @property
1190
+ def return_uncropped_image(self):
1191
+ """Gets the return_uncropped_image of this ProcessParams. # noqa: E501
1192
+
1193
+ When enabled, returns input images in output. Disabled by default. # noqa: E501
1194
+
1195
+ :return: The return_uncropped_image of this ProcessParams. # noqa: E501
1196
+ :rtype: bool
1197
+ """
1198
+ return self._return_uncropped_image
1199
+
1200
+ @return_uncropped_image.setter
1201
+ def return_uncropped_image(self, return_uncropped_image):
1202
+ """Sets the return_uncropped_image of this ProcessParams.
1203
+
1204
+ When enabled, returns input images in output. Disabled by default. # noqa: E501
1205
+
1206
+ :param return_uncropped_image: The return_uncropped_image of this ProcessParams. # noqa: E501
1207
+ :type return_uncropped_image: bool
1208
+ """
1209
+
1210
+ self._return_uncropped_image = return_uncropped_image
1211
+
1212
+ @property
1213
+ def mrz_formats_filter(self):
1214
+ """Gets the mrz_formats_filter of this ProcessParams. # noqa: E501
1215
+
1216
+ This option allows limiting MRZ formats to be recognized by specifying them in array. # noqa: E501
1217
+
1218
+ :return: The mrz_formats_filter of this ProcessParams. # noqa: E501
1219
+ :rtype: list[MRZFormat]
1220
+ """
1221
+ return self._mrz_formats_filter
1222
+
1223
+ @mrz_formats_filter.setter
1224
+ def mrz_formats_filter(self, mrz_formats_filter):
1225
+ """Sets the mrz_formats_filter of this ProcessParams.
1226
+
1227
+ This option allows limiting MRZ formats to be recognized by specifying them in array. # noqa: E501
1228
+
1229
+ :param mrz_formats_filter: The mrz_formats_filter of this ProcessParams. # noqa: E501
1230
+ :type mrz_formats_filter: list[MRZFormat]
1231
+ """
1232
+
1233
+ self._mrz_formats_filter = mrz_formats_filter
1234
+
1235
+ @property
1236
+ def force_read_mrz_before_locate(self):
1237
+ """Gets the force_read_mrz_before_locate of this ProcessParams. # noqa: E501
1238
+
1239
+ 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. # noqa: E501
1240
+
1241
+ :return: The force_read_mrz_before_locate of this ProcessParams. # noqa: E501
1242
+ :rtype: bool
1243
+ """
1244
+ return self._force_read_mrz_before_locate
1245
+
1246
+ @force_read_mrz_before_locate.setter
1247
+ def force_read_mrz_before_locate(self, force_read_mrz_before_locate):
1248
+ """Sets the force_read_mrz_before_locate of this ProcessParams.
1249
+
1250
+ 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. # noqa: E501
1251
+
1252
+ :param force_read_mrz_before_locate: The force_read_mrz_before_locate of this ProcessParams. # noqa: E501
1253
+ :type force_read_mrz_before_locate: bool
1254
+ """
1255
+
1256
+ self._force_read_mrz_before_locate = force_read_mrz_before_locate
1257
+
1258
+ @property
1259
+ def parse_barcodes(self):
1260
+ """Gets the parse_barcodes of this ProcessParams. # noqa: E501
1261
+
1262
+ This option can be disabled to stop parsing after barcode is read. Enabled by default. # noqa: E501
1263
+
1264
+ :return: The parse_barcodes of this ProcessParams. # noqa: E501
1265
+ :rtype: bool
1266
+ """
1267
+ return self._parse_barcodes
1268
+
1269
+ @parse_barcodes.setter
1270
+ def parse_barcodes(self, parse_barcodes):
1271
+ """Sets the parse_barcodes of this ProcessParams.
1272
+
1273
+ This option can be disabled to stop parsing after barcode is read. Enabled by default. # noqa: E501
1274
+
1275
+ :param parse_barcodes: The parse_barcodes of this ProcessParams. # noqa: E501
1276
+ :type parse_barcodes: bool
1277
+ """
1278
+
1279
+ self._parse_barcodes = parse_barcodes
1280
+
1281
+ @property
1282
+ def convert_case(self):
1283
+ """Gets the convert_case of this ProcessParams. # noqa: E501
1284
+
1285
+
1286
+ :return: The convert_case of this ProcessParams. # noqa: E501
1287
+ :rtype: TextPostProcessing
1288
+ """
1289
+ return self._convert_case
1290
+
1291
+ @convert_case.setter
1292
+ def convert_case(self, convert_case):
1293
+ """Sets the convert_case of this ProcessParams.
1294
+
1295
+
1296
+ :param convert_case: The convert_case of this ProcessParams. # noqa: E501
1297
+ :type convert_case: TextPostProcessing
1298
+ """
1299
+
1300
+ self._convert_case = convert_case
1301
+
1302
+ @property
1303
+ def split_names(self):
1304
+ """Gets the split_names of this ProcessParams. # noqa: E501
1305
+
1306
+ When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default. # noqa: E501
1307
+
1308
+ :return: The split_names of this ProcessParams. # noqa: E501
1309
+ :rtype: bool
1310
+ """
1311
+ return self._split_names
1312
+
1313
+ @split_names.setter
1314
+ def split_names(self, split_names):
1315
+ """Sets the split_names of this ProcessParams.
1316
+
1317
+ When enabled, the Surname and GivenNames fields from MRZ will be divided into ft_First_Name, ft_Second_Name, ft_Third_Name, ft_Fourth_Name, ft_Last_Name fields. Disabled by default. # noqa: E501
1318
+
1319
+ :param split_names: The split_names of this ProcessParams. # noqa: E501
1320
+ :type split_names: bool
1321
+ """
1322
+
1323
+ self._split_names = split_names
1324
+
1325
+ @property
1326
+ def disable_perforation_ocr(self):
1327
+ """Gets the disable_perforation_ocr of this ProcessParams. # noqa: E501
1328
+
1329
+ When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default. # noqa: E501
1330
+
1331
+ :return: The disable_perforation_ocr of this ProcessParams. # noqa: E501
1332
+ :rtype: bool
1333
+ """
1334
+ return self._disable_perforation_ocr
1335
+
1336
+ @disable_perforation_ocr.setter
1337
+ def disable_perforation_ocr(self, disable_perforation_ocr):
1338
+ """Sets the disable_perforation_ocr of this ProcessParams.
1339
+
1340
+ When enabled, OCR of perforated fields in the document template will not be performed. Disabled by default. # noqa: E501
1341
+
1342
+ :param disable_perforation_ocr: The disable_perforation_ocr of this ProcessParams. # noqa: E501
1343
+ :type disable_perforation_ocr: bool
1344
+ """
1345
+
1346
+ self._disable_perforation_ocr = disable_perforation_ocr
1347
+
1348
+ @property
1349
+ def document_group_filter(self):
1350
+ """Gets the document_group_filter of this ProcessParams. # noqa: E501
1351
+
1352
+ 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. # noqa: E501
1353
+
1354
+ :return: The document_group_filter of this ProcessParams. # noqa: E501
1355
+ :rtype: list[DocumentType]
1356
+ """
1357
+ return self._document_group_filter
1358
+
1359
+ @document_group_filter.setter
1360
+ def document_group_filter(self, document_group_filter):
1361
+ """Sets the document_group_filter of this ProcessParams.
1362
+
1363
+ 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. # noqa: E501
1364
+
1365
+ :param document_group_filter: The document_group_filter of this ProcessParams. # noqa: E501
1366
+ :type document_group_filter: list[DocumentType]
1367
+ """
1368
+
1369
+ self._document_group_filter = document_group_filter
1370
+
1371
+ @property
1372
+ def process_auth(self):
1373
+ """Gets the process_auth of this ProcessParams. # noqa: E501
1374
+
1375
+ Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added. # noqa: E501
1376
+
1377
+ :return: The process_auth of this ProcessParams. # noqa: E501
1378
+ :rtype: int
1379
+ """
1380
+ return self._process_auth
1381
+
1382
+ @process_auth.setter
1383
+ def process_auth(self, process_auth):
1384
+ """Sets the process_auth of this ProcessParams.
1385
+
1386
+ Authenticity checks that should be performed regardless of the document type. The available checks are listed in the eRPRM_Authenticity enum. Note that only supported by your license checks can be added. # noqa: E501
1387
+
1388
+ :param process_auth: The process_auth of this ProcessParams. # noqa: E501
1389
+ :type process_auth: int
1390
+ """
1391
+
1392
+ self._process_auth = process_auth
1393
+
1394
+ @property
1395
+ def device_id(self):
1396
+ """Gets the device_id of this ProcessParams. # noqa: E501
1397
+
1398
+ This parameter is used to specify the document reader device type from which input images were captured. Default 0. # noqa: E501
1399
+
1400
+ :return: The device_id of this ProcessParams. # noqa: E501
1401
+ :rtype: int
1402
+ """
1403
+ return self._device_id
1404
+
1405
+ @device_id.setter
1406
+ def device_id(self, device_id):
1407
+ """Sets the device_id of this ProcessParams.
1408
+
1409
+ This parameter is used to specify the document reader device type from which input images were captured. Default 0. # noqa: E501
1410
+
1411
+ :param device_id: The device_id of this ProcessParams. # noqa: E501
1412
+ :type device_id: int
1413
+ """
1414
+
1415
+ self._device_id = device_id
1416
+
1417
+ @property
1418
+ def device_type(self):
1419
+ """Gets the device_type of this ProcessParams. # noqa: E501
1420
+
1421
+ This parameter is used to specify the document reader device type from which input images were captured. Default 0. # noqa: E501
1422
+
1423
+ :return: The device_type of this ProcessParams. # noqa: E501
1424
+ :rtype: int
1425
+ """
1426
+ return self._device_type
1427
+
1428
+ @device_type.setter
1429
+ def device_type(self, device_type):
1430
+ """Sets the device_type of this ProcessParams.
1431
+
1432
+ This parameter is used to specify the document reader device type from which input images were captured. Default 0. # noqa: E501
1433
+
1434
+ :param device_type: The device_type of this ProcessParams. # noqa: E501
1435
+ :type device_type: int
1436
+ """
1437
+
1438
+ self._device_type = device_type
1439
+
1440
+ @property
1441
+ def device_type_hex(self):
1442
+ """Gets the device_type_hex of this ProcessParams. # noqa: E501
1443
+
1444
+ This parameter is used to specify the document reader device type from which input images were captured # noqa: E501
1445
+
1446
+ :return: The device_type_hex of this ProcessParams. # noqa: E501
1447
+ :rtype: str
1448
+ """
1449
+ return self._device_type_hex
1450
+
1451
+ @device_type_hex.setter
1452
+ def device_type_hex(self, device_type_hex):
1453
+ """Sets the device_type_hex of this ProcessParams.
1454
+
1455
+ This parameter is used to specify the document reader device type from which input images were captured # noqa: E501
1456
+
1457
+ :param device_type_hex: The device_type_hex of this ProcessParams. # noqa: E501
1458
+ :type device_type_hex: str
1459
+ """
1460
+
1461
+ self._device_type_hex = device_type_hex
1462
+
1463
+ @property
1464
+ def ignore_device_id_from_image(self):
1465
+ """Gets the ignore_device_id_from_image of this ProcessParams. # noqa: E501
1466
+
1467
+ 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 # noqa: E501
1468
+
1469
+ :return: The ignore_device_id_from_image of this ProcessParams. # noqa: E501
1470
+ :rtype: bool
1471
+ """
1472
+ return self._ignore_device_id_from_image
1473
+
1474
+ @ignore_device_id_from_image.setter
1475
+ def ignore_device_id_from_image(self, ignore_device_id_from_image):
1476
+ """Sets the ignore_device_id_from_image of this ProcessParams.
1477
+
1478
+ 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 # noqa: E501
1479
+
1480
+ :param ignore_device_id_from_image: The ignore_device_id_from_image of this ProcessParams. # noqa: E501
1481
+ :type ignore_device_id_from_image: bool
1482
+ """
1483
+
1484
+ self._ignore_device_id_from_image = ignore_device_id_from_image
1485
+
1486
+ @property
1487
+ def document_id_list(self):
1488
+ """Gets the document_id_list of this ProcessParams. # noqa: E501
1489
+
1490
+ List of the document ID's to process. All documents will be processed, if empty. # noqa: E501
1491
+
1492
+ :return: The document_id_list of this ProcessParams. # noqa: E501
1493
+ :rtype: list[int]
1494
+ """
1495
+ return self._document_id_list
1496
+
1497
+ @document_id_list.setter
1498
+ def document_id_list(self, document_id_list):
1499
+ """Sets the document_id_list of this ProcessParams.
1500
+
1501
+ List of the document ID's to process. All documents will be processed, if empty. # noqa: E501
1502
+
1503
+ :param document_id_list: The document_id_list of this ProcessParams. # noqa: E501
1504
+ :type document_id_list: list[int]
1505
+ """
1506
+
1507
+ self._document_id_list = document_id_list
1508
+
1509
+ @property
1510
+ def rfid(self):
1511
+ """Gets the rfid of this ProcessParams. # noqa: E501
1512
+
1513
+
1514
+ :return: The rfid of this ProcessParams. # noqa: E501
1515
+ :rtype: ProcessParamsRfid
1516
+ """
1517
+ return self._rfid
1518
+
1519
+ @rfid.setter
1520
+ def rfid(self, rfid):
1521
+ """Sets the rfid of this ProcessParams.
1522
+
1523
+
1524
+ :param rfid: The rfid of this ProcessParams. # noqa: E501
1525
+ :type rfid: ProcessParamsRfid
1526
+ """
1527
+
1528
+ self._rfid = rfid
1529
+
1530
+ @property
1531
+ def check_auth(self):
1532
+ """Gets the check_auth of this ProcessParams. # noqa: E501
1533
+
1534
+ This parameter is used to enable authenticity checks # noqa: E501
1535
+
1536
+ :return: The check_auth of this ProcessParams. # noqa: E501
1537
+ :rtype: bool
1538
+ """
1539
+ return self._check_auth
1540
+
1541
+ @check_auth.setter
1542
+ def check_auth(self, check_auth):
1543
+ """Sets the check_auth of this ProcessParams.
1544
+
1545
+ This parameter is used to enable authenticity checks # noqa: E501
1546
+
1547
+ :param check_auth: The check_auth of this ProcessParams. # noqa: E501
1548
+ :type check_auth: bool
1549
+ """
1550
+
1551
+ self._check_auth = check_auth
1552
+
1553
+ @property
1554
+ def auth_params(self):
1555
+ """Gets the auth_params of this ProcessParams. # noqa: E501
1556
+
1557
+
1558
+ :return: The auth_params of this ProcessParams. # noqa: E501
1559
+ :rtype: AuthParams
1560
+ """
1561
+ return self._auth_params
1562
+
1563
+ @auth_params.setter
1564
+ def auth_params(self, auth_params):
1565
+ """Sets the auth_params of this ProcessParams.
1566
+
1567
+
1568
+ :param auth_params: The auth_params of this ProcessParams. # noqa: E501
1569
+ :type auth_params: AuthParams
1570
+ """
1571
+
1572
+ self._auth_params = auth_params
1573
+
1574
+ @property
1575
+ def mrz_detect_mode(self):
1576
+ """Gets the mrz_detect_mode of this ProcessParams. # noqa: E501
1577
+
1578
+
1579
+ :return: The mrz_detect_mode of this ProcessParams. # noqa: E501
1580
+ :rtype: MrzDetectModeEnum
1581
+ """
1582
+ return self._mrz_detect_mode
1583
+
1584
+ @mrz_detect_mode.setter
1585
+ def mrz_detect_mode(self, mrz_detect_mode):
1586
+ """Sets the mrz_detect_mode of this ProcessParams.
1587
+
1588
+
1589
+ :param mrz_detect_mode: The mrz_detect_mode of this ProcessParams. # noqa: E501
1590
+ :type mrz_detect_mode: MrzDetectModeEnum
1591
+ """
1592
+
1593
+ self._mrz_detect_mode = mrz_detect_mode
1594
+
1595
+ @property
1596
+ def generate_numeric_codes(self):
1597
+ """Gets the generate_numeric_codes of this ProcessParams. # noqa: E501
1598
+
1599
+ This parameter is used to generate numeric representation for issuing state and nationality codes # noqa: E501
1600
+
1601
+ :return: The generate_numeric_codes of this ProcessParams. # noqa: E501
1602
+ :rtype: bool
1603
+ """
1604
+ return self._generate_numeric_codes
1605
+
1606
+ @generate_numeric_codes.setter
1607
+ def generate_numeric_codes(self, generate_numeric_codes):
1608
+ """Sets the generate_numeric_codes of this ProcessParams.
1609
+
1610
+ This parameter is used to generate numeric representation for issuing state and nationality codes # noqa: E501
1611
+
1612
+ :param generate_numeric_codes: The generate_numeric_codes of this ProcessParams. # noqa: E501
1613
+ :type generate_numeric_codes: bool
1614
+ """
1615
+
1616
+ self._generate_numeric_codes = generate_numeric_codes
1617
+
1618
+ @property
1619
+ def strict_barcode_digital_signature_check(self):
1620
+ """Gets the strict_barcode_digital_signature_check of this ProcessParams. # noqa: E501
1621
+
1622
+ This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed. # noqa: E501
1623
+
1624
+ :return: The strict_barcode_digital_signature_check of this ProcessParams. # noqa: E501
1625
+ :rtype: bool
1626
+ """
1627
+ return self._strict_barcode_digital_signature_check
1628
+
1629
+ @strict_barcode_digital_signature_check.setter
1630
+ def strict_barcode_digital_signature_check(self, strict_barcode_digital_signature_check):
1631
+ """Sets the strict_barcode_digital_signature_check of this ProcessParams.
1632
+
1633
+ This parameter if enabled will require all necessary certificates to verify digital signature in barcode data to be present in order for the Barcode format check to succeed. # noqa: E501
1634
+
1635
+ :param strict_barcode_digital_signature_check: The strict_barcode_digital_signature_check of this ProcessParams. # noqa: E501
1636
+ :type strict_barcode_digital_signature_check: bool
1637
+ """
1638
+
1639
+ self._strict_barcode_digital_signature_check = strict_barcode_digital_signature_check
1640
+
1641
+ @property
1642
+ def select_longest_names(self):
1643
+ """Gets the select_longest_names of this ProcessParams. # noqa: E501
1644
+
1645
+ Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc. # noqa: E501
1646
+
1647
+ :return: The select_longest_names of this ProcessParams. # noqa: E501
1648
+ :rtype: bool
1649
+ """
1650
+ return self._select_longest_names
1651
+
1652
+ @select_longest_names.setter
1653
+ def select_longest_names(self, select_longest_names):
1654
+ """Sets the select_longest_names of this ProcessParams.
1655
+
1656
+ Select the longest value from the different value sources and write it to the value field if comparison is done successfully. The parameter applies this logic to the personal names, such as given name, surname, surname and given name, middle name and etc. # noqa: E501
1657
+
1658
+ :param select_longest_names: The select_longest_names of this ProcessParams. # noqa: E501
1659
+ :type select_longest_names: bool
1660
+ """
1661
+
1662
+ self._select_longest_names = select_longest_names
1663
+
1664
+ @property
1665
+ def do_barcodes(self):
1666
+ """Gets the do_barcodes of this ProcessParams. # noqa: E501
1667
+
1668
+ Set the types of barcodes to process. # noqa: E501
1669
+
1670
+ :return: The do_barcodes of this ProcessParams. # noqa: E501
1671
+ :rtype: list[InputBarcodeType]
1672
+ """
1673
+ return self._do_barcodes
1674
+
1675
+ @do_barcodes.setter
1676
+ def do_barcodes(self, do_barcodes):
1677
+ """Sets the do_barcodes of this ProcessParams.
1678
+
1679
+ Set the types of barcodes to process. # noqa: E501
1680
+
1681
+ :param do_barcodes: The do_barcodes of this ProcessParams. # noqa: E501
1682
+ :type do_barcodes: list[InputBarcodeType]
1683
+ """
1684
+
1685
+ self._do_barcodes = do_barcodes
1686
+
1687
+ @property
1688
+ def strict_dl_category_expiry(self):
1689
+ """Gets the strict_dl_category_expiry of this ProcessParams. # noqa: E501
1690
+
1691
+ Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases. # noqa: E501
1692
+
1693
+ :return: The strict_dl_category_expiry of this ProcessParams. # noqa: E501
1694
+ :rtype: bool
1695
+ """
1696
+ return self._strict_dl_category_expiry
1697
+
1698
+ @strict_dl_category_expiry.setter
1699
+ def strict_dl_category_expiry(self, strict_dl_category_expiry):
1700
+ """Sets the strict_dl_category_expiry of this ProcessParams.
1701
+
1702
+ Set to force DL categories expiry date to affect the overall status or not. As documents usually have their own date of expiry, which might be less or greater than category expiry date, this might be handy for specific cases. # noqa: E501
1703
+
1704
+ :param strict_dl_category_expiry: The strict_dl_category_expiry of this ProcessParams. # noqa: E501
1705
+ :type strict_dl_category_expiry: bool
1706
+ """
1707
+
1708
+ self._strict_dl_category_expiry = strict_dl_category_expiry
1709
+
1710
+ def to_dict(self):
1711
+ """Returns the model properties as a dict"""
1712
+ result = {}
1713
+
1714
+ for attr, _ in six.iteritems(self.openapi_types):
1715
+ value = getattr(self, attr)
1716
+ if isinstance(value, list):
1717
+ result[attr] = list(map(
1718
+ lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
1719
+ value
1720
+ ))
1721
+ elif hasattr(value, "to_dict"):
1722
+ result[attr] = value.to_dict()
1723
+ elif isinstance(value, dict):
1724
+ result[attr] = dict(map(
1725
+ lambda item: (item[0], item[1].to_dict())
1726
+ if hasattr(item[1], "to_dict") else item,
1727
+ value.items()
1728
+ ))
1729
+ else:
1730
+ result[attr] = value
1731
+
1732
+ return result
1733
+
1734
+ def to_str(self):
1735
+ """Returns the string representation of the model"""
1736
+ return pprint.pformat(self.to_dict())
1737
+
1738
+ def __repr__(self):
1739
+ """For `print` and `pprint`"""
1740
+ return self.to_str()
1741
+
1742
+ def __eq__(self, other):
1743
+ """Returns true if both objects are equal"""
1744
+ if not isinstance(other, ProcessParams):
1745
+ return False
1746
+
1747
+ return self.to_dict() == other.to_dict()
1748
+
1749
+ def __ne__(self, other):
1750
+ """Returns true if both objects are not equal"""
1751
+ if not isinstance(other, ProcessParams):
1752
+ return True
240
1753
 
1754
+ return self.to_dict() != other.to_dict()