docusign_esign.models.ocr_request

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
  7
  8    OpenAPI spec version: v2.1
  9    Contact: devcenter@docusign.com
 10    Generated by: https://github.com/swagger-api/swagger-codegen.git
 11"""
 12
 13
 14from pprint import pformat
 15from six import iteritems
 16import re
 17
 18
 19class OcrRequest(object):
 20    """
 21    NOTE: This class is auto generated by the swagger code generator program.
 22    Do not edit the class manually.
 23    """
 24    def __init__(self, ocr_language=None, page_selection=None, set_page_orientation=None, show_frames=None, show_text=None, skip_pages_having_existing_extractable_text=None):
 25        """
 26        OcrRequest - a model defined in Swagger
 27
 28        :param dict swaggerTypes: The key is attribute name
 29                                  and the value is attribute type.
 30        :param dict attributeMap: The key is attribute name
 31                                  and the value is json key in definition.
 32        """
 33        self.swagger_types = {
 34            'ocr_language': 'str',
 35            'page_selection': 'str',
 36            'set_page_orientation': 'str',
 37            'show_frames': 'str',
 38            'show_text': 'str',
 39            'skip_pages_having_existing_extractable_text': 'str'
 40        }
 41
 42        self.attribute_map = {
 43            'ocr_language': 'ocrLanguage',
 44            'page_selection': 'pageSelection',
 45            'set_page_orientation': 'setPageOrientation',
 46            'show_frames': 'showFrames',
 47            'show_text': 'showText',
 48            'skip_pages_having_existing_extractable_text': 'skipPagesHavingExistingExtractableText'
 49        }
 50
 51        self._ocr_language = ocr_language
 52        self._page_selection = page_selection
 53        self._set_page_orientation = set_page_orientation
 54        self._show_frames = show_frames
 55        self._show_text = show_text
 56        self._skip_pages_having_existing_extractable_text = skip_pages_having_existing_extractable_text
 57
 58    @property
 59    def ocr_language(self):
 60        """
 61        Gets the ocr_language of this OcrRequest.
 62        
 63
 64        :return: The ocr_language of this OcrRequest.
 65        :rtype: str
 66        """
 67        return self._ocr_language
 68
 69    @ocr_language.setter
 70    def ocr_language(self, ocr_language):
 71        """
 72        Sets the ocr_language of this OcrRequest.
 73        
 74
 75        :param ocr_language: The ocr_language of this OcrRequest.
 76        :type: str
 77        """
 78
 79        self._ocr_language = ocr_language
 80
 81    @property
 82    def page_selection(self):
 83        """
 84        Gets the page_selection of this OcrRequest.
 85        
 86
 87        :return: The page_selection of this OcrRequest.
 88        :rtype: str
 89        """
 90        return self._page_selection
 91
 92    @page_selection.setter
 93    def page_selection(self, page_selection):
 94        """
 95        Sets the page_selection of this OcrRequest.
 96        
 97
 98        :param page_selection: The page_selection of this OcrRequest.
 99        :type: str
100        """
101
102        self._page_selection = page_selection
103
104    @property
105    def set_page_orientation(self):
106        """
107        Gets the set_page_orientation of this OcrRequest.
108        
109
110        :return: The set_page_orientation of this OcrRequest.
111        :rtype: str
112        """
113        return self._set_page_orientation
114
115    @set_page_orientation.setter
116    def set_page_orientation(self, set_page_orientation):
117        """
118        Sets the set_page_orientation of this OcrRequest.
119        
120
121        :param set_page_orientation: The set_page_orientation of this OcrRequest.
122        :type: str
123        """
124
125        self._set_page_orientation = set_page_orientation
126
127    @property
128    def show_frames(self):
129        """
130        Gets the show_frames of this OcrRequest.
131        
132
133        :return: The show_frames of this OcrRequest.
134        :rtype: str
135        """
136        return self._show_frames
137
138    @show_frames.setter
139    def show_frames(self, show_frames):
140        """
141        Sets the show_frames of this OcrRequest.
142        
143
144        :param show_frames: The show_frames of this OcrRequest.
145        :type: str
146        """
147
148        self._show_frames = show_frames
149
150    @property
151    def show_text(self):
152        """
153        Gets the show_text of this OcrRequest.
154        
155
156        :return: The show_text of this OcrRequest.
157        :rtype: str
158        """
159        return self._show_text
160
161    @show_text.setter
162    def show_text(self, show_text):
163        """
164        Sets the show_text of this OcrRequest.
165        
166
167        :param show_text: The show_text of this OcrRequest.
168        :type: str
169        """
170
171        self._show_text = show_text
172
173    @property
174    def skip_pages_having_existing_extractable_text(self):
175        """
176        Gets the skip_pages_having_existing_extractable_text of this OcrRequest.
177        
178
179        :return: The skip_pages_having_existing_extractable_text of this OcrRequest.
180        :rtype: str
181        """
182        return self._skip_pages_having_existing_extractable_text
183
184    @skip_pages_having_existing_extractable_text.setter
185    def skip_pages_having_existing_extractable_text(self, skip_pages_having_existing_extractable_text):
186        """
187        Sets the skip_pages_having_existing_extractable_text of this OcrRequest.
188        
189
190        :param skip_pages_having_existing_extractable_text: The skip_pages_having_existing_extractable_text of this OcrRequest.
191        :type: str
192        """
193
194        self._skip_pages_having_existing_extractable_text = skip_pages_having_existing_extractable_text
195
196    def to_dict(self):
197        """
198        Returns the model properties as a dict
199        """
200        result = {}
201
202        for attr, _ in iteritems(self.swagger_types):
203            value = getattr(self, attr)
204            if isinstance(value, list):
205                result[attr] = list(map(
206                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
207                    value
208                ))
209            elif hasattr(value, "to_dict"):
210                result[attr] = value.to_dict()
211            elif isinstance(value, dict):
212                result[attr] = dict(map(
213                    lambda item: (item[0], item[1].to_dict())
214                    if hasattr(item[1], "to_dict") else item,
215                    value.items()
216                ))
217            else:
218                result[attr] = value
219
220        return result
221
222    def to_str(self):
223        """
224        Returns the string representation of the model
225        """
226        return pformat(self.to_dict())
227
228    def __repr__(self):
229        """
230        For `print` and `pprint`
231        """
232        return self.to_str()
233
234    def __eq__(self, other):
235        """
236        Returns true if both objects are equal
237        """
238        return self.__dict__ == other.__dict__
239
240    def __ne__(self, other):
241        """
242        Returns true if both objects are not equal
243        """
244        return not self == other