Skip to content

SP-22413 - update models #206

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 25, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion regula/documentreader/webclient/gen/configuration.py
Original file line number Diff line number Diff line change
Expand Up @@ -492,7 +492,7 @@ def to_debug_report(self) -> str:
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 7.6.0\n"\
"Version of the API: 8.1.0\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)

Expand Down
6 changes: 6 additions & 0 deletions regula/documentreader/webclient/gen/models/light.py
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,12 @@ class Light(int, Enum):
UVB = 1048576
WHITE_OBL = 2097152
WHITE_SPECIAL = 4194304
WHITE_UV = 134
WHITE_FULL_HOLO = 67108870
HR_LIGHT = 1073741824
HR_WHITE = 1073741830
HR_UV = 1073741952
HR_IR = 1073741848

@classmethod
def from_json(cls, json_str: str) -> Self:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ class LivenessParams(BaseModel):
check_ed: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Electronic device detection", alias="checkED")
check_black_and_white_copy: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Black and white copy check", alias="checkBlackAndWhiteCopy")
check_dynaprint: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Dynaprint check", alias="checkDynaprint")
__properties: ClassVar[List[str]] = ["checkOVI", "checkMLI", "checkHolo", "checkED", "checkBlackAndWhiteCopy", "checkDynaprint"]
check_geometry: Optional[StrictBool] = Field(default=None, description="This parameter is used to enable Geometry check", alias="checkGeometry")
__properties: ClassVar[List[str]] = ["checkOVI", "checkMLI", "checkHolo", "checkED", "checkBlackAndWhiteCopy", "checkDynaprint", "checkGeometry"]

model_config = ConfigDict(
populate_by_name=True,
Expand Down Expand Up @@ -82,7 +83,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"checkHolo": obj.get("checkHolo"),
"checkED": obj.get("checkED"),
"checkBlackAndWhiteCopy": obj.get("checkBlackAndWhiteCopy"),
"checkDynaprint": obj.get("checkDynaprint")
"checkDynaprint": obj.get("checkDynaprint"),
"checkGeometry": obj.get("checkGeometry")
})
return _obj

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,8 @@ class ProcessParams(BaseModel):
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")
do_barcodes: Optional[List[InputBarcodeType]] = Field(default=None, description="Set the types of barcodes to process.", alias="doBarcodes")
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")
__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"]
generate_alpha2_codes: Optional[StrictBool] = Field(default=None, description="Set to generate Alpha-2 codes for nationality and issuing state fields.", alias="generateAlpha2Codes")
__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"]

model_config = ConfigDict(
populate_by_name=True,
Expand Down Expand Up @@ -229,7 +230,8 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
"strictBarcodeDigitalSignatureCheck": obj.get("strictBarcodeDigitalSignatureCheck"),
"selectLongestNames": obj.get("selectLongestNames"),
"doBarcodes": obj.get("doBarcodes"),
"strictDLCategoryExpiry": obj.get("strictDLCategoryExpiry")
"strictDLCategoryExpiry": obj.get("strictDLCategoryExpiry"),
"generateAlpha2Codes": obj.get("generateAlpha2Codes")
})
return _obj

Expand Down
1 change: 1 addition & 0 deletions regula/documentreader/webclient/gen/models/scenario.py
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,7 @@ class Scenario(str, Enum):
CREDITCARD = 'CreditCard'
CAPTURE = 'Capture'
DTC = 'DTC'
RFID = 'RFID'

@classmethod
def from_json(cls, json_str: str) -> Self:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,8 @@ class SecurityFeatureType(int, Enum):
CONTACT_CHIP_CLASSIFICATION = 51
HEAD_POSITION_CHECK = 52
LIVENESS_BLACK_AND_WHITE_COPY_CHECK = 53
LIVENESS_DYNAPRINT = 54
LIVENESS_GEOMETRY_CHECK = 55

@classmethod
def from_json(cls, json_str: str) -> Self:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ class SymbolRecognitionResult(BaseModel):
"""
Describes a single character recognition results in the text field line
""" # noqa: E501
symbol_rect: RectangleCoordinates = Field(alias="SymbolRect")
symbol_rect: Optional[RectangleCoordinates] = Field(default=None, alias="SymbolRect")
candidates_count: Union[StrictFloat, StrictInt] = Field(description="Number of significant elements of ListOfCandidates array", alias="CandidatesCount")
list_of_candidates: List[SymbolCandidate] = Field(description="Array of candidate characters. Sorted in descending order of recognition probabilities (the first element has highest probability)", alias="ListOfCandidates")
base_line_bottom: Optional[StrictInt] = Field(default=None, alias="BaseLineBottom")
Expand Down