docusign_esign.models.bulk_envelope_status

  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 BulkEnvelopeStatus(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        'batch_id': 'str',
 37        'batch_size': 'str',
 38        'bulk_envelopes': 'list[BulkEnvelope]',
 39        'bulk_envelopes_batch_uri': 'str',
 40        'end_position': 'str',
 41        'failed': 'str',
 42        'next_uri': 'str',
 43        'previous_uri': 'str',
 44        'queued': 'str',
 45        'result_set_size': 'str',
 46        'sent': 'str',
 47        'start_position': 'str',
 48        'submitted_date': 'str',
 49        'total_set_size': 'str'
 50    }
 51
 52    attribute_map = {
 53        'batch_id': 'batchId',
 54        'batch_size': 'batchSize',
 55        'bulk_envelopes': 'bulkEnvelopes',
 56        'bulk_envelopes_batch_uri': 'bulkEnvelopesBatchUri',
 57        'end_position': 'endPosition',
 58        'failed': 'failed',
 59        'next_uri': 'nextUri',
 60        'previous_uri': 'previousUri',
 61        'queued': 'queued',
 62        'result_set_size': 'resultSetSize',
 63        'sent': 'sent',
 64        'start_position': 'startPosition',
 65        'submitted_date': 'submittedDate',
 66        'total_set_size': 'totalSetSize'
 67    }
 68
 69    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 70        """BulkEnvelopeStatus - a model defined in Swagger"""  # noqa: E501
 71        if _configuration is None:
 72            _configuration = Configuration()
 73        self._configuration = _configuration
 74
 75        self._batch_id = None
 76        self._batch_size = None
 77        self._bulk_envelopes = None
 78        self._bulk_envelopes_batch_uri = None
 79        self._end_position = None
 80        self._failed = None
 81        self._next_uri = None
 82        self._previous_uri = None
 83        self._queued = None
 84        self._result_set_size = None
 85        self._sent = None
 86        self._start_position = None
 87        self._submitted_date = None
 88        self._total_set_size = None
 89        self.discriminator = None
 90
 91        setattr(self, "_{}".format('batch_id'), kwargs.get('batch_id', None))
 92        setattr(self, "_{}".format('batch_size'), kwargs.get('batch_size', None))
 93        setattr(self, "_{}".format('bulk_envelopes'), kwargs.get('bulk_envelopes', None))
 94        setattr(self, "_{}".format('bulk_envelopes_batch_uri'), kwargs.get('bulk_envelopes_batch_uri', None))
 95        setattr(self, "_{}".format('end_position'), kwargs.get('end_position', None))
 96        setattr(self, "_{}".format('failed'), kwargs.get('failed', None))
 97        setattr(self, "_{}".format('next_uri'), kwargs.get('next_uri', None))
 98        setattr(self, "_{}".format('previous_uri'), kwargs.get('previous_uri', None))
 99        setattr(self, "_{}".format('queued'), kwargs.get('queued', None))
100        setattr(self, "_{}".format('result_set_size'), kwargs.get('result_set_size', None))
101        setattr(self, "_{}".format('sent'), kwargs.get('sent', None))
102        setattr(self, "_{}".format('start_position'), kwargs.get('start_position', None))
103        setattr(self, "_{}".format('submitted_date'), kwargs.get('submitted_date', None))
104        setattr(self, "_{}".format('total_set_size'), kwargs.get('total_set_size', None))
105
106    @property
107    def batch_id(self):
108        """Gets the batch_id of this BulkEnvelopeStatus.  # noqa: E501
109
110        Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.  # noqa: E501
111
112        :return: The batch_id of this BulkEnvelopeStatus.  # noqa: E501
113        :rtype: str
114        """
115        return self._batch_id
116
117    @batch_id.setter
118    def batch_id(self, batch_id):
119        """Sets the batch_id of this BulkEnvelopeStatus.
120
121        Specifies an identifier which can be used to retrieve a more detailed status of individual bulk recipient batches.  # noqa: E501
122
123        :param batch_id: The batch_id of this BulkEnvelopeStatus.  # noqa: E501
124        :type: str
125        """
126
127        self._batch_id = batch_id
128
129    @property
130    def batch_size(self):
131        """Gets the batch_size of this BulkEnvelopeStatus.  # noqa: E501
132
133        The number of items returned in this response.  # noqa: E501
134
135        :return: The batch_size of this BulkEnvelopeStatus.  # noqa: E501
136        :rtype: str
137        """
138        return self._batch_size
139
140    @batch_size.setter
141    def batch_size(self, batch_size):
142        """Sets the batch_size of this BulkEnvelopeStatus.
143
144        The number of items returned in this response.  # noqa: E501
145
146        :param batch_size: The batch_size of this BulkEnvelopeStatus.  # noqa: E501
147        :type: str
148        """
149
150        self._batch_size = batch_size
151
152    @property
153    def bulk_envelopes(self):
154        """Gets the bulk_envelopes of this BulkEnvelopeStatus.  # noqa: E501
155
156        Reserved: TBD  # noqa: E501
157
158        :return: The bulk_envelopes of this BulkEnvelopeStatus.  # noqa: E501
159        :rtype: list[BulkEnvelope]
160        """
161        return self._bulk_envelopes
162
163    @bulk_envelopes.setter
164    def bulk_envelopes(self, bulk_envelopes):
165        """Sets the bulk_envelopes of this BulkEnvelopeStatus.
166
167        Reserved: TBD  # noqa: E501
168
169        :param bulk_envelopes: The bulk_envelopes of this BulkEnvelopeStatus.  # noqa: E501
170        :type: list[BulkEnvelope]
171        """
172
173        self._bulk_envelopes = bulk_envelopes
174
175    @property
176    def bulk_envelopes_batch_uri(self):
177        """Gets the bulk_envelopes_batch_uri of this BulkEnvelopeStatus.  # noqa: E501
178
179        Reserved: TBD  # noqa: E501
180
181        :return: The bulk_envelopes_batch_uri of this BulkEnvelopeStatus.  # noqa: E501
182        :rtype: str
183        """
184        return self._bulk_envelopes_batch_uri
185
186    @bulk_envelopes_batch_uri.setter
187    def bulk_envelopes_batch_uri(self, bulk_envelopes_batch_uri):
188        """Sets the bulk_envelopes_batch_uri of this BulkEnvelopeStatus.
189
190        Reserved: TBD  # noqa: E501
191
192        :param bulk_envelopes_batch_uri: The bulk_envelopes_batch_uri of this BulkEnvelopeStatus.  # noqa: E501
193        :type: str
194        """
195
196        self._bulk_envelopes_batch_uri = bulk_envelopes_batch_uri
197
198    @property
199    def end_position(self):
200        """Gets the end_position of this BulkEnvelopeStatus.  # noqa: E501
201
202        The last position in the result set.   # noqa: E501
203
204        :return: The end_position of this BulkEnvelopeStatus.  # noqa: E501
205        :rtype: str
206        """
207        return self._end_position
208
209    @end_position.setter
210    def end_position(self, end_position):
211        """Sets the end_position of this BulkEnvelopeStatus.
212
213        The last position in the result set.   # noqa: E501
214
215        :param end_position: The end_position of this BulkEnvelopeStatus.  # noqa: E501
216        :type: str
217        """
218
219        self._end_position = end_position
220
221    @property
222    def failed(self):
223        """Gets the failed of this BulkEnvelopeStatus.  # noqa: E501
224
225        The number of entries with a status of failed.   # noqa: E501
226
227        :return: The failed of this BulkEnvelopeStatus.  # noqa: E501
228        :rtype: str
229        """
230        return self._failed
231
232    @failed.setter
233    def failed(self, failed):
234        """Sets the failed of this BulkEnvelopeStatus.
235
236        The number of entries with a status of failed.   # noqa: E501
237
238        :param failed: The failed of this BulkEnvelopeStatus.  # noqa: E501
239        :type: str
240        """
241
242        self._failed = failed
243
244    @property
245    def next_uri(self):
246        """Gets the next_uri of this BulkEnvelopeStatus.  # noqa: E501
247
248        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
249
250        :return: The next_uri of this BulkEnvelopeStatus.  # noqa: E501
251        :rtype: str
252        """
253        return self._next_uri
254
255    @next_uri.setter
256    def next_uri(self, next_uri):
257        """Sets the next_uri of this BulkEnvelopeStatus.
258
259        The URI to the next chunk of records based on the search request. If the endPosition is the entire results of the search, this is null.   # noqa: E501
260
261        :param next_uri: The next_uri of this BulkEnvelopeStatus.  # noqa: E501
262        :type: str
263        """
264
265        self._next_uri = next_uri
266
267    @property
268    def previous_uri(self):
269        """Gets the previous_uri of this BulkEnvelopeStatus.  # noqa: E501
270
271        The postal code for the billing address.  # noqa: E501
272
273        :return: The previous_uri of this BulkEnvelopeStatus.  # noqa: E501
274        :rtype: str
275        """
276        return self._previous_uri
277
278    @previous_uri.setter
279    def previous_uri(self, previous_uri):
280        """Sets the previous_uri of this BulkEnvelopeStatus.
281
282        The postal code for the billing address.  # noqa: E501
283
284        :param previous_uri: The previous_uri of this BulkEnvelopeStatus.  # noqa: E501
285        :type: str
286        """
287
288        self._previous_uri = previous_uri
289
290    @property
291    def queued(self):
292        """Gets the queued of this BulkEnvelopeStatus.  # noqa: E501
293
294        The number of entries with a status of queued.   # noqa: E501
295
296        :return: The queued of this BulkEnvelopeStatus.  # noqa: E501
297        :rtype: str
298        """
299        return self._queued
300
301    @queued.setter
302    def queued(self, queued):
303        """Sets the queued of this BulkEnvelopeStatus.
304
305        The number of entries with a status of queued.   # noqa: E501
306
307        :param queued: The queued of this BulkEnvelopeStatus.  # noqa: E501
308        :type: str
309        """
310
311        self._queued = queued
312
313    @property
314    def result_set_size(self):
315        """Gets the result_set_size of this BulkEnvelopeStatus.  # noqa: E501
316
317        The number of results returned in this response.   # noqa: E501
318
319        :return: The result_set_size of this BulkEnvelopeStatus.  # noqa: E501
320        :rtype: str
321        """
322        return self._result_set_size
323
324    @result_set_size.setter
325    def result_set_size(self, result_set_size):
326        """Sets the result_set_size of this BulkEnvelopeStatus.
327
328        The number of results returned in this response.   # noqa: E501
329
330        :param result_set_size: The result_set_size of this BulkEnvelopeStatus.  # noqa: E501
331        :type: str
332        """
333
334        self._result_set_size = result_set_size
335
336    @property
337    def sent(self):
338        """Gets the sent of this BulkEnvelopeStatus.  # noqa: E501
339
340        The number of entries with a status of sent.  # noqa: E501
341
342        :return: The sent of this BulkEnvelopeStatus.  # noqa: E501
343        :rtype: str
344        """
345        return self._sent
346
347    @sent.setter
348    def sent(self, sent):
349        """Sets the sent of this BulkEnvelopeStatus.
350
351        The number of entries with a status of sent.  # noqa: E501
352
353        :param sent: The sent of this BulkEnvelopeStatus.  # noqa: E501
354        :type: str
355        """
356
357        self._sent = sent
358
359    @property
360    def start_position(self):
361        """Gets the start_position of this BulkEnvelopeStatus.  # noqa: E501
362
363        Starting position of the current result set.  # noqa: E501
364
365        :return: The start_position of this BulkEnvelopeStatus.  # noqa: E501
366        :rtype: str
367        """
368        return self._start_position
369
370    @start_position.setter
371    def start_position(self, start_position):
372        """Sets the start_position of this BulkEnvelopeStatus.
373
374        Starting position of the current result set.  # noqa: E501
375
376        :param start_position: The start_position of this BulkEnvelopeStatus.  # noqa: E501
377        :type: str
378        """
379
380        self._start_position = start_position
381
382    @property
383    def submitted_date(self):
384        """Gets the submitted_date of this BulkEnvelopeStatus.  # noqa: E501
385
386          # noqa: E501
387
388        :return: The submitted_date of this BulkEnvelopeStatus.  # noqa: E501
389        :rtype: str
390        """
391        return self._submitted_date
392
393    @submitted_date.setter
394    def submitted_date(self, submitted_date):
395        """Sets the submitted_date of this BulkEnvelopeStatus.
396
397          # noqa: E501
398
399        :param submitted_date: The submitted_date of this BulkEnvelopeStatus.  # noqa: E501
400        :type: str
401        """
402
403        self._submitted_date = submitted_date
404
405    @property
406    def total_set_size(self):
407        """Gets the total_set_size of this BulkEnvelopeStatus.  # noqa: E501
408
409        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
410
411        :return: The total_set_size of this BulkEnvelopeStatus.  # noqa: E501
412        :rtype: str
413        """
414        return self._total_set_size
415
416    @total_set_size.setter
417    def total_set_size(self, total_set_size):
418        """Sets the total_set_size of this BulkEnvelopeStatus.
419
420        The total number of items available in the result set. This will always be greater than or equal to the value of the property returning the results in the in the response.  # noqa: E501
421
422        :param total_set_size: The total_set_size of this BulkEnvelopeStatus.  # noqa: E501
423        :type: str
424        """
425
426        self._total_set_size = total_set_size
427
428    def to_dict(self):
429        """Returns the model properties as a dict"""
430        result = {}
431
432        for attr, _ in six.iteritems(self.swagger_types):
433            value = getattr(self, attr)
434            if isinstance(value, list):
435                result[attr] = list(map(
436                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
437                    value
438                ))
439            elif hasattr(value, "to_dict"):
440                result[attr] = value.to_dict()
441            elif isinstance(value, dict):
442                result[attr] = dict(map(
443                    lambda item: (item[0], item[1].to_dict())
444                    if hasattr(item[1], "to_dict") else item,
445                    value.items()
446                ))
447            else:
448                result[attr] = value
449        if issubclass(BulkEnvelopeStatus, dict):
450            for key, value in self.items():
451                result[key] = value
452
453        return result
454
455    def to_str(self):
456        """Returns the string representation of the model"""
457        return pprint.pformat(self.to_dict())
458
459    def __repr__(self):
460        """For `print` and `pprint`"""
461        return self.to_str()
462
463    def __eq__(self, other):
464        """Returns true if both objects are equal"""
465        if not isinstance(other, BulkEnvelopeStatus):
466            return False
467
468        return self.to_dict() == other.to_dict()
469
470    def __ne__(self, other):
471        """Returns true if both objects are not equal"""
472        if not isinstance(other, BulkEnvelopeStatus):
473            return True
474
475        return self.to_dict() != other.to_dict()