regula.documentreader.webclient 9.8.1018.dev0__py3-none-any.whl → 9.8.1019.dev0__py3-none-any.whl

regula/documentreader/webclient/gen/__init__.py

@@ -198,6 +198,7 @@ __all__ = [
     "ResultMRZDetector",
     "ResultMRZDetectorItem",
     "RfidAChip",
+    "RfidAccessControl",
     "RfidAccessControlInfo",
     "RfidAccessControlProcedureType",
     "RfidAccessKey",
@@ -471,6 +472,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.result_mrz_detector import ResultMRZDetector as ResultMRZDetector
     from regula.documentreader.webclient.gen.models.result_mrz_detector_item import ResultMRZDetectorItem as ResultMRZDetectorItem
     from regula.documentreader.webclient.gen.models.rfid_a_chip import RfidAChip as RfidAChip
+    from regula.documentreader.webclient.gen.models.rfid_access_control import RfidAccessControl as RfidAccessControl
     from regula.documentreader.webclient.gen.models.rfid_access_control_info import RfidAccessControlInfo as RfidAccessControlInfo
     from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_type import RfidAccessControlProcedureType as RfidAccessControlProcedureType
     from regula.documentreader.webclient.gen.models.rfid_access_key import RfidAccessKey as RfidAccessKey
@@ -750,6 +752,7 @@ from regula.documentreader.webclient.gen.models.result_item import ResultItem as
 from regula.documentreader.webclient.gen.models.result_mrz_detector import ResultMRZDetector as ResultMRZDetector
 from regula.documentreader.webclient.gen.models.result_mrz_detector_item import ResultMRZDetectorItem as ResultMRZDetectorItem
 from regula.documentreader.webclient.gen.models.rfid_a_chip import RfidAChip as RfidAChip
+from regula.documentreader.webclient.gen.models.rfid_access_control import RfidAccessControl as RfidAccessControl
 from regula.documentreader.webclient.gen.models.rfid_access_control_info import RfidAccessControlInfo as RfidAccessControlInfo
 from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_type import RfidAccessControlProcedureType as RfidAccessControlProcedureType
 from regula.documentreader.webclient.gen.models.rfid_access_key import RfidAccessKey as RfidAccessKey

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

@@ -182,6 +182,7 @@ if __import__("typing").TYPE_CHECKING:
     from regula.documentreader.webclient.gen.models.result_mrz_detector import ResultMRZDetector
     from regula.documentreader.webclient.gen.models.result_mrz_detector_item import ResultMRZDetectorItem
     from regula.documentreader.webclient.gen.models.rfid_a_chip import RfidAChip
+    from regula.documentreader.webclient.gen.models.rfid_access_control import RfidAccessControl
     from regula.documentreader.webclient.gen.models.rfid_access_control_info import RfidAccessControlInfo
     from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_type import RfidAccessControlProcedureType
     from regula.documentreader.webclient.gen.models.rfid_access_key import RfidAccessKey
@@ -442,6 +443,7 @@ from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from regula.documentreader.webclient.gen.models.result_mrz_detector import ResultMRZDetector
 from regula.documentreader.webclient.gen.models.result_mrz_detector_item import ResultMRZDetectorItem
 from regula.documentreader.webclient.gen.models.rfid_a_chip import RfidAChip
+from regula.documentreader.webclient.gen.models.rfid_access_control import RfidAccessControl
 from regula.documentreader.webclient.gen.models.rfid_access_control_info import RfidAccessControlInfo
 from regula.documentreader.webclient.gen.models.rfid_access_control_procedure_type import RfidAccessControlProcedureType
 from regula.documentreader.webclient.gen.models.rfid_access_key import RfidAccessKey

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

@@ -48,7 +48,7 @@ class ProcessParams(BaseModel):
     image_output_max_width: SkipValidation[Optional[int]] = Field(alias="imageOutputMaxWidth", 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.")
     scenario: SkipValidation[Scenario] = Field(alias="scenario")
     result_type_output: SkipValidation[Optional[List[Result]]] = Field(alias="resultTypeOutput", default=None, description="Types of results to return in response. See 'Result' enum for available options")
-    double_page_spread: SkipValidation[Optional[bool]] = Field(alias="doublePageSpread", 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.")
+    double_page_spread: SkipValidation[Optional[bool]] = Field(alias="doublePageSpread", default=None, description="This option can be set to true if the image you provide contains double page spread of the passport and you want to process both pages in one go. It makes sense to use it for documents that have meaningful information on both pages. If disabled, only one page is extracted.")
     generate_double_page_spread_image: SkipValidation[Optional[bool]] = Field(alias="generateDoublePageSpreadImage", 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.")
     field_types_filter: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="fieldTypesFilter", default=None, description="If a document contains Visual zone, you can set the list of field types to extract. In this case, other fields are skipped during the processing, i.e. document recognition becomes faster. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.")
     field_types_ignore_filter: SkipValidation[Optional[List[TextFieldType]]] = Field(alias="fieldTypesIgnoreFilter", default=None, description="If a document contains a Visual zone, you can specify a list of field types that should be excluded from extraction. All field types listed in this array are skipped during processing, while the remaining fields are recognized. This filter is not applicable to the MRZ, barcode or RFID. If the fieldTypesIgnoreFilter is empty, all fields are extracted. Empty by default. If fieldTypesFilter and fieldTypesIgnoreFilter are used simultaneously, fieldTypesFilter takes priority.")

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

@@ -0,0 +1,31 @@
+# coding: utf-8
+
+"""
+    Generated by: https://openapi-generator.tech
+"""
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class RfidAccessControl(int, Enum):
+    """
+    RfidAccessControl
+    """
+
+    """
+    allowed enum values
+    """
+    DEFAULT = 0
+    CHIP_ACCESS_BAC = 1
+    CHIP_ACCESS_PACE = 2
+    LOCAL_PIN = 3
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RfidAccessControl from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

@@ -27,6 +27,8 @@ class RfidApplicationType(int, Enum):
     LDS2_VisaRecords = 6
     LDS2_AddBiometrics = 7
     eDTC_PC = 8
+    APPLET_ROOT = 50
+    USER_DEFINED = 100
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

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

@@ -26,6 +26,7 @@ class RfidPasswordType(int, Enum):
     PIN_E_SIGN = 5
     SAI = 6
     MRZ_HASH = 7
+    PIN_LOCAL = 8
 
     @classmethod
     def from_json(cls, json_str: str) -> Self:

{regula_documentreader_webclient-9.8.1018.dev0.dist-info → regula_documentreader_webclient-9.8.1019.dev0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: regula_documentreader_webclient
-Version: 9.8.1018.dev0
+Version: 9.8.1019.dev0
 Summary: Regula's Document Reader python client
 Home-page: https://regulaforensics.com
 Author: Regula Forensics, Inc.

{regula_documentreader_webclient-9.8.1018.dev0.dist-info → regula_documentreader_webclient-9.8.1019.dev0.dist-info}/RECORD

@@ -17,7 +17,7 @@ regula/documentreader/webclient/ext/models/authenticity/ident.py,sha256=DSmXEJ-v
 regula/documentreader/webclient/ext/models/authenticity/image_ident.py,sha256=QmKTghP4Lo7bHBEubwzsVt1ob97NNaNIu_5QN_LUF9M,370
 regula/documentreader/webclient/ext/models/authenticity/ocr_security_text.py,sha256=BV0h2_UDrwUlWczoJQW8qTSkdZ0icm0n0pPDRY9Qwq4,407
 regula/documentreader/webclient/ext/models/authenticity/security_feature.py,sha256=t8egDyT1wlGvsyvZboAFOvcaYsALGpj41E50FUbvx68,622
-regula/documentreader/webclient/gen/__init__.py,sha256=xic2JA1G1LspIJB0r-MnLn6kChUxArccn6SKL7qvuY0,66180
+regula/documentreader/webclient/gen/__init__.py,sha256=lKWajKjsDCBNT0EKlL6IMuLfv0f_5p3-0rSgyBX1KhQ,66437
 regula/documentreader/webclient/gen/api_client.py,sha256=BZ1SIy0PwA4khadeMet9fNj8pt1j_OaaebUSHChq31k,27673
 regula/documentreader/webclient/gen/api_response.py,sha256=eMxw1mpmJcoGZ3gs9z6jM4oYoZ10Gjk333s9sKxGv7s,652
 regula/documentreader/webclient/gen/configuration.py,sha256=0hMqlAxYaL30050LBPnHrh6Sg1EIfSfQLr0eGNRNz1w,18084
@@ -29,7 +29,7 @@ regula/documentreader/webclient/gen/api/healthcheck_api.py,sha256=g3Q3XsdgYfEmmd
 regula/documentreader/webclient/gen/api/process_api.py,sha256=RnJXVZy-M1bNfiXK0tHEQEuhOgxkXk9jMG-hpZfTjZ8,12123
 regula/documentreader/webclient/gen/api/resources_api.py,sha256=grQfqv8hZNJnR1hC72jG614D_Y9MDn3sMyZYWllk15U,10264
 regula/documentreader/webclient/gen/api/transaction_api.py,sha256=53uZvktOfFNr_b9iWYR0AqD4YGTzvVtfUa25ir5ooqE,66657
-regula/documentreader/webclient/gen/models/__init__.py,sha256=yLaOkwTWkgOlVuXXPKS2kF22LEH4Ff0dQ_YcsFHnAtU,47143
+regula/documentreader/webclient/gen/models/__init__.py,sha256=7w0uhTa63kuh7u-LdevqkxUba6xYzAwHhygwUPz4NME,47333
 regula/documentreader/webclient/gen/models/area_array.py,sha256=ifzL0bjUAQGTdIdsY8Lce0wvZQxuuVB9_DhFRSlA9jY,3756
 regula/documentreader/webclient/gen/models/area_container.py,sha256=rWQPaY9tD3QkQXxnV1rmi1PeB3F2WPBj9zdPWnc7kCY,3737
 regula/documentreader/webclient/gen/models/auth_params.py,sha256=FZSIL8W_77LNVdcT0IJZ1Zy2_VrqR4W1qb-aBt91_JM,7717
@@ -181,7 +181,7 @@ regula/documentreader/webclient/gen/models/pid.py,sha256=EbCFBNMnDm96XP5GD00umks
 regula/documentreader/webclient/gen/models/point.py,sha256=TBIznHwx7KPGeWBoA9uGcQks_zYsm17w2AuQyagz9QU,2402
 regula/documentreader/webclient/gen/models/point_array.py,sha256=7zh8uInkAXbqnHRxONNtNWBZTC46jUnJqBmaOP5FHWE,2935
 regula/documentreader/webclient/gen/models/points_container.py,sha256=XdLHe0TIWtsi2SFqPw_WLZ8kqvXbvvVLTDXIi5Z5-to,3128
-regula/documentreader/webclient/gen/models/process_params.py,sha256=1_EH3hk5AoaaInTvNnx-fYFBh3Dk8VNNBN2MpoE6NO4,28075
+regula/documentreader/webclient/gen/models/process_params.py,sha256=8IhOFSScV_SbhQ-_uQd4Tg2usDi_ZQUK6aG4Lwexts0,28059
 regula/documentreader/webclient/gen/models/process_params_rfid.py,sha256=Uafaa-fWJi3_L49C_KsOnaOyB1c76qsFqzeUsfDrOug,2782
 regula/documentreader/webclient/gen/models/process_request.py,sha256=RxV1ru8Ng-h79FNxKu3zix6u--oBz3vWOjkQLq30cB0,6320
 regula/documentreader/webclient/gen/models/process_request_image.py,sha256=ubI2M_gyDb7ozEn6dieU3x8qjInExwOYdiyrk2v6sEo,3191
@@ -197,11 +197,12 @@ regula/documentreader/webclient/gen/models/result_item.py,sha256=LrRjYu2NYcX7IFi
 regula/documentreader/webclient/gen/models/result_mrz_detector.py,sha256=H-etFG40cibzyBscojCkFidfk5RP0hfK5-icKaMeukk,3415
 regula/documentreader/webclient/gen/models/result_mrz_detector_item.py,sha256=fk6RR71WBKs77z7yyRzD7n8EXQDiJCWtaz6zCod9lk8,2919
 regula/documentreader/webclient/gen/models/rfid_a_chip.py,sha256=UyJYlx6g9NXxGPfcRGMwYkL_GeP8JydF81NftfLVau4,684
+regula/documentreader/webclient/gen/models/rfid_access_control.py,sha256=ZEBFE9BAl9ugBMlCoPJDU2nb8RxdMxj8hKp6dh7sNeo,560
 regula/documentreader/webclient/gen/models/rfid_access_control_info.py,sha256=hgjqDMm94U-GlOsOBs_whQIu9LGrfPsYknZbh2DaW8Y,3887
 regula/documentreader/webclient/gen/models/rfid_access_control_procedure_type.py,sha256=4sZv-krwp4q3LSz9Wi4of-tKAulHh-n4V2LD60tfL6A,720
 regula/documentreader/webclient/gen/models/rfid_access_key.py,sha256=lAmt3BPk3kz2b1-RNkAH4wvxDXuNWlme0yYdCBF7vD8,3368
 regula/documentreader/webclient/gen/models/rfid_application.py,sha256=jTgcmPsuiuAjVb7kh_64oPlaDyxRPnv9Inovat_U8ck,4368
-regula/documentreader/webclient/gen/models/rfid_application_type.py,sha256=MkX-tdmJmSMEFfZcmAGAzK5P-YmSDkGBNKv4wphH9vE,786
+regula/documentreader/webclient/gen/models/rfid_application_type.py,sha256=VLZpySMy74oJWhvciRuSb5IzEmMvclGzV5KTesYmqak,830
 regula/documentreader/webclient/gen/models/rfid_attribute_data.py,sha256=X4JbBpl6WO7SRN4WP8XboAmfWIlg4iwroWoyMmuEDWE,2726
 regula/documentreader/webclient/gen/models/rfid_attribute_name.py,sha256=fBe07LMPF-wZ_Gu31L7XL2uVgK6euhHiOP7yKllknxE,3083
 regula/documentreader/webclient/gen/models/rfid_authentication_procedure_type.py,sha256=Aot40N251tRBx1EM3ZmTlpmBm6Ga6CA-lg-KcC2MfyI,693
@@ -223,7 +224,7 @@ regula/documentreader/webclient/gen/models/rfid_error_codes.py,sha256=_jhV3_iylJ
 regula/documentreader/webclient/gen/models/rfid_graphics_info_result.py,sha256=KcApP99SbXnNifDtmJvk_B9MmK_U0O5N-yJ0qnL4ZxM,3491
 regula/documentreader/webclient/gen/models/rfid_location.py,sha256=DQ66ASnrU4HV5jN5MiDEKwRvvnqvxPY1RzXdZX5z6Vs,693
 regula/documentreader/webclient/gen/models/rfid_origin.py,sha256=8CpEcVovrsRwb0i3ojls9wtJEMGE2K5NGpz8pRYctqY,3003
-regula/documentreader/webclient/gen/models/rfid_password_type.py,sha256=7zkWjkyhflKnIdCG9rmd0UywmKhKDmQPGQ3ERa5-nl4,683
+regula/documentreader/webclient/gen/models/rfid_password_type.py,sha256=H89chFaABeiEuOcgsRhx-8SrRLLnUhA2dy2lCgLA5Mg,701
 regula/documentreader/webclient/gen/models/rfid_pki_extension.py,sha256=vw7dI4fPuZHmfpRIDyzL9KeVSoZ8CQDJFm0D76HZt6Q,2839
 regula/documentreader/webclient/gen/models/rfid_raw_data.py,sha256=y64_EgTrRh5Ncix_Rw1DPdfWhR5-N1GZbcEfWyvwmws,2500
 regula/documentreader/webclient/gen/models/rfid_security_object.py,sha256=AgoInhgOYcFw-O4rozHorjHXOj6yhJOEf5ODyVKaEZU,4189
@@ -285,7 +286,7 @@ regula/documentreader/webclient/gen/models/verification_result.py,sha256=E6bCVR5
 regula/documentreader/webclient/gen/models/verified_field_map.py,sha256=QjCCjZ82WhT5uzdFthwfiX4Kgi5RL_m7E0NprLhHAJs,4863
 regula/documentreader/webclient/gen/models/visibility.py,sha256=GACgQd_8lx_cwMwI5lCi7cTxEWxw2atbJo6uI4mTKpQ,602
 regula/documentreader/webclient/gen/models/visual_extended_field_item.py,sha256=FETunEPtXE6eAsQbSg1Tn7rO7rut4ZT7BooMPT1ZhmA,5282
-regula_documentreader_webclient-9.8.1018.dev0.dist-info/METADATA,sha256=rYheB21u44rRNpdhha2cuOy7CwXq7Q1LBadvySfI1Ms,4038
-regula_documentreader_webclient-9.8.1018.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
-regula_documentreader_webclient-9.8.1018.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
-regula_documentreader_webclient-9.8.1018.dev0.dist-info/RECORD,,
+regula_documentreader_webclient-9.8.1019.dev0.dist-info/METADATA,sha256=qI8NbMwajmX_5js_ZOOZF32IJue3D07TIKMdk5G7VZA,4038
+regula_documentreader_webclient-9.8.1019.dev0.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+regula_documentreader_webclient-9.8.1019.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
+regula_documentreader_webclient-9.8.1019.dev0.dist-info/RECORD,,