add mrz filter

Author: actions-user

.openapi-generator/FILES

@@ -67,6 +67,7 @@ regula/documentreader/webclient/gen/models/light.py
 regula/documentreader/webclient/gen/models/list_verified_fields.py
 regula/documentreader/webclient/gen/models/log_level.py
 regula/documentreader/webclient/gen/models/measure_system.py
+regula/documentreader/webclient/gen/models/mrz_format.py
 regula/documentreader/webclient/gen/models/ocr_security_text_result.py
 regula/documentreader/webclient/gen/models/ocr_security_text_result_all_of.py
 regula/documentreader/webclient/gen/models/one_candidate.py

regula/documentreader/webclient/gen/__init__.py

@@ -84,6 +84,7 @@
 from regula.documentreader.webclient.gen.models.light import Light
 from regula.documentreader.webclient.gen.models.list_verified_fields import ListVerifiedFields
 from regula.documentreader.webclient.gen.models.log_level import LogLevel
+from regula.documentreader.webclient.gen.models.mrz_format import MRZFormat
 from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
 from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
 from regula.documentreader.webclient.gen.models.ocr_security_text_result_all_of import OCRSecurityTextResultAllOf

regula/documentreader/webclient/gen/models/__init__.py

@@ -68,6 +68,7 @@
 from regula.documentreader.webclient.gen.models.light import Light
 from regula.documentreader.webclient.gen.models.list_verified_fields import ListVerifiedFields
 from regula.documentreader.webclient.gen.models.log_level import LogLevel
+from regula.documentreader.webclient.gen.models.mrz_format import MRZFormat
 from regula.documentreader.webclient.gen.models.measure_system import MeasureSystem
 from regula.documentreader.webclient.gen.models.ocr_security_text_result import OCRSecurityTextResult
 from regula.documentreader.webclient.gen.models.ocr_security_text_result_all_of import OCRSecurityTextResultAllOf

regula/documentreader/webclient/gen/models/mrz_format.py

@@ -0,0 +1,105 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+import pprint
+import re  # noqa: F401
+
+import six
+
+from regula.documentreader.webclient.gen.configuration import Configuration
+# this line was added to enable pycharm type hinting
+from regula.documentreader.webclient.gen.models import *
+
+
+"""
+
+"""
+class MRZFormat(object):
+    """NOTE: This class is auto generated by OpenAPI Generator.
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    IDL = "1x30"
+
+    ID1 = "3x30"
+
+    ID2 = "2x36"
+
+    ID3 = "2x44"
+
+    CAN = "1x6"
+
+    ID1_2_30 = "2x30"
+
+    allowable_values = [IDL, ID1, ID2, ID3, CAN, ID1_2_30]  # noqa: E501
+
+    """
+    Attributes:
+      openapi_types (dict): The key is attribute name
+                            and the value is attribute type.
+      attribute_map (dict): The key is attribute name
+                            and the value is json key in definition.
+    """
+    openapi_types = {
+    }
+
+    attribute_map = {
+    }
+
+    def __init__(self, local_vars_configuration=None):  # noqa: E501
+        """MRZFormat - a model defined in OpenAPI"""  # noqa: E501
+        if local_vars_configuration is None:
+            local_vars_configuration = Configuration()
+        self.local_vars_configuration = local_vars_configuration
+        self.discriminator = None
+
+    def to_dict(self):
+        """Returns the model properties as a dict"""
+        result = {}
+
+        for attr, _ in six.iteritems(self.openapi_types):
+            value = getattr(self, attr)
+            if isinstance(value, list):
+                result[attr] = list(map(
+                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
+                    value
+                ))
+            elif hasattr(value, "to_dict"):
+                result[attr] = value.to_dict()
+            elif isinstance(value, dict):
+                result[attr] = dict(map(
+                    lambda item: (item[0], item[1].to_dict())
+                    if hasattr(item[1], "to_dict") else item,
+                    value.items()
+                ))
+            else:
+                result[attr] = value
+
+        return result
+
+    def to_str(self):
+        """Returns the string representation of the model"""
+        return pprint.pformat(self.to_dict())
+
+    def __repr__(self):
+        """For `print` and `pprint`"""
+        return self.to_str()
+
+    def __eq__(self, other):
+        """Returns true if both objects are equal"""
+        if not isinstance(other, MRZFormat):
+            return False
+
+        return self.to_dict() == other.to_dict()
+
+    def __ne__(self, other):
+        """Returns true if both objects are not equal"""
+        if not isinstance(other, MRZFormat):
+            return True
+
+        return self.to_dict() != other.to_dict()

regula/documentreader/webclient/gen/models/process_params.py

@@ -58,7 +58,8 @@ class ProcessParams(object):
         'multi_doc_on_image': 'bool',
         'shift_expiry_date': 'int',
         'minimal_holder_age': 'int',
-        'return_uncropped_image': 'bool'
+        'return_uncropped_image': 'bool',
+        'mrz_formats_filter': 'list[MRZFormat]'
     }
 
     attribute_map = {
@@ -88,10 +89,11 @@ class ProcessParams(object):
         'multi_doc_on_image': 'multiDocOnImage',
         'shift_expiry_date': 'shiftExpiryDate',
         'minimal_holder_age': 'minimalHolderAge',
-        'return_uncropped_image': 'returnUncroppedImage'
+        'return_uncropped_image': 'returnUncroppedImage',
+        'mrz_formats_filter': 'mrzFormatsFilter'
     }
 
-    def __init__(self, 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, 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, force_doc_format=None, no_graphics=None, document_area_min=None, depersonalize_log=None, multi_doc_on_image=None, shift_expiry_date=None, minimal_holder_age=None, return_uncropped_image=None, local_vars_configuration=None):  # noqa: E501
+    def __init__(self, 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, 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, force_doc_format=None, no_graphics=None, document_area_min=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, local_vars_configuration=None):  # noqa: E501
         """ProcessParams - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
@@ -124,6 +126,7 @@ def __init__(self, scenario=None, result_type_output=None, double_page_spread=No
         self._shift_expiry_date = None
         self._minimal_holder_age = None
         self._return_uncropped_image = None
+        self._mrz_formats_filter = None
         self.discriminator = None
 
         self.scenario = scenario
@@ -179,6 +182,8 @@ def __init__(self, scenario=None, result_type_output=None, double_page_spread=No
             self.minimal_holder_age = minimal_holder_age
         if return_uncropped_image is not None:
             self.return_uncropped_image = return_uncropped_image
+        if mrz_formats_filter is not None:
+            self.mrz_formats_filter = mrz_formats_filter
 
     @property
     def scenario(self):
@@ -793,6 +798,29 @@ def return_uncropped_image(self, return_uncropped_image):
 
         self._return_uncropped_image = return_uncropped_image
 
+    @property
+    def mrz_formats_filter(self):
+        """Gets the mrz_formats_filter of this ProcessParams.  # noqa: E501
+
+        This option allows limiting MRZ formats to be recognized by specifying them in array.  # noqa: E501
+
+        :return: The mrz_formats_filter of this ProcessParams.  # noqa: E501
+        :rtype: list[MRZFormat]
+        """
+        return self._mrz_formats_filter
+
+    @mrz_formats_filter.setter
+    def mrz_formats_filter(self, mrz_formats_filter):
+        """Sets the mrz_formats_filter of this ProcessParams.
+
+        This option allows limiting MRZ formats to be recognized by specifying them in array.  # noqa: E501
+
+        :param mrz_formats_filter: The mrz_formats_filter of this ProcessParams.  # noqa: E501
+        :type mrz_formats_filter: list[MRZFormat]
+        """
+
+        self._mrz_formats_filter = mrz_formats_filter
+
     def to_dict(self):
         """Returns the model properties as a dict"""
         result = {}