Regenerate models from latest definitions

Author: hleb-albau

.openapi-generator/FILES

@@ -17,6 +17,8 @@ regula/documentreader/webclient/gen/models/details_rfid.py
 regula/documentreader/webclient/gen/models/doc_visual_extended_field.py
 regula/documentreader/webclient/gen/models/doc_visual_extended_info.py
 regula/documentreader/webclient/gen/models/document_format.py
+regula/documentreader/webclient/gen/models/document_image_result.py
+regula/documentreader/webclient/gen/models/document_image_result_all_of.py
 regula/documentreader/webclient/gen/models/document_type.py
 regula/documentreader/webclient/gen/models/document_type_recognition_result.py
 regula/documentreader/webclient/gen/models/document_types_candidates_list.py
@@ -47,8 +49,6 @@ regula/documentreader/webclient/gen/models/process_request_image.py
 regula/documentreader/webclient/gen/models/process_response.py
 regula/documentreader/webclient/gen/models/process_system_info.py
 regula/documentreader/webclient/gen/models/processing_status.py
-regula/documentreader/webclient/gen/models/raw_image_result.py
-regula/documentreader/webclient/gen/models/raw_image_result_all_of.py
 regula/documentreader/webclient/gen/models/rectangle_coordinates.py
 regula/documentreader/webclient/gen/models/result.py
 regula/documentreader/webclient/gen/models/result_item.py

Pipfile.lock

@@ -39,6 +39,8 @@
 from regula.documentreader.webclient.gen.models.doc_visual_extended_field import DocVisualExtendedField
 from regula.documentreader.webclient.gen.models.doc_visual_extended_info import DocVisualExtendedInfo
 from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
+from regula.documentreader.webclient.gen.models.document_image_result import DocumentImageResult
+from regula.documentreader.webclient.gen.models.document_image_result_all_of import DocumentImageResultAllOf
 from regula.documentreader.webclient.gen.models.document_type import DocumentType
 from regula.documentreader.webclient.gen.models.document_type_recognition_result import DocumentTypeRecognitionResult
 from regula.documentreader.webclient.gen.models.document_types_candidates_list import DocumentTypesCandidatesList
@@ -69,8 +71,6 @@
 from regula.documentreader.webclient.gen.models.process_response import ProcessResponse
 from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
 from regula.documentreader.webclient.gen.models.processing_status import ProcessingStatus
-from regula.documentreader.webclient.gen.models.raw_image_result import RawImageResult
-from regula.documentreader.webclient.gen.models.raw_image_result_all_of import RawImageResultAllOf
 from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
 from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem

example/Pipfile.lock

@@ -24,6 +24,8 @@
 from regula.documentreader.webclient.gen.models.doc_visual_extended_field import DocVisualExtendedField
 from regula.documentreader.webclient.gen.models.doc_visual_extended_info import DocVisualExtendedInfo
 from regula.documentreader.webclient.gen.models.document_format import DocumentFormat
+from regula.documentreader.webclient.gen.models.document_image_result import DocumentImageResult
+from regula.documentreader.webclient.gen.models.document_image_result_all_of import DocumentImageResultAllOf
 from regula.documentreader.webclient.gen.models.document_type import DocumentType
 from regula.documentreader.webclient.gen.models.document_type_recognition_result import DocumentTypeRecognitionResult
 from regula.documentreader.webclient.gen.models.document_types_candidates_list import DocumentTypesCandidatesList
@@ -54,8 +56,6 @@
 from regula.documentreader.webclient.gen.models.process_response import ProcessResponse
 from regula.documentreader.webclient.gen.models.process_system_info import ProcessSystemInfo
 from regula.documentreader.webclient.gen.models.processing_status import ProcessingStatus
-from regula.documentreader.webclient.gen.models.raw_image_result import RawImageResult
-from regula.documentreader.webclient.gen.models.raw_image_result_all_of import RawImageResultAllOf
 from regula.documentreader.webclient.gen.models.rectangle_coordinates import RectangleCoordinates
 from regula.documentreader.webclient.gen.models.result import Result
 from regula.documentreader.webclient.gen.models.result_item import ResultItem

regula/documentreader/webclient/ext/models/images.py

@@ -20,7 +20,7 @@
 from regula.documentreader.webclient.gen.models import *
 
 
-class RawImageResult(object):
+class DocumentImageResult(object):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -53,7 +53,7 @@ class RawImageResult(object):
     }
 
     def __init__(self, buf_length=None, light=None, list_idx=None, page_idx=None, result_type=None, raw_image_container=None, local_vars_configuration=None):  # noqa: E501
-        """RawImageResult - a model defined in OpenAPI"""  # noqa: E501
+        """DocumentImageResult - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
         self.local_vars_configuration = local_vars_configuration
@@ -79,106 +79,106 @@ def __init__(self, buf_length=None, light=None, list_idx=None, page_idx=None, re
 
     @property
     def buf_length(self):
-        """Gets the buf_length of this RawImageResult.  # noqa: E501
+        """Gets the buf_length of this DocumentImageResult.  # noqa: E501
 
 
-        :return: The buf_length of this RawImageResult.  # noqa: E501
+        :return: The buf_length of this DocumentImageResult.  # noqa: E501
         :rtype: int
         """
         return self._buf_length
 
     @buf_length.setter
     def buf_length(self, buf_length):
-        """Sets the buf_length of this RawImageResult.
+        """Sets the buf_length of this DocumentImageResult.
 
 
-        :param buf_length: The buf_length of this RawImageResult.  # noqa: E501
+        :param buf_length: The buf_length of this DocumentImageResult.  # noqa: E501
         :type buf_length: int
         """
 
         self._buf_length = buf_length
 
     @property
     def light(self):
-        """Gets the light of this RawImageResult.  # noqa: E501
+        """Gets the light of this DocumentImageResult.  # noqa: E501
 
 
-        :return: The light of this RawImageResult.  # noqa: E501
+        :return: The light of this DocumentImageResult.  # noqa: E501
         :rtype: int
         """
         return self._light
 
     @light.setter
     def light(self, light):
-        """Sets the light of this RawImageResult.
+        """Sets the light of this DocumentImageResult.
 
 
-        :param light: The light of this RawImageResult.  # noqa: E501
+        :param light: The light of this DocumentImageResult.  # noqa: E501
         :type light: int
         """
 
         self._light = light
 
     @property
     def list_idx(self):
-        """Gets the list_idx of this RawImageResult.  # noqa: E501
+        """Gets the list_idx of this DocumentImageResult.  # noqa: E501
 
 
-        :return: The list_idx of this RawImageResult.  # noqa: E501
+        :return: The list_idx of this DocumentImageResult.  # noqa: E501
         :rtype: int
         """
         return self._list_idx
 
     @list_idx.setter
     def list_idx(self, list_idx):
-        """Sets the list_idx of this RawImageResult.
+        """Sets the list_idx of this DocumentImageResult.
 
 
-        :param list_idx: The list_idx of this RawImageResult.  # noqa: E501
+        :param list_idx: The list_idx of this DocumentImageResult.  # noqa: E501
         :type list_idx: int
         """
 
         self._list_idx = list_idx
 
     @property
     def page_idx(self):
-        """Gets the page_idx of this RawImageResult.  # noqa: E501
+        """Gets the page_idx of this DocumentImageResult.  # noqa: E501
 
 
-        :return: The page_idx of this RawImageResult.  # noqa: E501
+        :return: The page_idx of this DocumentImageResult.  # noqa: E501
         :rtype: int
         """
         return self._page_idx
 
     @page_idx.setter
     def page_idx(self, page_idx):
-        """Sets the page_idx of this RawImageResult.
+        """Sets the page_idx of this DocumentImageResult.
 
 
-        :param page_idx: The page_idx of this RawImageResult.  # noqa: E501
+        :param page_idx: The page_idx of this DocumentImageResult.  # noqa: E501
         :type page_idx: int
         """
 
         self._page_idx = page_idx
 
     @property
     def result_type(self):
-        """Gets the result_type of this RawImageResult.  # noqa: E501
+        """Gets the result_type of this DocumentImageResult.  # noqa: E501
 
         Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
 
-        :return: The result_type of this RawImageResult.  # noqa: E501
+        :return: The result_type of this DocumentImageResult.  # noqa: E501
         :rtype: int
         """
         return self._result_type
 
     @result_type.setter
     def result_type(self, result_type):
-        """Sets the result_type of this RawImageResult.
+        """Sets the result_type of this DocumentImageResult.
 
         Same as Result type, but used for safe parsing of not-described values. See Result type.  # noqa: E501
 
-        :param result_type: The result_type of this RawImageResult.  # noqa: E501
+        :param result_type: The result_type of this DocumentImageResult.  # noqa: E501
         :type result_type: int
         """
         if self.local_vars_configuration.client_side_validation and result_type is None:  # noqa: E501
@@ -188,20 +188,20 @@ def result_type(self, result_type):
 
     @property
     def raw_image_container(self):
-        """Gets the raw_image_container of this RawImageResult.  # noqa: E501
+        """Gets the raw_image_container of this DocumentImageResult.  # noqa: E501
 
 
-        :return: The raw_image_container of this RawImageResult.  # noqa: E501
+        :return: The raw_image_container of this DocumentImageResult.  # noqa: E501
         :rtype: ImageData
         """
         return self._raw_image_container
 
     @raw_image_container.setter
     def raw_image_container(self, raw_image_container):
-        """Sets the raw_image_container of this RawImageResult.
+        """Sets the raw_image_container of this DocumentImageResult.
 
 
-        :param raw_image_container: The raw_image_container of this RawImageResult.  # noqa: E501
+        :param raw_image_container: The raw_image_container of this DocumentImageResult.  # noqa: E501
         :type raw_image_container: ImageData
         """
         if self.local_vars_configuration.client_side_validation and raw_image_container is None:  # noqa: E501
@@ -243,14 +243,14 @@ def __repr__(self):
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, RawImageResult):
+        if not isinstance(other, DocumentImageResult):
             return False
 
         return self.to_dict() == other.to_dict()
 
     def __ne__(self, other):
         """Returns true if both objects are not equal"""
-        if not isinstance(other, RawImageResult):
+        if not isinstance(other, DocumentImageResult):
             return True
 
         return self.to_dict() != other.to_dict()

regula/documentreader/webclient/gen/__init__.py

@@ -20,7 +20,7 @@
 from regula.documentreader.webclient.gen.models import *
 
 
-class RawImageResultAllOf(object):
+class DocumentImageResultAllOf(object):
     """NOTE: This class is auto generated by OpenAPI Generator.
     Ref: https://openapi-generator.tech
 
@@ -43,7 +43,7 @@ class RawImageResultAllOf(object):
     }
 
     def __init__(self, raw_image_container=None, local_vars_configuration=None):  # noqa: E501
-        """RawImageResultAllOf - a model defined in OpenAPI"""  # noqa: E501
+        """DocumentImageResultAllOf - a model defined in OpenAPI"""  # noqa: E501
         if local_vars_configuration is None:
             local_vars_configuration = Configuration()
         self.local_vars_configuration = local_vars_configuration
@@ -55,20 +55,20 @@ def __init__(self, raw_image_container=None, local_vars_configuration=None):  #
 
     @property
     def raw_image_container(self):
-        """Gets the raw_image_container of this RawImageResultAllOf.  # noqa: E501
+        """Gets the raw_image_container of this DocumentImageResultAllOf.  # noqa: E501
 
 
-        :return: The raw_image_container of this RawImageResultAllOf.  # noqa: E501
+        :return: The raw_image_container of this DocumentImageResultAllOf.  # noqa: E501
         :rtype: ImageData
         """
         return self._raw_image_container
 
     @raw_image_container.setter
     def raw_image_container(self, raw_image_container):
-        """Sets the raw_image_container of this RawImageResultAllOf.
+        """Sets the raw_image_container of this DocumentImageResultAllOf.
 
 
-        :param raw_image_container: The raw_image_container of this RawImageResultAllOf.  # noqa: E501
+        :param raw_image_container: The raw_image_container of this DocumentImageResultAllOf.  # noqa: E501
         :type raw_image_container: ImageData
         """
         if self.local_vars_configuration.client_side_validation and raw_image_container is None:  # noqa: E501
@@ -110,14 +110,14 @@ def __repr__(self):
 
     def __eq__(self, other):
         """Returns true if both objects are equal"""
-        if not isinstance(other, RawImageResultAllOf):
+        if not isinstance(other, DocumentImageResultAllOf):
             return False
 
         return self.to_dict() == other.to_dict()
 
     def __ne__(self, other):
         """Returns true if both objects are not equal"""
-        if not isinstance(other, RawImageResultAllOf):
+        if not isinstance(other, DocumentImageResultAllOf):
             return True
 
         return self.to_dict() != other.to_dict()

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

@@ -27,8 +27,8 @@ class Result(object):
     Do not edit the class manually.
     """
 
-    "Contains cropped and rotated image of document. Most of coordinates in other types defined on that image"
-    RAW_IMAGE = int("1")
+    "Contains cropped and rotated with perspective compensation image of document. Single input image can contain multiple document side/pages, which will be returned as separated results. Most of coordinates in other types defined on that image"
+    DOCUMENT_IMAGE = int("1")
 
     "Contains check statuses with details, grouped by source"
     STATUS = int("33")
@@ -69,7 +69,7 @@ class Result(object):
     "Contains description of determined document type, if any"
     DOCUMENT_TYPE = int("9")
 
-    allowable_values = [RAW_IMAGE, STATUS, TEXT, IMAGES, MRZ_TEXT, VISUAL_TEXT, BARCODE_TEXT, RFID_TEXT, LEXICAL_ANALYSIS, VISUAL_GRAPHICS, BARCODE_GRAPHICS, RFID_GRAPHICS, DOCUMENT_TYPE_CANDIDATES, DOCUMENT_TYPE]  # noqa: E501
+    allowable_values = [DOCUMENT_IMAGE, STATUS, TEXT, IMAGES, MRZ_TEXT, VISUAL_TEXT, BARCODE_TEXT, RFID_TEXT, LEXICAL_ANALYSIS, VISUAL_GRAPHICS, BARCODE_GRAPHICS, RFID_GRAPHICS, DOCUMENT_TYPE_CANDIDATES, DOCUMENT_TYPE]  # noqa: E501
 
     """
     Attributes:

…webclient/gen/models/raw_image_result.py …ient/gen/models/document_image_result.pyregula/documentreader/webclient/gen/models/raw_image_result.py renamed to regula/documentreader/webclient/gen/models/document_image_result.py regula/documentreader/webclient/gen/models/raw_image_result.py renamed to regula/documentreader/webclient/gen/models/document_image_result.py

@@ -50,7 +50,7 @@ class ResultItem(object):
         'result_type': 'result_type'
     }
     discriminator_value_class_map = {
-        1 : 'RawImageResult',
+        1 : 'DocumentImageResult',
         3 : 'TextDataResult',
         6 : 'GraphicsResult',
         8 : 'DocumentTypesCandidatesResult',