docusign_esign.models.sender_email_notifications

  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 SenderEmailNotifications(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        'changed_signer': 'str',
 37        'clickwrap_responses_limit_notification_email': 'str',
 38        'comments_only_private_and_mention': 'str',
 39        'comments_receive_all': 'str',
 40        'delivery_failed': 'str',
 41        'envelope_complete': 'str',
 42        'offline_signing_failed': 'str',
 43        'powerform_responses_limit_notification_email': 'str',
 44        'purge_documents': 'str',
 45        'recipient_viewed': 'str',
 46        'sender_envelope_declined': 'str',
 47        'withdrawn_consent': 'str'
 48    }
 49
 50    attribute_map = {
 51        'changed_signer': 'changedSigner',
 52        'clickwrap_responses_limit_notification_email': 'clickwrapResponsesLimitNotificationEmail',
 53        'comments_only_private_and_mention': 'commentsOnlyPrivateAndMention',
 54        'comments_receive_all': 'commentsReceiveAll',
 55        'delivery_failed': 'deliveryFailed',
 56        'envelope_complete': 'envelopeComplete',
 57        'offline_signing_failed': 'offlineSigningFailed',
 58        'powerform_responses_limit_notification_email': 'powerformResponsesLimitNotificationEmail',
 59        'purge_documents': 'purgeDocuments',
 60        'recipient_viewed': 'recipientViewed',
 61        'sender_envelope_declined': 'senderEnvelopeDeclined',
 62        'withdrawn_consent': 'withdrawnConsent'
 63    }
 64
 65    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 66        """SenderEmailNotifications - a model defined in Swagger"""  # noqa: E501
 67        if _configuration is None:
 68            _configuration = Configuration()
 69        self._configuration = _configuration
 70
 71        self._changed_signer = None
 72        self._clickwrap_responses_limit_notification_email = None
 73        self._comments_only_private_and_mention = None
 74        self._comments_receive_all = None
 75        self._delivery_failed = None
 76        self._envelope_complete = None
 77        self._offline_signing_failed = None
 78        self._powerform_responses_limit_notification_email = None
 79        self._purge_documents = None
 80        self._recipient_viewed = None
 81        self._sender_envelope_declined = None
 82        self._withdrawn_consent = None
 83        self.discriminator = None
 84
 85        setattr(self, "_{}".format('changed_signer'), kwargs.get('changed_signer', None))
 86        setattr(self, "_{}".format('clickwrap_responses_limit_notification_email'), kwargs.get('clickwrap_responses_limit_notification_email', None))
 87        setattr(self, "_{}".format('comments_only_private_and_mention'), kwargs.get('comments_only_private_and_mention', None))
 88        setattr(self, "_{}".format('comments_receive_all'), kwargs.get('comments_receive_all', None))
 89        setattr(self, "_{}".format('delivery_failed'), kwargs.get('delivery_failed', None))
 90        setattr(self, "_{}".format('envelope_complete'), kwargs.get('envelope_complete', None))
 91        setattr(self, "_{}".format('offline_signing_failed'), kwargs.get('offline_signing_failed', None))
 92        setattr(self, "_{}".format('powerform_responses_limit_notification_email'), kwargs.get('powerform_responses_limit_notification_email', None))
 93        setattr(self, "_{}".format('purge_documents'), kwargs.get('purge_documents', None))
 94        setattr(self, "_{}".format('recipient_viewed'), kwargs.get('recipient_viewed', None))
 95        setattr(self, "_{}".format('sender_envelope_declined'), kwargs.get('sender_envelope_declined', None))
 96        setattr(self, "_{}".format('withdrawn_consent'), kwargs.get('withdrawn_consent', None))
 97
 98    @property
 99    def changed_signer(self):
100        """Gets the changed_signer of this SenderEmailNotifications.  # noqa: E501
101
102        When set to **true**, the sender receives notification if the signer changes.  # noqa: E501
103
104        :return: The changed_signer of this SenderEmailNotifications.  # noqa: E501
105        :rtype: str
106        """
107        return self._changed_signer
108
109    @changed_signer.setter
110    def changed_signer(self, changed_signer):
111        """Sets the changed_signer of this SenderEmailNotifications.
112
113        When set to **true**, the sender receives notification if the signer changes.  # noqa: E501
114
115        :param changed_signer: The changed_signer of this SenderEmailNotifications.  # noqa: E501
116        :type: str
117        """
118
119        self._changed_signer = changed_signer
120
121    @property
122    def clickwrap_responses_limit_notification_email(self):
123        """Gets the clickwrap_responses_limit_notification_email of this SenderEmailNotifications.  # noqa: E501
124
125          # noqa: E501
126
127        :return: The clickwrap_responses_limit_notification_email of this SenderEmailNotifications.  # noqa: E501
128        :rtype: str
129        """
130        return self._clickwrap_responses_limit_notification_email
131
132    @clickwrap_responses_limit_notification_email.setter
133    def clickwrap_responses_limit_notification_email(self, clickwrap_responses_limit_notification_email):
134        """Sets the clickwrap_responses_limit_notification_email of this SenderEmailNotifications.
135
136          # noqa: E501
137
138        :param clickwrap_responses_limit_notification_email: The clickwrap_responses_limit_notification_email of this SenderEmailNotifications.  # noqa: E501
139        :type: str
140        """
141
142        self._clickwrap_responses_limit_notification_email = clickwrap_responses_limit_notification_email
143
144    @property
145    def comments_only_private_and_mention(self):
146        """Gets the comments_only_private_and_mention of this SenderEmailNotifications.  # noqa: E501
147
148          # noqa: E501
149
150        :return: The comments_only_private_and_mention of this SenderEmailNotifications.  # noqa: E501
151        :rtype: str
152        """
153        return self._comments_only_private_and_mention
154
155    @comments_only_private_and_mention.setter
156    def comments_only_private_and_mention(self, comments_only_private_and_mention):
157        """Sets the comments_only_private_and_mention of this SenderEmailNotifications.
158
159          # noqa: E501
160
161        :param comments_only_private_and_mention: The comments_only_private_and_mention of this SenderEmailNotifications.  # noqa: E501
162        :type: str
163        """
164
165        self._comments_only_private_and_mention = comments_only_private_and_mention
166
167    @property
168    def comments_receive_all(self):
169        """Gets the comments_receive_all of this SenderEmailNotifications.  # noqa: E501
170
171          # noqa: E501
172
173        :return: The comments_receive_all of this SenderEmailNotifications.  # noqa: E501
174        :rtype: str
175        """
176        return self._comments_receive_all
177
178    @comments_receive_all.setter
179    def comments_receive_all(self, comments_receive_all):
180        """Sets the comments_receive_all of this SenderEmailNotifications.
181
182          # noqa: E501
183
184        :param comments_receive_all: The comments_receive_all of this SenderEmailNotifications.  # noqa: E501
185        :type: str
186        """
187
188        self._comments_receive_all = comments_receive_all
189
190    @property
191    def delivery_failed(self):
192        """Gets the delivery_failed of this SenderEmailNotifications.  # noqa: E501
193
194        When set to **true**, the sender receives notification if the delivery of the envelope fails.  # noqa: E501
195
196        :return: The delivery_failed of this SenderEmailNotifications.  # noqa: E501
197        :rtype: str
198        """
199        return self._delivery_failed
200
201    @delivery_failed.setter
202    def delivery_failed(self, delivery_failed):
203        """Sets the delivery_failed of this SenderEmailNotifications.
204
205        When set to **true**, the sender receives notification if the delivery of the envelope fails.  # noqa: E501
206
207        :param delivery_failed: The delivery_failed of this SenderEmailNotifications.  # noqa: E501
208        :type: str
209        """
210
211        self._delivery_failed = delivery_failed
212
213    @property
214    def envelope_complete(self):
215        """Gets the envelope_complete of this SenderEmailNotifications.  # noqa: E501
216
217        When set to **true**, the user receives notification that the envelope has been completed.  # noqa: E501
218
219        :return: The envelope_complete of this SenderEmailNotifications.  # noqa: E501
220        :rtype: str
221        """
222        return self._envelope_complete
223
224    @envelope_complete.setter
225    def envelope_complete(self, envelope_complete):
226        """Sets the envelope_complete of this SenderEmailNotifications.
227
228        When set to **true**, the user receives notification that the envelope has been completed.  # noqa: E501
229
230        :param envelope_complete: The envelope_complete of this SenderEmailNotifications.  # noqa: E501
231        :type: str
232        """
233
234        self._envelope_complete = envelope_complete
235
236    @property
237    def offline_signing_failed(self):
238        """Gets the offline_signing_failed of this SenderEmailNotifications.  # noqa: E501
239
240        When set to **true**, the user receives notification if the offline signing failed.  # noqa: E501
241
242        :return: The offline_signing_failed of this SenderEmailNotifications.  # noqa: E501
243        :rtype: str
244        """
245        return self._offline_signing_failed
246
247    @offline_signing_failed.setter
248    def offline_signing_failed(self, offline_signing_failed):
249        """Sets the offline_signing_failed of this SenderEmailNotifications.
250
251        When set to **true**, the user receives notification if the offline signing failed.  # noqa: E501
252
253        :param offline_signing_failed: The offline_signing_failed of this SenderEmailNotifications.  # noqa: E501
254        :type: str
255        """
256
257        self._offline_signing_failed = offline_signing_failed
258
259    @property
260    def powerform_responses_limit_notification_email(self):
261        """Gets the powerform_responses_limit_notification_email of this SenderEmailNotifications.  # noqa: E501
262
263          # noqa: E501
264
265        :return: The powerform_responses_limit_notification_email of this SenderEmailNotifications.  # noqa: E501
266        :rtype: str
267        """
268        return self._powerform_responses_limit_notification_email
269
270    @powerform_responses_limit_notification_email.setter
271    def powerform_responses_limit_notification_email(self, powerform_responses_limit_notification_email):
272        """Sets the powerform_responses_limit_notification_email of this SenderEmailNotifications.
273
274          # noqa: E501
275
276        :param powerform_responses_limit_notification_email: The powerform_responses_limit_notification_email of this SenderEmailNotifications.  # noqa: E501
277        :type: str
278        """
279
280        self._powerform_responses_limit_notification_email = powerform_responses_limit_notification_email
281
282    @property
283    def purge_documents(self):
284        """Gets the purge_documents of this SenderEmailNotifications.  # noqa: E501
285
286          # noqa: E501
287
288        :return: The purge_documents of this SenderEmailNotifications.  # noqa: E501
289        :rtype: str
290        """
291        return self._purge_documents
292
293    @purge_documents.setter
294    def purge_documents(self, purge_documents):
295        """Sets the purge_documents of this SenderEmailNotifications.
296
297          # noqa: E501
298
299        :param purge_documents: The purge_documents of this SenderEmailNotifications.  # noqa: E501
300        :type: str
301        """
302
303        self._purge_documents = purge_documents
304
305    @property
306    def recipient_viewed(self):
307        """Gets the recipient_viewed of this SenderEmailNotifications.  # noqa: E501
308
309        When set to **true**, the sender receives notification that the recipient viewed the enveloper.  # noqa: E501
310
311        :return: The recipient_viewed of this SenderEmailNotifications.  # noqa: E501
312        :rtype: str
313        """
314        return self._recipient_viewed
315
316    @recipient_viewed.setter
317    def recipient_viewed(self, recipient_viewed):
318        """Sets the recipient_viewed of this SenderEmailNotifications.
319
320        When set to **true**, the sender receives notification that the recipient viewed the enveloper.  # noqa: E501
321
322        :param recipient_viewed: The recipient_viewed of this SenderEmailNotifications.  # noqa: E501
323        :type: str
324        """
325
326        self._recipient_viewed = recipient_viewed
327
328    @property
329    def sender_envelope_declined(self):
330        """Gets the sender_envelope_declined of this SenderEmailNotifications.  # noqa: E501
331
332          # noqa: E501
333
334        :return: The sender_envelope_declined of this SenderEmailNotifications.  # noqa: E501
335        :rtype: str
336        """
337        return self._sender_envelope_declined
338
339    @sender_envelope_declined.setter
340    def sender_envelope_declined(self, sender_envelope_declined):
341        """Sets the sender_envelope_declined of this SenderEmailNotifications.
342
343          # noqa: E501
344
345        :param sender_envelope_declined: The sender_envelope_declined of this SenderEmailNotifications.  # noqa: E501
346        :type: str
347        """
348
349        self._sender_envelope_declined = sender_envelope_declined
350
351    @property
352    def withdrawn_consent(self):
353        """Gets the withdrawn_consent of this SenderEmailNotifications.  # noqa: E501
354
355        When set to **true**, the user receives notification if consent is withdrawn.  # noqa: E501
356
357        :return: The withdrawn_consent of this SenderEmailNotifications.  # noqa: E501
358        :rtype: str
359        """
360        return self._withdrawn_consent
361
362    @withdrawn_consent.setter
363    def withdrawn_consent(self, withdrawn_consent):
364        """Sets the withdrawn_consent of this SenderEmailNotifications.
365
366        When set to **true**, the user receives notification if consent is withdrawn.  # noqa: E501
367
368        :param withdrawn_consent: The withdrawn_consent of this SenderEmailNotifications.  # noqa: E501
369        :type: str
370        """
371
372        self._withdrawn_consent = withdrawn_consent
373
374    def to_dict(self):
375        """Returns the model properties as a dict"""
376        result = {}
377
378        for attr, _ in six.iteritems(self.swagger_types):
379            value = getattr(self, attr)
380            if isinstance(value, list):
381                result[attr] = list(map(
382                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
383                    value
384                ))
385            elif hasattr(value, "to_dict"):
386                result[attr] = value.to_dict()
387            elif isinstance(value, dict):
388                result[attr] = dict(map(
389                    lambda item: (item[0], item[1].to_dict())
390                    if hasattr(item[1], "to_dict") else item,
391                    value.items()
392                ))
393            else:
394                result[attr] = value
395        if issubclass(SenderEmailNotifications, dict):
396            for key, value in self.items():
397                result[key] = value
398
399        return result
400
401    def to_str(self):
402        """Returns the string representation of the model"""
403        return pprint.pformat(self.to_dict())
404
405    def __repr__(self):
406        """For `print` and `pprint`"""
407        return self.to_str()
408
409    def __eq__(self, other):
410        """Returns true if both objects are equal"""
411        if not isinstance(other, SenderEmailNotifications):
412            return False
413
414        return self.to_dict() == other.to_dict()
415
416    def __ne__(self, other):
417        """Returns true if both objects are not equal"""
418        if not isinstance(other, SenderEmailNotifications):
419            return True
420
421        return self.to_dict() != other.to_dict()