docusign_esign.models.envelope_transfer_rule

  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 EnvelopeTransferRule(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        'carbon_copy_original_owner': 'str',
 37        'enabled': 'str',
 38        'envelope_transfer_rule_id': 'str',
 39        'event_type': 'str',
 40        'from_group': 'Group',
 41        'from_user': 'UserInformation',
 42        'modified_date': 'str',
 43        'modified_user': 'UserInformation',
 44        'to_folder': 'Folder',
 45        'to_user': 'UserInformation'
 46    }
 47
 48    attribute_map = {
 49        'carbon_copy_original_owner': 'carbonCopyOriginalOwner',
 50        'enabled': 'enabled',
 51        'envelope_transfer_rule_id': 'envelopeTransferRuleId',
 52        'event_type': 'eventType',
 53        'from_group': 'fromGroup',
 54        'from_user': 'fromUser',
 55        'modified_date': 'modifiedDate',
 56        'modified_user': 'modifiedUser',
 57        'to_folder': 'toFolder',
 58        'to_user': 'toUser'
 59    }
 60
 61    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 62        """EnvelopeTransferRule - a model defined in Swagger"""  # noqa: E501
 63        if _configuration is None:
 64            _configuration = Configuration()
 65        self._configuration = _configuration
 66
 67        self._carbon_copy_original_owner = None
 68        self._enabled = None
 69        self._envelope_transfer_rule_id = None
 70        self._event_type = None
 71        self._from_group = None
 72        self._from_user = None
 73        self._modified_date = None
 74        self._modified_user = None
 75        self._to_folder = None
 76        self._to_user = None
 77        self.discriminator = None
 78
 79        setattr(self, "_{}".format('carbon_copy_original_owner'), kwargs.get('carbon_copy_original_owner', None))
 80        setattr(self, "_{}".format('enabled'), kwargs.get('enabled', None))
 81        setattr(self, "_{}".format('envelope_transfer_rule_id'), kwargs.get('envelope_transfer_rule_id', None))
 82        setattr(self, "_{}".format('event_type'), kwargs.get('event_type', None))
 83        setattr(self, "_{}".format('from_group'), kwargs.get('from_group', None))
 84        setattr(self, "_{}".format('from_user'), kwargs.get('from_user', None))
 85        setattr(self, "_{}".format('modified_date'), kwargs.get('modified_date', None))
 86        setattr(self, "_{}".format('modified_user'), kwargs.get('modified_user', None))
 87        setattr(self, "_{}".format('to_folder'), kwargs.get('to_folder', None))
 88        setattr(self, "_{}".format('to_user'), kwargs.get('to_user', None))
 89
 90    @property
 91    def carbon_copy_original_owner(self):
 92        """Gets the carbon_copy_original_owner of this EnvelopeTransferRule.  # noqa: E501
 93
 94          # noqa: E501
 95
 96        :return: The carbon_copy_original_owner of this EnvelopeTransferRule.  # noqa: E501
 97        :rtype: str
 98        """
 99        return self._carbon_copy_original_owner
100
101    @carbon_copy_original_owner.setter
102    def carbon_copy_original_owner(self, carbon_copy_original_owner):
103        """Sets the carbon_copy_original_owner of this EnvelopeTransferRule.
104
105          # noqa: E501
106
107        :param carbon_copy_original_owner: The carbon_copy_original_owner of this EnvelopeTransferRule.  # noqa: E501
108        :type: str
109        """
110
111        self._carbon_copy_original_owner = carbon_copy_original_owner
112
113    @property
114    def enabled(self):
115        """Gets the enabled of this EnvelopeTransferRule.  # noqa: E501
116
117          # noqa: E501
118
119        :return: The enabled of this EnvelopeTransferRule.  # noqa: E501
120        :rtype: str
121        """
122        return self._enabled
123
124    @enabled.setter
125    def enabled(self, enabled):
126        """Sets the enabled of this EnvelopeTransferRule.
127
128          # noqa: E501
129
130        :param enabled: The enabled of this EnvelopeTransferRule.  # noqa: E501
131        :type: str
132        """
133
134        self._enabled = enabled
135
136    @property
137    def envelope_transfer_rule_id(self):
138        """Gets the envelope_transfer_rule_id of this EnvelopeTransferRule.  # noqa: E501
139
140          # noqa: E501
141
142        :return: The envelope_transfer_rule_id of this EnvelopeTransferRule.  # noqa: E501
143        :rtype: str
144        """
145        return self._envelope_transfer_rule_id
146
147    @envelope_transfer_rule_id.setter
148    def envelope_transfer_rule_id(self, envelope_transfer_rule_id):
149        """Sets the envelope_transfer_rule_id of this EnvelopeTransferRule.
150
151          # noqa: E501
152
153        :param envelope_transfer_rule_id: The envelope_transfer_rule_id of this EnvelopeTransferRule.  # noqa: E501
154        :type: str
155        """
156
157        self._envelope_transfer_rule_id = envelope_transfer_rule_id
158
159    @property
160    def event_type(self):
161        """Gets the event_type of this EnvelopeTransferRule.  # noqa: E501
162
163          # noqa: E501
164
165        :return: The event_type of this EnvelopeTransferRule.  # noqa: E501
166        :rtype: str
167        """
168        return self._event_type
169
170    @event_type.setter
171    def event_type(self, event_type):
172        """Sets the event_type of this EnvelopeTransferRule.
173
174          # noqa: E501
175
176        :param event_type: The event_type of this EnvelopeTransferRule.  # noqa: E501
177        :type: str
178        """
179
180        self._event_type = event_type
181
182    @property
183    def from_group(self):
184        """Gets the from_group of this EnvelopeTransferRule.  # noqa: E501
185
186        Information about the group that triggers the transfer.  # noqa: E501
187
188        :return: The from_group of this EnvelopeTransferRule.  # noqa: E501
189        :rtype: Group
190        """
191        return self._from_group
192
193    @from_group.setter
194    def from_group(self, from_group):
195        """Sets the from_group of this EnvelopeTransferRule.
196
197        Information about the group that triggers the transfer.  # noqa: E501
198
199        :param from_group: The from_group of this EnvelopeTransferRule.  # noqa: E501
200        :type: Group
201        """
202
203        self._from_group = from_group
204
205    @property
206    def from_user(self):
207        """Gets the from_user of this EnvelopeTransferRule.  # noqa: E501
208
209        Information about the user who triggers the transfer.  # noqa: E501
210
211        :return: The from_user of this EnvelopeTransferRule.  # noqa: E501
212        :rtype: UserInformation
213        """
214        return self._from_user
215
216    @from_user.setter
217    def from_user(self, from_user):
218        """Sets the from_user of this EnvelopeTransferRule.
219
220        Information about the user who triggers the transfer.  # noqa: E501
221
222        :param from_user: The from_user of this EnvelopeTransferRule.  # noqa: E501
223        :type: UserInformation
224        """
225
226        self._from_user = from_user
227
228    @property
229    def modified_date(self):
230        """Gets the modified_date of this EnvelopeTransferRule.  # noqa: E501
231
232          # noqa: E501
233
234        :return: The modified_date of this EnvelopeTransferRule.  # noqa: E501
235        :rtype: str
236        """
237        return self._modified_date
238
239    @modified_date.setter
240    def modified_date(self, modified_date):
241        """Sets the modified_date of this EnvelopeTransferRule.
242
243          # noqa: E501
244
245        :param modified_date: The modified_date of this EnvelopeTransferRule.  # noqa: E501
246        :type: str
247        """
248
249        self._modified_date = modified_date
250
251    @property
252    def modified_user(self):
253        """Gets the modified_user of this EnvelopeTransferRule.  # noqa: E501
254
255        Information about the user who last modified the envelope transfer rule.  # noqa: E501
256
257        :return: The modified_user of this EnvelopeTransferRule.  # noqa: E501
258        :rtype: UserInformation
259        """
260        return self._modified_user
261
262    @modified_user.setter
263    def modified_user(self, modified_user):
264        """Sets the modified_user of this EnvelopeTransferRule.
265
266        Information about the user who last modified the envelope transfer rule.  # noqa: E501
267
268        :param modified_user: The modified_user of this EnvelopeTransferRule.  # noqa: E501
269        :type: UserInformation
270        """
271
272        self._modified_user = modified_user
273
274    @property
275    def to_folder(self):
276        """Gets the to_folder of this EnvelopeTransferRule.  # noqa: E501
277
278        Information about the destination folder to which the envelope is transferred.  # noqa: E501
279
280        :return: The to_folder of this EnvelopeTransferRule.  # noqa: E501
281        :rtype: Folder
282        """
283        return self._to_folder
284
285    @to_folder.setter
286    def to_folder(self, to_folder):
287        """Sets the to_folder of this EnvelopeTransferRule.
288
289        Information about the destination folder to which the envelope is transferred.  # noqa: E501
290
291        :param to_folder: The to_folder of this EnvelopeTransferRule.  # noqa: E501
292        :type: Folder
293        """
294
295        self._to_folder = to_folder
296
297    @property
298    def to_user(self):
299        """Gets the to_user of this EnvelopeTransferRule.  # noqa: E501
300
301        Information about the user to which the envelope is transferred.  # noqa: E501
302
303        :return: The to_user of this EnvelopeTransferRule.  # noqa: E501
304        :rtype: UserInformation
305        """
306        return self._to_user
307
308    @to_user.setter
309    def to_user(self, to_user):
310        """Sets the to_user of this EnvelopeTransferRule.
311
312        Information about the user to which the envelope is transferred.  # noqa: E501
313
314        :param to_user: The to_user of this EnvelopeTransferRule.  # noqa: E501
315        :type: UserInformation
316        """
317
318        self._to_user = to_user
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(EnvelopeTransferRule, 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, EnvelopeTransferRule):
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, EnvelopeTransferRule):
365            return True
366
367        return self.to_dict() != other.to_dict()