docusign_esign.models.folders_response

  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 FoldersResponse(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        'envelopes': 'list[EnvelopeSummary]',
 38        'folders': 'list[Folder]',
 39        'next_uri': 'str',
 40        'previous_uri': 'str',
 41        'result_set_size': 'str',
 42        'start_position': 'str',
 43        'total_set_size': 'str'
 44    }
 45
 46    attribute_map = {
 47        'end_position': 'endPosition',
 48        'envelopes': 'envelopes',
 49        'folders': 'folders',
 50        'next_uri': 'nextUri',
 51        'previous_uri': 'previousUri',
 52        'result_set_size': 'resultSetSize',
 53        'start_position': 'startPosition',
 54        'total_set_size': 'totalSetSize'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """FoldersResponse - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._end_position = None
 64        self._envelopes = None
 65        self._folders = None
 66        self._next_uri = None
 67        self._previous_uri = None
 68        self._result_set_size = None
 69        self._start_position = None
 70        self._total_set_size = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('end_position'), kwargs.get('end_position', None))
 74        setattr(self, "_{}".format('envelopes'), kwargs.get('envelopes', None))
 75        setattr(self, "_{}".format('folders'), kwargs.get('folders', None))
 76        setattr(self, "_{}".format('next_uri'), kwargs.get('next_uri', None))
 77        setattr(self, "_{}".format('previous_uri'), kwargs.get('previous_uri', None))
 78        setattr(self, "_{}".format('result_set_size'), kwargs.get('result_set_size', None))
 79        setattr(self, "_{}".format('start_position'), kwargs.get('start_position', None))
 80        setattr(self, "_{}".format('total_set_size'), kwargs.get('total_set_size', None))
 81
 82    @property
 83    def end_position(self):
 84        """Gets the end_position of this FoldersResponse.  # noqa: E501
 85
 86        The last position in the result set.   # noqa: E501
 87
 88        :return: The end_position of this FoldersResponse.  # noqa: E501
 89        :rtype: str
 90        """
 91        return self._end_position
 92
 93    @end_position.setter
 94    def end_position(self, end_position):
 95        """Sets the end_position of this FoldersResponse.
 96
 97        The last position in the result set.   # noqa: E501
 98
 99        :param end_position: The end_position of this FoldersResponse.  # noqa: E501
100        :type: str
101        """
102
103        self._end_position = end_position
104
105    @property
106    def envelopes(self):
107        """Gets the envelopes of this FoldersResponse.  # noqa: E501
108
109          # noqa: E501
110
111        :return: The envelopes of this FoldersResponse.  # noqa: E501
112        :rtype: list[EnvelopeSummary]
113        """
114        return self._envelopes
115
116    @envelopes.setter
117    def envelopes(self, envelopes):
118        """Sets the envelopes of this FoldersResponse.
119
120          # noqa: E501
121
122        :param envelopes: The envelopes of this FoldersResponse.  # noqa: E501
123        :type: list[EnvelopeSummary]
124        """
125
126        self._envelopes = envelopes
127
128    @property
129    def folders(self):
130        """Gets the folders of this FoldersResponse.  # noqa: E501
131
132          # noqa: E501
133
134        :return: The folders of this FoldersResponse.  # noqa: E501
135        :rtype: list[Folder]
136        """
137        return self._folders
138
139    @folders.setter
140    def folders(self, folders):
141        """Sets the folders of this FoldersResponse.
142
143          # noqa: E501
144
145        :param folders: The folders of this FoldersResponse.  # noqa: E501
146        :type: list[Folder]
147        """
148
149        self._folders = folders
150
151    @property
152    def next_uri(self):
153        """Gets the next_uri of this FoldersResponse.  # noqa: E501
154
155        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
156
157        :return: The next_uri of this FoldersResponse.  # noqa: E501
158        :rtype: str
159        """
160        return self._next_uri
161
162    @next_uri.setter
163    def next_uri(self, next_uri):
164        """Sets the next_uri of this FoldersResponse.
165
166        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
167
168        :param next_uri: The next_uri of this FoldersResponse.  # noqa: E501
169        :type: str
170        """
171
172        self._next_uri = next_uri
173
174    @property
175    def previous_uri(self):
176        """Gets the previous_uri of this FoldersResponse.  # noqa: E501
177
178        The postal code for the billing address.  # noqa: E501
179
180        :return: The previous_uri of this FoldersResponse.  # noqa: E501
181        :rtype: str
182        """
183        return self._previous_uri
184
185    @previous_uri.setter
186    def previous_uri(self, previous_uri):
187        """Sets the previous_uri of this FoldersResponse.
188
189        The postal code for the billing address.  # noqa: E501
190
191        :param previous_uri: The previous_uri of this FoldersResponse.  # noqa: E501
192        :type: str
193        """
194
195        self._previous_uri = previous_uri
196
197    @property
198    def result_set_size(self):
199        """Gets the result_set_size of this FoldersResponse.  # noqa: E501
200
201        The number of results returned in this response.   # noqa: E501
202
203        :return: The result_set_size of this FoldersResponse.  # noqa: E501
204        :rtype: str
205        """
206        return self._result_set_size
207
208    @result_set_size.setter
209    def result_set_size(self, result_set_size):
210        """Sets the result_set_size of this FoldersResponse.
211
212        The number of results returned in this response.   # noqa: E501
213
214        :param result_set_size: The result_set_size of this FoldersResponse.  # noqa: E501
215        :type: str
216        """
217
218        self._result_set_size = result_set_size
219
220    @property
221    def start_position(self):
222        """Gets the start_position of this FoldersResponse.  # noqa: E501
223
224        Starting position of the current result set.  # noqa: E501
225
226        :return: The start_position of this FoldersResponse.  # noqa: E501
227        :rtype: str
228        """
229        return self._start_position
230
231    @start_position.setter
232    def start_position(self, start_position):
233        """Sets the start_position of this FoldersResponse.
234
235        Starting position of the current result set.  # noqa: E501
236
237        :param start_position: The start_position of this FoldersResponse.  # noqa: E501
238        :type: str
239        """
240
241        self._start_position = start_position
242
243    @property
244    def total_set_size(self):
245        """Gets the total_set_size of this FoldersResponse.  # noqa: E501
246
247        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
248
249        :return: The total_set_size of this FoldersResponse.  # noqa: E501
250        :rtype: str
251        """
252        return self._total_set_size
253
254    @total_set_size.setter
255    def total_set_size(self, total_set_size):
256        """Sets the total_set_size of this FoldersResponse.
257
258        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
259
260        :param total_set_size: The total_set_size of this FoldersResponse.  # noqa: E501
261        :type: str
262        """
263
264        self._total_set_size = total_set_size
265
266    def to_dict(self):
267        """Returns the model properties as a dict"""
268        result = {}
269
270        for attr, _ in six.iteritems(self.swagger_types):
271            value = getattr(self, attr)
272            if isinstance(value, list):
273                result[attr] = list(map(
274                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
275                    value
276                ))
277            elif hasattr(value, "to_dict"):
278                result[attr] = value.to_dict()
279            elif isinstance(value, dict):
280                result[attr] = dict(map(
281                    lambda item: (item[0], item[1].to_dict())
282                    if hasattr(item[1], "to_dict") else item,
283                    value.items()
284                ))
285            else:
286                result[attr] = value
287        if issubclass(FoldersResponse, dict):
288            for key, value in self.items():
289                result[key] = value
290
291        return result
292
293    def to_str(self):
294        """Returns the string representation of the model"""
295        return pprint.pformat(self.to_dict())
296
297    def __repr__(self):
298        """For `print` and `pprint`"""
299        return self.to_str()
300
301    def __eq__(self, other):
302        """Returns true if both objects are equal"""
303        if not isinstance(other, FoldersResponse):
304            return False
305
306        return self.to_dict() == other.to_dict()
307
308    def __ne__(self, other):
309        """Returns true if both objects are not equal"""
310        if not isinstance(other, FoldersResponse):
311            return True
312
313        return self.to_dict() != other.to_dict()