docusign_esign.models.bulk_envelope

  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 BulkEnvelope(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_recipient_row': 'str',
 37        'bulk_status': 'str',
 38        'email': 'str',
 39        'envelope_id': 'str',
 40        'envelope_uri': 'str',
 41        'error_details': 'ErrorDetails',
 42        'name': 'str',
 43        'submitted_date_time': 'str',
 44        'transaction_id': 'str'
 45    }
 46
 47    attribute_map = {
 48        'bulk_recipient_row': 'bulkRecipientRow',
 49        'bulk_status': 'bulkStatus',
 50        'email': 'email',
 51        'envelope_id': 'envelopeId',
 52        'envelope_uri': 'envelopeUri',
 53        'error_details': 'errorDetails',
 54        'name': 'name',
 55        'submitted_date_time': 'submittedDateTime',
 56        'transaction_id': 'transactionId'
 57    }
 58
 59    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 60        """BulkEnvelope - a model defined in Swagger"""  # noqa: E501
 61        if _configuration is None:
 62            _configuration = Configuration()
 63        self._configuration = _configuration
 64
 65        self._bulk_recipient_row = None
 66        self._bulk_status = None
 67        self._email = None
 68        self._envelope_id = None
 69        self._envelope_uri = None
 70        self._error_details = None
 71        self._name = None
 72        self._submitted_date_time = None
 73        self._transaction_id = None
 74        self.discriminator = None
 75
 76        setattr(self, "_{}".format('bulk_recipient_row'), kwargs.get('bulk_recipient_row', None))
 77        setattr(self, "_{}".format('bulk_status'), kwargs.get('bulk_status', None))
 78        setattr(self, "_{}".format('email'), kwargs.get('email', None))
 79        setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None))
 80        setattr(self, "_{}".format('envelope_uri'), kwargs.get('envelope_uri', None))
 81        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 82        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 83        setattr(self, "_{}".format('submitted_date_time'), kwargs.get('submitted_date_time', None))
 84        setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None))
 85
 86    @property
 87    def bulk_recipient_row(self):
 88        """Gets the bulk_recipient_row of this BulkEnvelope.  # noqa: E501
 89
 90        Reserved: TBD  # noqa: E501
 91
 92        :return: The bulk_recipient_row of this BulkEnvelope.  # noqa: E501
 93        :rtype: str
 94        """
 95        return self._bulk_recipient_row
 96
 97    @bulk_recipient_row.setter
 98    def bulk_recipient_row(self, bulk_recipient_row):
 99        """Sets the bulk_recipient_row of this BulkEnvelope.
100
101        Reserved: TBD  # noqa: E501
102
103        :param bulk_recipient_row: The bulk_recipient_row of this BulkEnvelope.  # noqa: E501
104        :type: str
105        """
106
107        self._bulk_recipient_row = bulk_recipient_row
108
109    @property
110    def bulk_status(self):
111        """Gets the bulk_status of this BulkEnvelope.  # noqa: E501
112
113        Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed  # noqa: E501
114
115        :return: The bulk_status of this BulkEnvelope.  # noqa: E501
116        :rtype: str
117        """
118        return self._bulk_status
119
120    @bulk_status.setter
121    def bulk_status(self, bulk_status):
122        """Sets the bulk_status of this BulkEnvelope.
123
124        Indicates the status of the bulk send operation. Returned values can be: * queued * processing * sent * failed  # noqa: E501
125
126        :param bulk_status: The bulk_status of this BulkEnvelope.  # noqa: E501
127        :type: str
128        """
129
130        self._bulk_status = bulk_status
131
132    @property
133    def email(self):
134        """Gets the email of this BulkEnvelope.  # noqa: E501
135
136          # noqa: E501
137
138        :return: The email of this BulkEnvelope.  # noqa: E501
139        :rtype: str
140        """
141        return self._email
142
143    @email.setter
144    def email(self, email):
145        """Sets the email of this BulkEnvelope.
146
147          # noqa: E501
148
149        :param email: The email of this BulkEnvelope.  # noqa: E501
150        :type: str
151        """
152
153        self._email = email
154
155    @property
156    def envelope_id(self):
157        """Gets the envelope_id of this BulkEnvelope.  # noqa: E501
158
159        The envelope ID of the envelope status that failed to post.  # noqa: E501
160
161        :return: The envelope_id of this BulkEnvelope.  # noqa: E501
162        :rtype: str
163        """
164        return self._envelope_id
165
166    @envelope_id.setter
167    def envelope_id(self, envelope_id):
168        """Sets the envelope_id of this BulkEnvelope.
169
170        The envelope ID of the envelope status that failed to post.  # noqa: E501
171
172        :param envelope_id: The envelope_id of this BulkEnvelope.  # noqa: E501
173        :type: str
174        """
175
176        self._envelope_id = envelope_id
177
178    @property
179    def envelope_uri(self):
180        """Gets the envelope_uri of this BulkEnvelope.  # noqa: E501
181
182        Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.  # noqa: E501
183
184        :return: The envelope_uri of this BulkEnvelope.  # noqa: E501
185        :rtype: str
186        """
187        return self._envelope_uri
188
189    @envelope_uri.setter
190    def envelope_uri(self, envelope_uri):
191        """Sets the envelope_uri of this BulkEnvelope.
192
193        Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.  # noqa: E501
194
195        :param envelope_uri: The envelope_uri of this BulkEnvelope.  # noqa: E501
196        :type: str
197        """
198
199        self._envelope_uri = envelope_uri
200
201    @property
202    def error_details(self):
203        """Gets the error_details of this BulkEnvelope.  # noqa: E501
204
205        Array or errors.  # noqa: E501
206
207        :return: The error_details of this BulkEnvelope.  # noqa: E501
208        :rtype: ErrorDetails
209        """
210        return self._error_details
211
212    @error_details.setter
213    def error_details(self, error_details):
214        """Sets the error_details of this BulkEnvelope.
215
216        Array or errors.  # noqa: E501
217
218        :param error_details: The error_details of this BulkEnvelope.  # noqa: E501
219        :type: ErrorDetails
220        """
221
222        self._error_details = error_details
223
224    @property
225    def name(self):
226        """Gets the name of this BulkEnvelope.  # noqa: E501
227
228          # noqa: E501
229
230        :return: The name of this BulkEnvelope.  # noqa: E501
231        :rtype: str
232        """
233        return self._name
234
235    @name.setter
236    def name(self, name):
237        """Sets the name of this BulkEnvelope.
238
239          # noqa: E501
240
241        :param name: The name of this BulkEnvelope.  # noqa: E501
242        :type: str
243        """
244
245        self._name = name
246
247    @property
248    def submitted_date_time(self):
249        """Gets the submitted_date_time of this BulkEnvelope.  # noqa: E501
250
251          # noqa: E501
252
253        :return: The submitted_date_time of this BulkEnvelope.  # noqa: E501
254        :rtype: str
255        """
256        return self._submitted_date_time
257
258    @submitted_date_time.setter
259    def submitted_date_time(self, submitted_date_time):
260        """Sets the submitted_date_time of this BulkEnvelope.
261
262          # noqa: E501
263
264        :param submitted_date_time: The submitted_date_time of this BulkEnvelope.  # noqa: E501
265        :type: str
266        """
267
268        self._submitted_date_time = submitted_date_time
269
270    @property
271    def transaction_id(self):
272        """Gets the transaction_id of this BulkEnvelope.  # noqa: E501
273
274         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.  # noqa: E501
275
276        :return: The transaction_id of this BulkEnvelope.  # noqa: E501
277        :rtype: str
278        """
279        return self._transaction_id
280
281    @transaction_id.setter
282    def transaction_id(self, transaction_id):
283        """Sets the transaction_id of this BulkEnvelope.
284
285         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.  # noqa: E501
286
287        :param transaction_id: The transaction_id of this BulkEnvelope.  # noqa: E501
288        :type: str
289        """
290
291        self._transaction_id = transaction_id
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(BulkEnvelope, 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, BulkEnvelope):
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, BulkEnvelope):
338            return True
339
340        return self.to_dict() != other.to_dict()