docusign_esign.models.envelope_update_summary

  1# coding: utf-8
  2
  3"""
  4    DocuSign REST API
  5
  6    The DocuSign 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 EnvelopeUpdateSummary(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        'bulk_envelope_status': 'BulkEnvelopeStatus',
 37        'envelope_id': 'str',
 38        'error_details': 'ErrorDetails',
 39        'list_custom_field_update_results': 'list[ListCustomField]',
 40        'lock_information': 'LockInformation',
 41        'purge_state': 'str',
 42        'recipient_update_results': 'list[RecipientUpdateResponse]',
 43        'tab_update_results': 'Tabs',
 44        'text_custom_field_update_results': 'list[TextCustomField]'
 45    }
 46
 47    attribute_map = {
 48        'bulk_envelope_status': 'bulkEnvelopeStatus',
 49        'envelope_id': 'envelopeId',
 50        'error_details': 'errorDetails',
 51        'list_custom_field_update_results': 'listCustomFieldUpdateResults',
 52        'lock_information': 'lockInformation',
 53        'purge_state': 'purgeState',
 54        'recipient_update_results': 'recipientUpdateResults',
 55        'tab_update_results': 'tabUpdateResults',
 56        'text_custom_field_update_results': 'textCustomFieldUpdateResults'
 57    }
 58
 59    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 60        """EnvelopeUpdateSummary - a model defined in Swagger"""  # noqa: E501
 61        if _configuration is None:
 62            _configuration = Configuration()
 63        self._configuration = _configuration
 64
 65        self._bulk_envelope_status = None
 66        self._envelope_id = None
 67        self._error_details = None
 68        self._list_custom_field_update_results = None
 69        self._lock_information = None
 70        self._purge_state = None
 71        self._recipient_update_results = None
 72        self._tab_update_results = None
 73        self._text_custom_field_update_results = None
 74        self.discriminator = None
 75
 76        setattr(self, "_{}".format('bulk_envelope_status'), kwargs.get('bulk_envelope_status', None))
 77        setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
 78        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 79        setattr(self, "_{}".format('list_custom_field_update_results'), kwargs.get('list_custom_field_update_results', None))
 80        setattr(self, "_{}".format('lock_information'), kwargs.get('lock_information', None))
 81        setattr(self, "_{}".format('purge_state'), kwargs.get('purge_state', None))
 82        setattr(self, "_{}".format('recipient_update_results'), kwargs.get('recipient_update_results', None))
 83        setattr(self, "_{}".format('tab_update_results'), kwargs.get('tab_update_results', None))
 84        setattr(self, "_{}".format('text_custom_field_update_results'), kwargs.get('text_custom_field_update_results', None))
 85
 86    @property
 87    def bulk_envelope_status(self):
 88        """Gets the bulk_envelope_status of this EnvelopeUpdateSummary.  # noqa: E501
 89
 90        An object that describes the status of the bulk send envelopes.  # noqa: E501
 91
 92        :return: The bulk_envelope_status of this EnvelopeUpdateSummary.  # noqa: E501
 93        :rtype: BulkEnvelopeStatus
 94        """
 95        return self._bulk_envelope_status
 96
 97    @bulk_envelope_status.setter
 98    def bulk_envelope_status(self, bulk_envelope_status):
 99        """Sets the bulk_envelope_status of this EnvelopeUpdateSummary.
100
101        An object that describes the status of the bulk send envelopes.  # noqa: E501
102
103        :param bulk_envelope_status: The bulk_envelope_status of this EnvelopeUpdateSummary.  # noqa: E501
104        :type: BulkEnvelopeStatus
105        """
106
107        self._bulk_envelope_status = bulk_envelope_status
108
109    @property
110    def envelope_id(self):
111        """Gets the envelope_id of this EnvelopeUpdateSummary.  # noqa: E501
112
113        The envelope ID of the envelope status that failed to post.  # noqa: E501
114
115        :return: The envelope_id of this EnvelopeUpdateSummary.  # noqa: E501
116        :rtype: str
117        """
118        return self._envelope_id
119
120    @envelope_id.setter
121    def envelope_id(self, envelope_id):
122        """Sets the envelope_id of this EnvelopeUpdateSummary.
123
124        The envelope ID of the envelope status that failed to post.  # noqa: E501
125
126        :param envelope_id: The envelope_id of this EnvelopeUpdateSummary.  # noqa: E501
127        :type: str
128        """
129
130        self._envelope_id = envelope_id
131
132    @property
133    def error_details(self):
134        """Gets the error_details of this EnvelopeUpdateSummary.  # noqa: E501
135
136        Array or errors.  # noqa: E501
137
138        :return: The error_details of this EnvelopeUpdateSummary.  # noqa: E501
139        :rtype: ErrorDetails
140        """
141        return self._error_details
142
143    @error_details.setter
144    def error_details(self, error_details):
145        """Sets the error_details of this EnvelopeUpdateSummary.
146
147        Array or errors.  # noqa: E501
148
149        :param error_details: The error_details of this EnvelopeUpdateSummary.  # noqa: E501
150        :type: ErrorDetails
151        """
152
153        self._error_details = error_details
154
155    @property
156    def list_custom_field_update_results(self):
157        """Gets the list_custom_field_update_results of this EnvelopeUpdateSummary.  # noqa: E501
158
159          # noqa: E501
160
161        :return: The list_custom_field_update_results of this EnvelopeUpdateSummary.  # noqa: E501
162        :rtype: list[ListCustomField]
163        """
164        return self._list_custom_field_update_results
165
166    @list_custom_field_update_results.setter
167    def list_custom_field_update_results(self, list_custom_field_update_results):
168        """Sets the list_custom_field_update_results of this EnvelopeUpdateSummary.
169
170          # noqa: E501
171
172        :param list_custom_field_update_results: The list_custom_field_update_results of this EnvelopeUpdateSummary.  # noqa: E501
173        :type: list[ListCustomField]
174        """
175
176        self._list_custom_field_update_results = list_custom_field_update_results
177
178    @property
179    def lock_information(self):
180        """Gets the lock_information of this EnvelopeUpdateSummary.  # noqa: E501
181
182        Provides lock information about an envelope that a user has locked.  # noqa: E501
183
184        :return: The lock_information of this EnvelopeUpdateSummary.  # noqa: E501
185        :rtype: LockInformation
186        """
187        return self._lock_information
188
189    @lock_information.setter
190    def lock_information(self, lock_information):
191        """Sets the lock_information of this EnvelopeUpdateSummary.
192
193        Provides lock information about an envelope that a user has locked.  # noqa: E501
194
195        :param lock_information: The lock_information of this EnvelopeUpdateSummary.  # noqa: E501
196        :type: LockInformation
197        """
198
199        self._lock_information = lock_information
200
201    @property
202    def purge_state(self):
203        """Gets the purge_state of this EnvelopeUpdateSummary.  # noqa: E501
204
205          # noqa: E501
206
207        :return: The purge_state of this EnvelopeUpdateSummary.  # noqa: E501
208        :rtype: str
209        """
210        return self._purge_state
211
212    @purge_state.setter
213    def purge_state(self, purge_state):
214        """Sets the purge_state of this EnvelopeUpdateSummary.
215
216          # noqa: E501
217
218        :param purge_state: The purge_state of this EnvelopeUpdateSummary.  # noqa: E501
219        :type: str
220        """
221
222        self._purge_state = purge_state
223
224    @property
225    def recipient_update_results(self):
226        """Gets the recipient_update_results of this EnvelopeUpdateSummary.  # noqa: E501
227
228          # noqa: E501
229
230        :return: The recipient_update_results of this EnvelopeUpdateSummary.  # noqa: E501
231        :rtype: list[RecipientUpdateResponse]
232        """
233        return self._recipient_update_results
234
235    @recipient_update_results.setter
236    def recipient_update_results(self, recipient_update_results):
237        """Sets the recipient_update_results of this EnvelopeUpdateSummary.
238
239          # noqa: E501
240
241        :param recipient_update_results: The recipient_update_results of this EnvelopeUpdateSummary.  # noqa: E501
242        :type: list[RecipientUpdateResponse]
243        """
244
245        self._recipient_update_results = recipient_update_results
246
247    @property
248    def tab_update_results(self):
249        """Gets the tab_update_results of this EnvelopeUpdateSummary.  # noqa: E501
250
251          # noqa: E501
252
253        :return: The tab_update_results of this EnvelopeUpdateSummary.  # noqa: E501
254        :rtype: Tabs
255        """
256        return self._tab_update_results
257
258    @tab_update_results.setter
259    def tab_update_results(self, tab_update_results):
260        """Sets the tab_update_results of this EnvelopeUpdateSummary.
261
262          # noqa: E501
263
264        :param tab_update_results: The tab_update_results of this EnvelopeUpdateSummary.  # noqa: E501
265        :type: Tabs
266        """
267
268        self._tab_update_results = tab_update_results
269
270    @property
271    def text_custom_field_update_results(self):
272        """Gets the text_custom_field_update_results of this EnvelopeUpdateSummary.  # noqa: E501
273
274          # noqa: E501
275
276        :return: The text_custom_field_update_results of this EnvelopeUpdateSummary.  # noqa: E501
277        :rtype: list[TextCustomField]
278        """
279        return self._text_custom_field_update_results
280
281    @text_custom_field_update_results.setter
282    def text_custom_field_update_results(self, text_custom_field_update_results):
283        """Sets the text_custom_field_update_results of this EnvelopeUpdateSummary.
284
285          # noqa: E501
286
287        :param text_custom_field_update_results: The text_custom_field_update_results of this EnvelopeUpdateSummary.  # noqa: E501
288        :type: list[TextCustomField]
289        """
290
291        self._text_custom_field_update_results = text_custom_field_update_results
292
293    def to_dict(self):
294        """Returns the model properties as a dict"""
295        result = {}
296
297        for attr, _ in six.iteritems(self.swagger_types):
298            value = getattr(self, attr)
299            if isinstance(value, list):
300                result[attr] = list(map(
301                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
302                    value
303                ))
304            elif hasattr(value, "to_dict"):
305                result[attr] = value.to_dict()
306            elif isinstance(value, dict):
307                result[attr] = dict(map(
308                    lambda item: (item[0], item[1].to_dict())
309                    if hasattr(item[1], "to_dict") else item,
310                    value.items()
311                ))
312            else:
313                result[attr] = value
314        if issubclass(EnvelopeUpdateSummary, dict):
315            for key, value in self.items():
316                result[key] = value
317
318        return result
319
320    def to_str(self):
321        """Returns the string representation of the model"""
322        return pprint.pformat(self.to_dict())
323
324    def __repr__(self):
325        """For `print` and `pprint`"""
326        return self.to_str()
327
328    def __eq__(self, other):
329        """Returns true if both objects are equal"""
330        if not isinstance(other, EnvelopeUpdateSummary):
331            return False
332
333        return self.to_dict() == other.to_dict()
334
335    def __ne__(self, other):
336        """Returns true if both objects are not equal"""
337        if not isinstance(other, EnvelopeUpdateSummary):
338            return True
339
340        return self.to_dict() != other.to_dict()