regula-documentreader-webclient 8.1.342.dev0__py3-none-any.whl → 8.1.344.dev0__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 (8) hide show
  1. regula/documentreader/webclient/gen/models/chosen_document_type.py +2 -2
  2. regula/documentreader/webclient/gen/models/one_candidate.py +2 -2
  3. regula/documentreader/webclient/gen/models/process_params.py +4 -2
  4. regula/documentreader/webclient/gen/models/text_field_type.py +3 -0
  5. {regula_documentreader_webclient-8.1.342.dev0.dist-info → regula_documentreader_webclient-8.1.344.dev0.dist-info}/METADATA +1 -1
  6. {regula_documentreader_webclient-8.1.342.dev0.dist-info → regula_documentreader_webclient-8.1.344.dev0.dist-info}/RECORD +8 -8
  7. {regula_documentreader_webclient-8.1.342.dev0.dist-info → regula_documentreader_webclient-8.1.344.dev0.dist-info}/WHEEL +0 -0
  8. {regula_documentreader_webclient-8.1.342.dev0.dist-info → regula_documentreader_webclient-8.1.344.dev0.dist-info}/top_level.txt +0 -0
regula/documentreader/webclient/gen/models/chosen_document_type.py CHANGED
@@ -21,12 +21,12 @@ class ChosenDocumentType(BaseModel):
21
21
  """
22
22
  Contains information about one document type candidate
23
23
  """ # noqa: E501
24
- document_name: StrictStr = Field(description="Document name", alias="DocumentName")
24
+ document_name: Optional[StrictStr] = Field(default=None, description="Document name", alias="DocumentName")
25
25
  id: StrictInt = Field(description="Unique document type template identifier (Regula's internal numeric code)", alias="ID")
26
26
  p: Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]] = Field(description="A measure of the likelihood of correct recognition in the analysis of this type of document", alias="P")
27
27
  rotated180: StrictInt = Field(description="true if the document of the given type is rotated by 180 degrees", alias="Rotated180")
28
28
  rfid_presence: RfidLocation = Field(alias="RFID_Presence")
29
- fdsid_list: FDSIDList = Field(alias="FDSIDList")
29
+ fdsid_list: Optional[FDSIDList] = Field(default=None, alias="FDSIDList")
30
30
  necessary_lights: StrictInt = Field(description="Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document", alias="NecessaryLights")
31
31
  check_authenticity: StrictInt = Field(description="Set of authentication options provided for this type of document (combination of Authenticity enum)", alias="CheckAuthenticity")
32
32
  uv_exp: StrictInt = Field(description="The required exposure value of the camera when receiving images of a document of this type for a UV lighting scheme", alias="UVExp")
regula/documentreader/webclient/gen/models/one_candidate.py CHANGED
@@ -21,12 +21,12 @@ class OneCandidate(BaseModel):
21
21
  """
22
22
  Contains information about one document type candidate
23
23
  """ # noqa: E501
24
- document_name: StrictStr = Field(description="Document name", alias="DocumentName")
24
+ document_name: Optional[StrictStr] = Field(default=None, description="Document name", alias="DocumentName")
25
25
  id: StrictInt = Field(description="Unique document type template identifier (Regula's internal numeric code)", alias="ID")
26
26
  p: Union[Annotated[float, Field(le=1, strict=True, ge=0)], Annotated[int, Field(le=1, strict=True, ge=0)]] = Field(description="A measure of the likelihood of correct recognition in the analysis of this type of document", alias="P")
27
27
  rotated180: StrictInt = Field(description="true if the document of the given type is rotated by 180 degrees", alias="Rotated180")
28
28
  rfid_presence: RfidLocation = Field(alias="RFID_Presence")
29
- fdsid_list: FDSIDList = Field(alias="FDSIDList")
29
+ fdsid_list: Optional[FDSIDList] = Field(default=None, alias="FDSIDList")
30
30
  necessary_lights: StrictInt = Field(description="Combination of lighting scheme identifiers (Light enum) required to conduct OCR for this type of document", alias="NecessaryLights")
31
31
  check_authenticity: StrictInt = Field(description="Set of authentication options provided for this type of document (combination of Authenticity enum)", alias="CheckAuthenticity")
32
32
  uv_exp: StrictInt = Field(description="The required exposure value of the camera when receiving images of a document of this type for a UV lighting scheme", alias="UVExp")
regula/documentreader/webclient/gen/models/process_params.py CHANGED
@@ -98,7 +98,8 @@ class ProcessParams(BaseModel):
98
98
  do_barcodes: Optional[List[InputBarcodeType]] = Field(default=None, description="Set the types of barcodes to process.", alias="doBarcodes")
99
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
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
- __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"]
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"]
102
103
 
103
104
  model_config = ConfigDict(
104
105
  populate_by_name=True,
@@ -231,7 +232,8 @@ class ProcessParams(BaseModel):
231
232
  "selectLongestNames": obj.get("selectLongestNames"),
232
233
  "doBarcodes": obj.get("doBarcodes"),
233
234
  "strictDLCategoryExpiry": obj.get("strictDLCategoryExpiry"),
234
- "generateAlpha2Codes": obj.get("generateAlpha2Codes")
235
+ "generateAlpha2Codes": obj.get("generateAlpha2Codes"),
236
+ "pdfPagesLimit": obj.get("pdfPagesLimit")
235
237
  })
236
238
  return _obj
237
239
 
regula/documentreader/webclient/gen/models/text_field_type.py CHANGED
@@ -662,6 +662,9 @@ class TextFieldType(int, Enum):
662
662
  EF_CARD_ACCESS = 692
663
663
  SHORT_FLIGHT_NUMBER = 693
664
664
  AIRLINE_CODE = 694
665
+ FT_MVC_AGENCY = 695
666
+ FT_ISSUING_STATE_CODE_ALPHA2 = 696
667
+ FT_NATIONALITY_CODE_ALPHA2 = 697
665
668
 
666
669
  @classmethod
667
670
  def from_json(cls, json_str: str) -> Self:
{regula_documentreader_webclient-8.1.342.dev0.dist-info → regula_documentreader_webclient-8.1.344.dev0.dist-info}/METADATA RENAMED
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: regula_documentreader_webclient
3
- Version: 8.1.342.dev0
3
+ Version: 8.1.344.dev0
4
4
  Summary: Regula's Document Reader python client
5
5
  Home-page: https://regulaforensics.com
6
6
  Author: Regula Forensics, Inc.
{regula_documentreader_webclient-8.1.342.dev0.dist-info → regula_documentreader_webclient-8.1.344.dev0.dist-info}/RECORD RENAMED
@@ -50,7 +50,7 @@ regula/documentreader/webclient/gen/models/candidates_list_item.py,sha256=JvgjJo
50
50
  regula/documentreader/webclient/gen/models/certificate_data.py,sha256=pIOvBydpWaW5i2i_1Y8oMMDQfYUUOD-BJKb8y5R4KD0,2359
51
51
  regula/documentreader/webclient/gen/models/check_diagnose.py,sha256=STU6JMh1vn2sOLKtXIynXO86mgoP-f2MqUqSSTDtoDM,5297
52
52
  regula/documentreader/webclient/gen/models/check_result.py,sha256=8dR5KtJtyeSv4sW6oyJz9HXbUF-xpeJnSDqDp5Zk1ZE,570
53
- regula/documentreader/webclient/gen/models/chosen_document_type.py,sha256=FbXQGFly5q7hI4zFP8WAmnPnLvuZZfG2MO6g7yxgcNo,5258
53
+ regula/documentreader/webclient/gen/models/chosen_document_type.py,sha256=bITTgPoUPKhG2aP-EUYka0xFlTbbmTIUWXg8DAFFD3U,5306
54
54
  regula/documentreader/webclient/gen/models/chosen_document_type_result.py,sha256=TWMYGRwS8s7OSKR1uYGKSnJveHKXQ9SSG1s-nmGaA6w,3423
55
55
  regula/documentreader/webclient/gen/models/container_list.py,sha256=6o1pmioLmB3Hnwc1Uomi0lqOGX_cZfmPOk67x3Sfmik,2944
56
56
  regula/documentreader/webclient/gen/models/container_list_list_inner.py,sha256=MEC8Ys5QytsB_aqaTRkyEbx_ag_EyB969RQb3Y7x7MQ,23195
@@ -147,7 +147,7 @@ regula/documentreader/webclient/gen/models/mrz_test_quality_item.py,sha256=N1DHf
147
147
  regula/documentreader/webclient/gen/models/mrz_test_quality_result.py,sha256=-2iqwp3CniTSHud0tPWvx_2cF4GUMaknfWq-isvnuQA,3115
148
148
  regula/documentreader/webclient/gen/models/ocr_security_text_item.py,sha256=kOScbMRyy1yqT1h71zEKJdUPCPSYuy__4rCIJkq8f6M,4668
149
149
  regula/documentreader/webclient/gen/models/ocr_security_text_result.py,sha256=tebup1He_P27Q8cE0c_hVQQlnDHUJf5B5_-rP0b9OQs,5328
150
- regula/documentreader/webclient/gen/models/one_candidate.py,sha256=YKWQ1j-zQz3zc93K8KPwuXI0WC5pEeDAeiPLPOPo-Fs,5240
150
+ regula/documentreader/webclient/gen/models/one_candidate.py,sha256=LSg-CZry1MKaBIrXcCSWhIdc2EmVSOfDQn6GREvbtIM,5288
151
151
  regula/documentreader/webclient/gen/models/one_candidate_item.py,sha256=hplvxqurTiNEtf_GkZrem5b-Su3O8tc0IyxK1qTzbLc,2876
152
152
  regula/documentreader/webclient/gen/models/original_symbol.py,sha256=PdeHzkXeYMmzt-uAYwzdF4Ky6CZ7UThPtoCoDLr3L2Q,2954
153
153
  regula/documentreader/webclient/gen/models/out_data.py,sha256=ZE0UNzLFvTWp6PdAhrIlSNV2OJ-z8BKfc3Mjwm4jjw4,2953
@@ -162,7 +162,7 @@ regula/documentreader/webclient/gen/models/photo_ident_result.py,sha256=YpDPqn36
162
162
  regula/documentreader/webclient/gen/models/point.py,sha256=_khsO-Zo2SIqXIPHQALJz4F6kB2lDqIi0Yhg7c8ImRw,2234
163
163
  regula/documentreader/webclient/gen/models/point_array.py,sha256=xcg4DqZl-oNKJt9BPyASdeGNTlPrO7G31zTMEzZkL2g,2768
164
164
  regula/documentreader/webclient/gen/models/points_container.py,sha256=6KKKe2sFAwg3d0QDWyejfQEHTqTzTE56o6MqSX5gO6A,2951
165
- regula/documentreader/webclient/gen/models/process_params.py,sha256=FiEgx5Qs2MKltIeb7zysVTMv7wBHgksvBbfFb9LQChk,23987
165
+ regula/documentreader/webclient/gen/models/process_params.py,sha256=1eCoZYT99ga6uKFLhY3oJ2WtX8UHHXBCJRgFZCPmuPE,24220
166
166
  regula/documentreader/webclient/gen/models/process_params_rfid.py,sha256=YzSY3dormyWNln3ispy5G4j_7yhNhWJgKQpT45_ad5k,2646
167
167
  regula/documentreader/webclient/gen/models/process_request.py,sha256=SC4zwX2P9A9VjLe7tGXhUvx5Z3mzmsgJOWZAUocZ4JI,6129
168
168
  regula/documentreader/webclient/gen/models/process_request_image.py,sha256=yA0hfvr-KGBGFyR97fQZsAkDX3mh4XZEVsWDXiOLTPQ,2948
@@ -239,7 +239,7 @@ regula/documentreader/webclient/gen/models/text.py,sha256=jcZC10tDY7UcLdRiWudNbV
239
239
  regula/documentreader/webclient/gen/models/text_available_source.py,sha256=YHMlmffXw5IDvCWpcUNyQX2qRD4VJb6A8DHcQn32AT4,2865
240
240
  regula/documentreader/webclient/gen/models/text_data_result.py,sha256=cyj9qz-a7Zix4IvLeG8s2W_q8ZcU6fDwx81nLJvk7uA,3287
241
241
  regula/documentreader/webclient/gen/models/text_field.py,sha256=_5DNjKJIjWETy2p_5hiJKbjT7Omz8xkms_7QG_dSgrg,5818
242
- regula/documentreader/webclient/gen/models/text_field_type.py,sha256=OzFZEvxLDycv365Ek7lIy95dG6FoVRp5yRbKXQq7tiQ,18950
242
+ regula/documentreader/webclient/gen/models/text_field_type.py,sha256=REEN6t_L284LQPa4tjtDPD-h7vltslO2K33Rv4uTOA0,19050
243
243
  regula/documentreader/webclient/gen/models/text_field_value.py,sha256=pWDnK_OSe-ATajswffGXeRMHuAUEeD27isreMMwIraA,5416
244
244
  regula/documentreader/webclient/gen/models/text_item.py,sha256=9Xh5TzppN6Te4w6Z91DNvEuFR1FZ3SVo04FrCD_U_Jc,2489
245
245
  regula/documentreader/webclient/gen/models/text_post_processing.py,sha256=EFF0vw50SRGvfqq2YGaL0aPdedViOTG5HDwnix_Od8U,550
@@ -257,7 +257,7 @@ regula/documentreader/webclient/gen/models/verification_result.py,sha256=E6bCVR5
257
257
  regula/documentreader/webclient/gen/models/verified_field_map.py,sha256=sOnkL-c9WIJPHcUjT5_KzxMiVZK574iOBppANc7zRSs,4861
258
258
  regula/documentreader/webclient/gen/models/visibility.py,sha256=GACgQd_8lx_cwMwI5lCi7cTxEWxw2atbJo6uI4mTKpQ,602
259
259
  regula/documentreader/webclient/gen/models/visual_extended_field_item.py,sha256=55PY8Wwn1Nh0msc-ynPZqlkmc6QwsghIy9-ICqvbRcA,5040
260
- regula_documentreader_webclient-8.1.342.dev0.dist-info/METADATA,sha256=HcqqomasxhMouFD0eMSYriCZ_AuhewkTzFFxDSSgOcw,3805
261
- regula_documentreader_webclient-8.1.342.dev0.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
262
- regula_documentreader_webclient-8.1.342.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
263
- regula_documentreader_webclient-8.1.342.dev0.dist-info/RECORD,,
260
+ regula_documentreader_webclient-8.1.344.dev0.dist-info/METADATA,sha256=ELqfIAZEjIkhY4YM7nBBN6FSNSkeEVvuEouzq5R8u78,3805
261
+ regula_documentreader_webclient-8.1.344.dev0.dist-info/WHEEL,sha256=uCRv0ZEik_232NlR4YDw4Pv3Ajt5bKvMH13NUU7hFuI,91
262
+ regula_documentreader_webclient-8.1.344.dev0.dist-info/top_level.txt,sha256=SFSSVn4j8QDivd3307s97NtpIJ8zOjiWZloAxZIClJY,7
263
+ regula_documentreader_webclient-8.1.344.dev0.dist-info/RECORD,,