docusign_esign.models.external_folder

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