docusign_esign.models.page_images

  1# coding: utf-8
  2
  3"""
  4    Docusign eSignature REST API
  5
  6    The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign.  # noqa: E501
  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
 14import pprint
 15import re  # noqa: F401
 16
 17import six
 18
 19from docusign_esign.client.configuration import Configuration
 20
 21
 22class PageImages(object):
 23    """NOTE: This class is auto generated by the swagger code generator program.
 24
 25    Do not edit the class manually.
 26    """
 27
 28    """
 29    Attributes:
 30      swagger_types (dict): The key is attribute name
 31                            and the value is attribute type.
 32      attribute_map (dict): The key is attribute name
 33                            and the value is json key in definition.
 34    """
 35    swagger_types = {
 36        'end_position': 'str',
 37        'next_uri': 'str',
 38        'pages': 'list[Page]',
 39        'previous_uri': 'str',
 40        'result_set_size': 'str',
 41        'start_position': 'str',
 42        'total_set_size': 'str'
 43    }
 44
 45    attribute_map = {
 46        'end_position': 'endPosition',
 47        'next_uri': 'nextUri',
 48        'pages': 'pages',
 49        'previous_uri': 'previousUri',
 50        'result_set_size': 'resultSetSize',
 51        'start_position': 'startPosition',
 52        'total_set_size': 'totalSetSize'
 53    }
 54
 55    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 56        """PageImages - a model defined in Swagger"""  # noqa: E501
 57        if _configuration is None:
 58            _configuration = Configuration()
 59        self._configuration = _configuration
 60
 61        self._end_position = None
 62        self._next_uri = None
 63        self._pages = None
 64        self._previous_uri = None
 65        self._result_set_size = None
 66        self._start_position = None
 67        self._total_set_size = None
 68        self.discriminator = None
 69
 70        setattr(self, "_{}".format('end_position'), kwargs.get('end_position', None))
 71        setattr(self, "_{}".format('next_uri'), kwargs.get('next_uri', None))
 72        setattr(self, "_{}".format('pages'), kwargs.get('pages', None))
 73        setattr(self, "_{}".format('previous_uri'), kwargs.get('previous_uri', None))
 74        setattr(self, "_{}".format('result_set_size'), kwargs.get('result_set_size', None))
 75        setattr(self, "_{}".format('start_position'), kwargs.get('start_position', None))
 76        setattr(self, "_{}".format('total_set_size'), kwargs.get('total_set_size', None))
 77
 78    @property
 79    def end_position(self):
 80        """Gets the end_position of this PageImages.  # noqa: E501
 81
 82        The last position in the result set.   # noqa: E501
 83
 84        :return: The end_position of this PageImages.  # noqa: E501
 85        :rtype: str
 86        """
 87        return self._end_position
 88
 89    @end_position.setter
 90    def end_position(self, end_position):
 91        """Sets the end_position of this PageImages.
 92
 93        The last position in the result set.   # noqa: E501
 94
 95        :param end_position: The end_position of this PageImages.  # noqa: E501
 96        :type: str
 97        """
 98
 99        self._end_position = end_position
100
101    @property
102    def next_uri(self):
103        """Gets the next_uri of this PageImages.  # noqa: E501
104
105        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
106
107        :return: The next_uri of this PageImages.  # noqa: E501
108        :rtype: str
109        """
110        return self._next_uri
111
112    @next_uri.setter
113    def next_uri(self, next_uri):
114        """Sets the next_uri of this PageImages.
115
116        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
117
118        :param next_uri: The next_uri of this PageImages.  # noqa: E501
119        :type: str
120        """
121
122        self._next_uri = next_uri
123
124    @property
125    def pages(self):
126        """Gets the pages of this PageImages.  # noqa: E501
127
128          # noqa: E501
129
130        :return: The pages of this PageImages.  # noqa: E501
131        :rtype: list[Page]
132        """
133        return self._pages
134
135    @pages.setter
136    def pages(self, pages):
137        """Sets the pages of this PageImages.
138
139          # noqa: E501
140
141        :param pages: The pages of this PageImages.  # noqa: E501
142        :type: list[Page]
143        """
144
145        self._pages = pages
146
147    @property
148    def previous_uri(self):
149        """Gets the previous_uri of this PageImages.  # noqa: E501
150
151        The postal code for the billing address.  # noqa: E501
152
153        :return: The previous_uri of this PageImages.  # noqa: E501
154        :rtype: str
155        """
156        return self._previous_uri
157
158    @previous_uri.setter
159    def previous_uri(self, previous_uri):
160        """Sets the previous_uri of this PageImages.
161
162        The postal code for the billing address.  # noqa: E501
163
164        :param previous_uri: The previous_uri of this PageImages.  # noqa: E501
165        :type: str
166        """
167
168        self._previous_uri = previous_uri
169
170    @property
171    def result_set_size(self):
172        """Gets the result_set_size of this PageImages.  # noqa: E501
173
174        The number of results returned in this response.   # noqa: E501
175
176        :return: The result_set_size of this PageImages.  # noqa: E501
177        :rtype: str
178        """
179        return self._result_set_size
180
181    @result_set_size.setter
182    def result_set_size(self, result_set_size):
183        """Sets the result_set_size of this PageImages.
184
185        The number of results returned in this response.   # noqa: E501
186
187        :param result_set_size: The result_set_size of this PageImages.  # noqa: E501
188        :type: str
189        """
190
191        self._result_set_size = result_set_size
192
193    @property
194    def start_position(self):
195        """Gets the start_position of this PageImages.  # noqa: E501
196
197        Starting position of the current result set.  # noqa: E501
198
199        :return: The start_position of this PageImages.  # noqa: E501
200        :rtype: str
201        """
202        return self._start_position
203
204    @start_position.setter
205    def start_position(self, start_position):
206        """Sets the start_position of this PageImages.
207
208        Starting position of the current result set.  # noqa: E501
209
210        :param start_position: The start_position of this PageImages.  # noqa: E501
211        :type: str
212        """
213
214        self._start_position = start_position
215
216    @property
217    def total_set_size(self):
218        """Gets the total_set_size of this PageImages.  # noqa: E501
219
220        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
221
222        :return: The total_set_size of this PageImages.  # noqa: E501
223        :rtype: str
224        """
225        return self._total_set_size
226
227    @total_set_size.setter
228    def total_set_size(self, total_set_size):
229        """Sets the total_set_size of this PageImages.
230
231        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
232
233        :param total_set_size: The total_set_size of this PageImages.  # noqa: E501
234        :type: str
235        """
236
237        self._total_set_size = total_set_size
238
239    def to_dict(self):
240        """Returns the model properties as a dict"""
241        result = {}
242
243        for attr, _ in six.iteritems(self.swagger_types):
244            value = getattr(self, attr)
245            if isinstance(value, list):
246                result[attr] = list(map(
247                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
248                    value
249                ))
250            elif hasattr(value, "to_dict"):
251                result[attr] = value.to_dict()
252            elif isinstance(value, dict):
253                result[attr] = dict(map(
254                    lambda item: (item[0], item[1].to_dict())
255                    if hasattr(item[1], "to_dict") else item,
256                    value.items()
257                ))
258            else:
259                result[attr] = value
260        if issubclass(PageImages, dict):
261            for key, value in self.items():
262                result[key] = value
263
264        return result
265
266    def to_str(self):
267        """Returns the string representation of the model"""
268        return pprint.pformat(self.to_dict())
269
270    def __repr__(self):
271        """For `print` and `pprint`"""
272        return self.to_str()
273
274    def __eq__(self, other):
275        """Returns true if both objects are equal"""
276        if not isinstance(other, PageImages):
277            return False
278
279        return self.to_dict() == other.to_dict()
280
281    def __ne__(self, other):
282        """Returns true if both objects are not equal"""
283        if not isinstance(other, PageImages):
284            return True
285
286        return self.to_dict() != other.to_dict()