docusign_esign.models.envelope_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 EnvelopeSummary(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        'recipient_signing_uri': 'str',
 40        'recipient_signing_uri_error': 'str',
 41        'status': 'str',
 42        'status_date_time': 'str',
 43        'uri': 'str'
 44    }
 45
 46    attribute_map = {
 47        'bulk_envelope_status': 'bulkEnvelopeStatus',
 48        'envelope_id': 'envelopeId',
 49        'error_details': 'errorDetails',
 50        'recipient_signing_uri': 'recipientSigningUri',
 51        'recipient_signing_uri_error': 'recipientSigningUriError',
 52        'status': 'status',
 53        'status_date_time': 'statusDateTime',
 54        'uri': 'uri'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """EnvelopeSummary - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._bulk_envelope_status = None
 64        self._envelope_id = None
 65        self._error_details = None
 66        self._recipient_signing_uri = None
 67        self._recipient_signing_uri_error = None
 68        self._status = None
 69        self._status_date_time = None
 70        self._uri = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('bulk_envelope_status'), kwargs.get('bulk_envelope_status', None))
 74        setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
 75        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 76        setattr(self, "_{}".format('recipient_signing_uri'), kwargs.get('recipient_signing_uri', None))
 77        setattr(self, "_{}".format('recipient_signing_uri_error'), kwargs.get('recipient_signing_uri_error', None))
 78        setattr(self, "_{}".format('status'), kwargs.get('status', None))
 79        setattr(self, "_{}".format('status_date_time'), kwargs.get('status_date_time', None))
 80        setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
 81
 82    @property
 83    def bulk_envelope_status(self):
 84        """Gets the bulk_envelope_status of this EnvelopeSummary.  # noqa: E501
 85
 86        An object that describes the status of the bulk send envelopes.  # noqa: E501
 87
 88        :return: The bulk_envelope_status of this EnvelopeSummary.  # noqa: E501
 89        :rtype: BulkEnvelopeStatus
 90        """
 91        return self._bulk_envelope_status
 92
 93    @bulk_envelope_status.setter
 94    def bulk_envelope_status(self, bulk_envelope_status):
 95        """Sets the bulk_envelope_status of this EnvelopeSummary.
 96
 97        An object that describes the status of the bulk send envelopes.  # noqa: E501
 98
 99        :param bulk_envelope_status: The bulk_envelope_status of this EnvelopeSummary.  # noqa: E501
100        :type: BulkEnvelopeStatus
101        """
102
103        self._bulk_envelope_status = bulk_envelope_status
104
105    @property
106    def envelope_id(self):
107        """Gets the envelope_id of this EnvelopeSummary.  # noqa: E501
108
109        The envelope ID of the envelope status that failed to post.  # noqa: E501
110
111        :return: The envelope_id of this EnvelopeSummary.  # noqa: E501
112        :rtype: str
113        """
114        return self._envelope_id
115
116    @envelope_id.setter
117    def envelope_id(self, envelope_id):
118        """Sets the envelope_id of this EnvelopeSummary.
119
120        The envelope ID of the envelope status that failed to post.  # noqa: E501
121
122        :param envelope_id: The envelope_id of this EnvelopeSummary.  # noqa: E501
123        :type: str
124        """
125
126        self._envelope_id = envelope_id
127
128    @property
129    def error_details(self):
130        """Gets the error_details of this EnvelopeSummary.  # noqa: E501
131
132        Array or errors.  # noqa: E501
133
134        :return: The error_details of this EnvelopeSummary.  # noqa: E501
135        :rtype: ErrorDetails
136        """
137        return self._error_details
138
139    @error_details.setter
140    def error_details(self, error_details):
141        """Sets the error_details of this EnvelopeSummary.
142
143        Array or errors.  # noqa: E501
144
145        :param error_details: The error_details of this EnvelopeSummary.  # noqa: E501
146        :type: ErrorDetails
147        """
148
149        self._error_details = error_details
150
151    @property
152    def recipient_signing_uri(self):
153        """Gets the recipient_signing_uri of this EnvelopeSummary.  # noqa: E501
154
155          # noqa: E501
156
157        :return: The recipient_signing_uri of this EnvelopeSummary.  # noqa: E501
158        :rtype: str
159        """
160        return self._recipient_signing_uri
161
162    @recipient_signing_uri.setter
163    def recipient_signing_uri(self, recipient_signing_uri):
164        """Sets the recipient_signing_uri of this EnvelopeSummary.
165
166          # noqa: E501
167
168        :param recipient_signing_uri: The recipient_signing_uri of this EnvelopeSummary.  # noqa: E501
169        :type: str
170        """
171
172        self._recipient_signing_uri = recipient_signing_uri
173
174    @property
175    def recipient_signing_uri_error(self):
176        """Gets the recipient_signing_uri_error of this EnvelopeSummary.  # noqa: E501
177
178          # noqa: E501
179
180        :return: The recipient_signing_uri_error of this EnvelopeSummary.  # noqa: E501
181        :rtype: str
182        """
183        return self._recipient_signing_uri_error
184
185    @recipient_signing_uri_error.setter
186    def recipient_signing_uri_error(self, recipient_signing_uri_error):
187        """Sets the recipient_signing_uri_error of this EnvelopeSummary.
188
189          # noqa: E501
190
191        :param recipient_signing_uri_error: The recipient_signing_uri_error of this EnvelopeSummary.  # noqa: E501
192        :type: str
193        """
194
195        self._recipient_signing_uri_error = recipient_signing_uri_error
196
197    @property
198    def status(self):
199        """Gets the status of this EnvelopeSummary.  # noqa: E501
200
201        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
202
203        :return: The status of this EnvelopeSummary.  # noqa: E501
204        :rtype: str
205        """
206        return self._status
207
208    @status.setter
209    def status(self, status):
210        """Sets the status of this EnvelopeSummary.
211
212        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.  # noqa: E501
213
214        :param status: The status of this EnvelopeSummary.  # noqa: E501
215        :type: str
216        """
217
218        self._status = status
219
220    @property
221    def status_date_time(self):
222        """Gets the status_date_time of this EnvelopeSummary.  # noqa: E501
223
224        The DateTime that the envelope changed status (i.e. was created or sent.)  # noqa: E501
225
226        :return: The status_date_time of this EnvelopeSummary.  # noqa: E501
227        :rtype: str
228        """
229        return self._status_date_time
230
231    @status_date_time.setter
232    def status_date_time(self, status_date_time):
233        """Sets the status_date_time of this EnvelopeSummary.
234
235        The DateTime that the envelope changed status (i.e. was created or sent.)  # noqa: E501
236
237        :param status_date_time: The status_date_time of this EnvelopeSummary.  # noqa: E501
238        :type: str
239        """
240
241        self._status_date_time = status_date_time
242
243    @property
244    def uri(self):
245        """Gets the uri of this EnvelopeSummary.  # noqa: E501
246
247          # noqa: E501
248
249        :return: The uri of this EnvelopeSummary.  # noqa: E501
250        :rtype: str
251        """
252        return self._uri
253
254    @uri.setter
255    def uri(self, uri):
256        """Sets the uri of this EnvelopeSummary.
257
258          # noqa: E501
259
260        :param uri: The uri of this EnvelopeSummary.  # noqa: E501
261        :type: str
262        """
263
264        self._uri = uri
265
266    def to_dict(self):
267        """Returns the model properties as a dict"""
268        result = {}
269
270        for attr, _ in six.iteritems(self.swagger_types):
271            value = getattr(self, attr)
272            if isinstance(value, list):
273                result[attr] = list(map(
274                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
275                    value
276                ))
277            elif hasattr(value, "to_dict"):
278                result[attr] = value.to_dict()
279            elif isinstance(value, dict):
280                result[attr] = dict(map(
281                    lambda item: (item[0], item[1].to_dict())
282                    if hasattr(item[1], "to_dict") else item,
283                    value.items()
284                ))
285            else:
286                result[attr] = value
287        if issubclass(EnvelopeSummary, dict):
288            for key, value in self.items():
289                result[key] = value
290
291        return result
292
293    def to_str(self):
294        """Returns the string representation of the model"""
295        return pprint.pformat(self.to_dict())
296
297    def __repr__(self):
298        """For `print` and `pprint`"""
299        return self.to_str()
300
301    def __eq__(self, other):
302        """Returns true if both objects are equal"""
303        if not isinstance(other, EnvelopeSummary):
304            return False
305
306        return self.to_dict() == other.to_dict()
307
308    def __ne__(self, other):
309        """Returns true if both objects are not equal"""
310        if not isinstance(other, EnvelopeSummary):
311            return True
312
313        return self.to_dict() != other.to_dict()