Update models

Author: ArtsiomTsybulko

dev.md

@@ -1,7 +1,31 @@
 # Development
 
-To regenerate models, clone [latest OpenAPI definitions](https://github.com/regulaforensics/DocumentReader-web-openapi)
-and use next command from the project root:
+Models generation based on [openapi spec](https://github.com/regulaforensics/DocumentReader-api-openapi).
+
+## Generation
+
+To regenerate models from openapi definition, 
+clone [latest open api definitions](https://github.com/regulaforensics/DocumentReader-api-openapi)
+and use next command from the project root.
 ```bash
 ./update-models.sh
 ```
+
+## Generator configuration Features
+
+1. When generating oneOf schemas, the generator creates its 
+own abstract class, which does not look like it would like. 
+The problem was solved by replacing the abstract generator 
+class with ours using typeMappings in the generator config.
+2. The generator treats the discriminator value as a string, 
+but in our case it's numbers. To solve this problem, changes 
+have been made to the model_generic.mustache template.
+
+## Problem solving 
+
+To solve new problems, use the generator 
+settings ([python](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md), 
+[common](https://github.com/OpenAPITools/openapi-generator/blob/master/docs/customization.md)) 
+and [templates](https://github.com/OpenAPITools/openapi-generator/tree/master/modules/openapi-generator/src/main/resources/python).
+
+**Do not edit the generated files! They will be overwritten after generation!**

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

@@ -12,6 +12,7 @@
 from importlib import import_module
 from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional, Union
+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 typing import Optional, Set
@@ -46,7 +47,7 @@ class AuthenticityCheckResultItem(BaseModel):
     """
     Common fields for all authenticity result objects
     """ # noqa: E501
-    type: StrictInt = Field(description="Same as authenticity result type, but used for safe parsing of not-described values: https://docs.regulaforensics.com/develop/doc-reader-sdk/web-service/development/enums/authenticity-result-type/", alias="Type")
+    type: AuthenticityResultType = Field(alias="Type")
     element_result: Optional[CheckResult] = Field(default=None, alias="ElementResult")
     element_diagnose: Optional[CheckDiagnose] = Field(default=None, alias="ElementDiagnose")
     percent_value: Optional[StrictInt] = Field(default=None, alias="PercentValue")

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

@@ -12,6 +12,7 @@
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from regula.documentreader.webclient.gen.models.authenticity_check_list import AuthenticityCheckList
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -81,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "AuthenticityCheckList": AuthenticityCheckList.from_dict(obj["AuthenticityCheckList"]) if obj.get("AuthenticityCheckList") is not None else None
         })
         return _obj

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

@@ -11,6 +11,7 @@
 
 from pydantic import ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -77,7 +78,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "ByteArray": obj.get("ByteArray")
         })
         return _obj

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

@@ -12,6 +12,7 @@
 from pydantic import ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from regula.documentreader.webclient.gen.models.one_candidate import OneCandidate
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -84,7 +85,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "OneCandidate": OneCandidate.from_dict(obj["OneCandidate"]) if obj.get("OneCandidate") is not None else None,
             "XML_buffer": obj.get("XML_buffer")
         })

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

@@ -12,6 +12,7 @@
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from regula.documentreader.webclient.gen.models.doc_bar_code_info_fields_list import DocBarCodeInfoFieldsList
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -81,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "DocBarCodeInfo": DocBarCodeInfoFieldsList.from_dict(obj["DocBarCodeInfo"]) if obj.get("DocBarCodeInfo") is not None else None
         })
         return _obj

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

@@ -11,6 +11,7 @@
 
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from regula.documentreader.webclient.gen.models.t_doc_binary_info import TDocBinaryInfo
 from typing import Optional, Set
@@ -81,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "TDocBinaryInfo": TDocBinaryInfo.from_dict(obj["TDocBinaryInfo"]) if obj.get("TDocBinaryInfo") is not None else None
         })
         return _obj

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

@@ -12,6 +12,7 @@
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from regula.documentreader.webclient.gen.models.image_data import ImageData
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -81,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "RawImageContainer": ImageData.from_dict(obj["RawImageContainer"]) if obj.get("RawImageContainer") is not None else None
         })
         return _obj

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

@@ -12,6 +12,7 @@
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List
 from regula.documentreader.webclient.gen.models.document_position import DocumentPosition
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -81,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "DocumentPosition": DocumentPosition.from_dict(obj["DocumentPosition"]) if obj.get("DocumentPosition") is not None else None
         })
         return _obj

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

@@ -12,6 +12,7 @@
 from pydantic import ConfigDict, Field
 from typing import Any, ClassVar, Dict, List, Optional
 from regula.documentreader.webclient.gen.models.document_types_candidates_list import DocumentTypesCandidatesList
+from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem
 from typing import Optional, Set
 from typing_extensions import Self
@@ -81,7 +82,7 @@ def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
             "light": obj.get("light"),
             "list_idx": obj.get("list_idx"),
             "page_idx": obj.get("page_idx"),
-            "result_type": obj.get("result_type") if obj.get("result_type") is not None else 0,
+            "result_type": obj.get("result_type"),
             "CandidatesList": DocumentTypesCandidatesList.from_dict(obj["CandidatesList"]) if obj.get("CandidatesList") is not None else None
         })
         return _obj