docusign_esign.models.folder_shared_item

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