Skip to content

Commit

Permalink
add class descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@hleb-albau
hleb-albau committed Feb 24, 2021
1 parent a943f64 commit 6fa94cb
Show file tree
Hide file tree
Showing 101 changed files with 428 additions and 1,154 deletions.
2 changes: 2 additions & 0 deletions .openapi-generator/FILES
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ regula/documentreader/webclient/gen/models/authenticity_check_list.py
regula/documentreader/webclient/gen/models/authenticity_check_result_item.py
regula/documentreader/webclient/gen/models/authenticity_result.py
regula/documentreader/webclient/gen/models/authenticity_result_all_of.py
regula/documentreader/webclient/gen/models/authenticity_result_type.py
regula/documentreader/webclient/gen/models/check_diagnose.py
regula/documentreader/webclient/gen/models/check_result.py
regula/documentreader/webclient/gen/models/chosen_document_type.py
Expand Down Expand Up @@ -58,6 +59,7 @@ regula/documentreader/webclient/gen/models/lexical_analysis_result.py
regula/documentreader/webclient/gen/models/lexical_analysis_result_all_of.py
regula/documentreader/webclient/gen/models/light.py
regula/documentreader/webclient/gen/models/list_verified_fields.py
regula/documentreader/webclient/gen/models/measure_system.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
Expand Down
4 changes: 3 additions & 1 deletion generator-templates/model.mustache
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,14 +14,16 @@ from {{packageName}}.models import *

{{#models}}
{{#model}}
"""
{{unescapedDescription}}
"""
class {{classname}}(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech

Do not edit the class manually.
"""
{{#allowableValues}}{{#enumVars}}
"{{enumDescription}}"
{{#model.isString}}{{name}} = {{{value}}}{{/model.isString}}{{^model.isString}}{{name}} = int({{{value}}}){{/model.isString}}
{{/enumVars}}{{/allowableValues}}
{{#allowableValues}}
Expand Down
2 changes: 2 additions & 0 deletions regula/documentreader/webclient/gen/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
from regula.documentreader.webclient.gen.models.authenticity_result_all_of import AuthenticityResultAllOf
from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
from regula.documentreader.webclient.gen.models.check_diagnose import CheckDiagnose
from regula.documentreader.webclient.gen.models.check_result import CheckResult
from regula.documentreader.webclient.gen.models.chosen_document_type import ChosenDocumentType
Expand Down Expand Up @@ -76,6 +77,7 @@
from regula.documentreader.webclient.gen.models.lexical_analysis_result_all_of import LexicalAnalysisResultAllOf
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.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
from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
Expand Down
2 changes: 1 addition & 1 deletion regula/documentreader/webclient/gen/configuration.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -374,7 +374,7 @@ def to_debug_report(self):
return "Python SDK Debug Report:\n"\
"OS: {env}\n"\
"Python Version: {pyversion}\n"\
"Version of the API: 5.4.0\n"\
"Version of the API: 5.5.0\n"\
"SDK Package Version: 1.0.0".\
format(env=sys.platform, pyversion=sys.version)

Expand Down
2 changes: 2 additions & 0 deletions regula/documentreader/webclient/gen/models/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@
from regula.documentreader.webclient.gen.models.authenticity_check_result_item import AuthenticityCheckResultItem
from regula.documentreader.webclient.gen.models.authenticity_result import AuthenticityResult
from regula.documentreader.webclient.gen.models.authenticity_result_all_of import AuthenticityResultAllOf
from regula.documentreader.webclient.gen.models.authenticity_result_type import AuthenticityResultType
from regula.documentreader.webclient.gen.models.check_diagnose import CheckDiagnose
from regula.documentreader.webclient.gen.models.check_result import CheckResult
from regula.documentreader.webclient.gen.models.chosen_document_type import ChosenDocumentType
Expand Down Expand Up @@ -60,6 +61,7 @@
from regula.documentreader.webclient.gen.models.lexical_analysis_result_all_of import LexicalAnalysisResultAllOf
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.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
from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
Expand Down
3 changes: 3 additions & 0 deletions regula/documentreader/webclient/gen/models/area_container.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
from regula.documentreader.webclient.gen.models import *


"""
Checked fragment coordinates
"""
class AreaContainer(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Expand Down
3 changes: 3 additions & 0 deletions regula/documentreader/webclient/gen/models/authenticity_check_list.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
from regula.documentreader.webclient.gen.models import *


"""
"""
class AuthenticityCheckList(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Expand Down
3 changes: 3 additions & 0 deletions regula/documentreader/webclient/gen/models/authenticity_check_result_item.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
from regula.documentreader.webclient.gen.models import *


"""
Common fields for all authenticity result objects
"""
class AuthenticityCheckResultItem(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Expand Down
3 changes: 3 additions & 0 deletions regula/documentreader/webclient/gen/models/authenticity_result.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
from regula.documentreader.webclient.gen.models import *


"""
"""
class AuthenticityResult(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Expand Down
3 changes: 3 additions & 0 deletions regula/documentreader/webclient/gen/models/authenticity_result_all_of.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,9 @@
from regula.documentreader.webclient.gen.models import *


"""
"""
class AuthenticityResultAllOf(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Expand Down
82 changes: 3 additions & 79 deletions regula/documentreader/webclient/gen/models/check_diagnose.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -14,248 +14,172 @@
from regula.documentreader.webclient.gen.models import *


"""
Enumeration contains identifiers which determinate the single document element authenticity check outcome reason
"""
class CheckDiagnose(object):
"""NOTE: This class is auto generated by OpenAPI Generator.
Ref: https://openapi-generator.tech
Do not edit the class manually.
"""

""
UNKNOWN = int("0")

""
PASS = int("1")

""
INVALID_INPUT_DATA = int("2")

""
INTERNAL_ERROR = int("3")

""
EXCEPTION_IN_MODULE = int("4")

""
UNCERTAIN_VERIFICATION = int("5")

""
NECESSARY_IMAGE_NOT_FOUND = int("7")

""
PHOTO_SIDES_NOT_FOUND = int("8")

""
INVALID_CHECKSUM = int("10")

""
SYNTAX_ERROR = int("11")

""
LOGIC_ERROR = int("12")

""
SOURCES_COMPARISON_ERROR = int("13")

""
FIELDS_COMPARISON_LOGIC_ERROR = int("14")

""
INVALID_FIELD_FORMAT = int("15")

""
TRUE_LUMINESCENCE_ERROR = int("20")

""
FALSE_LUMINESCENCE_ERROR = int("21")

""
FIXED_PATTERN_ERROR = int("22")

""
LOW_CONTRAST_IN_IR_LIGHT = int("23")

""
INCORRECT_BACKGROUND_LIGHT = int("24")

""
BACKGROUND_COMPARISON_ERROR = int("25")

""
INCORRECT_TEXT_COLOR = int("26")

""
PHOTO_FALSE_LUMINESCENCE = int("27")

""
TOO_MUCH_SHIFT = int("28")

""
FIBERS_NOT_FOUND = int("30")

""
TOO_MANY_OBJECTS = int("31")

""
SPECKS_IN_UV = int("33")

""
TOO_LOW_RESOLUTION = int("34")

""
INVISIBLE_ELEMENT_PRESENT = int("40")

""
VISIBLE_ELEMENT_ABSENT = int("41")

""
ELEMENT_SHOULD_BE_COLORED = int("42")

""
ELEMENT_SHOULD_BE_GRAYSCALE = int("43")

""
PHOTO_WHITE_IR_DONT_MATCH = int("44")

""
UV_DULL_PAPER_MRZ = int("50")

""
FALSE_LUMINESCENCE_IN_MRZ = int("51")

""
UV_DULL_PAPER_PHOTO = int("52")

""
UV_DULL_PAPER_BLANK = int("53")

""
UV_DULL_PAPER_ERROR = int("54")

""
FALSE_LUMINESCENCE_IN_BLANK = int("55")

""
BAD_AREA_IN_AXIAL = int("60")

""
FALSE_IP_PARAMETERS = int("65")

""
FIELD_POS_CORRECTOR_HIGHLIGHT_IR = int("80")

""
OVI_IR_INVISIBLE = int("90")

""
OVI_INSUFFICIENT_AREA = int("91")

""
OVI_COLOR_INVARIABLE = int("92")

""
OVI_BAD_COLOR_FRONT = int("93")

""
OVI_BAD_COLOR_SIDE = int("94")

""
OVI_WIDE_COLOR_SPREAD = int("95")

""
OVI_BAD_COLOR_PERCENT = int("96")

""
HOLOGRAM_ELEMENT_ABSENT = int("100")

""
HOLOGRAM_SIDE_TOP_IMAGES_ABSENT = int("101")

""
HOLOGRAM_ELEMENT_PRESENT = int("102")

""
PHOTO_PATTERN_INTERRUPTED = int("110")

""
PHOTO_PATTERN_SHIFTED = int("111")

""
PHOTO_PATTERN_DIFFERENT_COLORS = int("112")

""
PHOTO_PATTERN_IR_VISIBLE = int("113")

""
PHOTO_PATTERN_NOT_INTERSECT = int("114")

""
PHOTO_SIZE_IS_WRONG = int("115")

""
PHOTO_PATTERN_INVALID_COLOR = int("116")

""
PHOTO_PATTERN_SHIFTED_VERT = int("117")

""
PHOTO_PATTERN_PATTERN_NOT_FOUND = int("118")

""
PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS = int("119")

""
PHOTO_IS_NOT_RECTANGLE = int("120")

""
PHOTO_CORNERS_IS_WRONG = int("121")

""
TEXT_COLOR_SHOULD_BE_BLUE = int("130")

""
TEXT_COLOR_SHOULD_BE_GREEN = int("131")

""
TEXT_COLOR_SHOULD_BE_RED = int("132")

""
TEXT_SHOULD_BE_BLACK = int("133")

""
BARCODE_WAS_READ_WITH_ERRORS = int("140")

""
BARCODE_DATA_FORMAT_ERROR = int("141")

""
BARCODE_SIZE_PARAMS_ERROR = int("142")

""
NOT_ALL_BARCODES_READ = int("143")

""
PORTRAIT_COMPARISON_PORTRAITS_DIFFER = int("150")

""
PORTRAIT_COMPARISON_NO_SERVICE_REPLY = int("151")

""
PORTRAIT_COMPARISON_SERVICE_ERROR = int("152")

""
PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES = int("153")

""
PORTRAIT_COMPARISON_NO_LIVE_PHOTO = int("154")

""
PORTRAIT_COMPARISON_NO_SERVICE_LICENSE = int("155")

""
PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED = int("156")

""
LAST_DIAGNOSE_VALUE = int("157")

allowable_values = [UNKNOWN, PASS, INVALID_INPUT_DATA, INTERNAL_ERROR, EXCEPTION_IN_MODULE, UNCERTAIN_VERIFICATION, NECESSARY_IMAGE_NOT_FOUND, PHOTO_SIDES_NOT_FOUND, INVALID_CHECKSUM, SYNTAX_ERROR, LOGIC_ERROR, SOURCES_COMPARISON_ERROR, FIELDS_COMPARISON_LOGIC_ERROR, INVALID_FIELD_FORMAT, TRUE_LUMINESCENCE_ERROR, FALSE_LUMINESCENCE_ERROR, FIXED_PATTERN_ERROR, LOW_CONTRAST_IN_IR_LIGHT, INCORRECT_BACKGROUND_LIGHT, BACKGROUND_COMPARISON_ERROR, INCORRECT_TEXT_COLOR, PHOTO_FALSE_LUMINESCENCE, TOO_MUCH_SHIFT, FIBERS_NOT_FOUND, TOO_MANY_OBJECTS, SPECKS_IN_UV, TOO_LOW_RESOLUTION, INVISIBLE_ELEMENT_PRESENT, VISIBLE_ELEMENT_ABSENT, ELEMENT_SHOULD_BE_COLORED, ELEMENT_SHOULD_BE_GRAYSCALE, PHOTO_WHITE_IR_DONT_MATCH, UV_DULL_PAPER_MRZ, FALSE_LUMINESCENCE_IN_MRZ, UV_DULL_PAPER_PHOTO, UV_DULL_PAPER_BLANK, UV_DULL_PAPER_ERROR, FALSE_LUMINESCENCE_IN_BLANK, BAD_AREA_IN_AXIAL, FALSE_IP_PARAMETERS, FIELD_POS_CORRECTOR_HIGHLIGHT_IR, OVI_IR_INVISIBLE, OVI_INSUFFICIENT_AREA, OVI_COLOR_INVARIABLE, OVI_BAD_COLOR_FRONT, OVI_BAD_COLOR_SIDE, OVI_WIDE_COLOR_SPREAD, OVI_BAD_COLOR_PERCENT, HOLOGRAM_ELEMENT_ABSENT, HOLOGRAM_SIDE_TOP_IMAGES_ABSENT, HOLOGRAM_ELEMENT_PRESENT, PHOTO_PATTERN_INTERRUPTED, PHOTO_PATTERN_SHIFTED, PHOTO_PATTERN_DIFFERENT_COLORS, PHOTO_PATTERN_IR_VISIBLE, PHOTO_PATTERN_NOT_INTERSECT, PHOTO_SIZE_IS_WRONG, PHOTO_PATTERN_INVALID_COLOR, PHOTO_PATTERN_SHIFTED_VERT, PHOTO_PATTERN_PATTERN_NOT_FOUND, PHOTO_PATTERN_DIFFERENT_LINES_THICKNESS, PHOTO_IS_NOT_RECTANGLE, PHOTO_CORNERS_IS_WRONG, TEXT_COLOR_SHOULD_BE_BLUE, TEXT_COLOR_SHOULD_BE_GREEN, TEXT_COLOR_SHOULD_BE_RED, TEXT_SHOULD_BE_BLACK, BARCODE_WAS_READ_WITH_ERRORS, BARCODE_DATA_FORMAT_ERROR, BARCODE_SIZE_PARAMS_ERROR, NOT_ALL_BARCODES_READ, PORTRAIT_COMPARISON_PORTRAITS_DIFFER, PORTRAIT_COMPARISON_NO_SERVICE_REPLY, PORTRAIT_COMPARISON_SERVICE_ERROR, PORTRAIT_COMPARISON_NOT_ENOUGH_IMAGES, PORTRAIT_COMPARISON_NO_LIVE_PHOTO, PORTRAIT_COMPARISON_NO_SERVICE_LICENSE, PORTRAIT_COMPARISON_NO_PORTRAIT_DETECTED, LAST_DIAGNOSE_VALUE] # noqa: E501
Expand Down
Loading

0 comments on commit 6fa94cb

Please sign in to comment.