docusign_esign.models.bulk_send_response

Docusign eSignature REST API

The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501

OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git

  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 BulkSendResponse(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_name': 'str',
 38        'batch_size': 'str',
 39        'envelope_or_template_id': 'str',
 40        'error_details': 'list[str]',
 41        'errors': 'list[str]',
 42        'queue_limit': 'str',
 43        'total_queued': 'str'
 44    }
 45
 46    attribute_map = {
 47        'batch_id': 'batchId',
 48        'batch_name': 'batchName',
 49        'batch_size': 'batchSize',
 50        'envelope_or_template_id': 'envelopeOrTemplateId',
 51        'error_details': 'errorDetails',
 52        'errors': 'errors',
 53        'queue_limit': 'queueLimit',
 54        'total_queued': 'totalQueued'
 55    }
 56
 57    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 58        """BulkSendResponse - a model defined in Swagger"""  # noqa: E501
 59        if _configuration is None:
 60            _configuration = Configuration()
 61        self._configuration = _configuration
 62
 63        self._batch_id = None
 64        self._batch_name = None
 65        self._batch_size = None
 66        self._envelope_or_template_id = None
 67        self._error_details = None
 68        self._errors = None
 69        self._queue_limit = None
 70        self._total_queued = None
 71        self.discriminator = None
 72
 73        setattr(self, "_{}".format('batch_id'), kwargs.get('batch_id', None))
 74        setattr(self, "_{}".format('batch_name'), kwargs.get('batch_name', None))
 75        setattr(self, "_{}".format('batch_size'), kwargs.get('batch_size', None))
 76        setattr(self, "_{}".format('envelope_or_template_id'), kwargs.get('envelope_or_template_id', None))
 77        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 78        setattr(self, "_{}".format('errors'), kwargs.get('errors', None))
 79        setattr(self, "_{}".format('queue_limit'), kwargs.get('queue_limit', None))
 80        setattr(self, "_{}".format('total_queued'), kwargs.get('total_queued', None))
 81
 82    @property
 83    def batch_id(self):
 84        """Gets the batch_id of this BulkSendResponse.  # noqa: E501
 85
 86          # noqa: E501
 87
 88        :return: The batch_id of this BulkSendResponse.  # noqa: E501
 89        :rtype: str
 90        """
 91        return self._batch_id
 92
 93    @batch_id.setter
 94    def batch_id(self, batch_id):
 95        """Sets the batch_id of this BulkSendResponse.
 96
 97          # noqa: E501
 98
 99        :param batch_id: The batch_id of this BulkSendResponse.  # noqa: E501
100        :type: str
101        """
102
103        self._batch_id = batch_id
104
105    @property
106    def batch_name(self):
107        """Gets the batch_name of this BulkSendResponse.  # noqa: E501
108
109          # noqa: E501
110
111        :return: The batch_name of this BulkSendResponse.  # noqa: E501
112        :rtype: str
113        """
114        return self._batch_name
115
116    @batch_name.setter
117    def batch_name(self, batch_name):
118        """Sets the batch_name of this BulkSendResponse.
119
120          # noqa: E501
121
122        :param batch_name: The batch_name of this BulkSendResponse.  # noqa: E501
123        :type: str
124        """
125
126        self._batch_name = batch_name
127
128    @property
129    def batch_size(self):
130        """Gets the batch_size of this BulkSendResponse.  # noqa: E501
131
132          # noqa: E501
133
134        :return: The batch_size of this BulkSendResponse.  # noqa: E501
135        :rtype: str
136        """
137        return self._batch_size
138
139    @batch_size.setter
140    def batch_size(self, batch_size):
141        """Sets the batch_size of this BulkSendResponse.
142
143          # noqa: E501
144
145        :param batch_size: The batch_size of this BulkSendResponse.  # noqa: E501
146        :type: str
147        """
148
149        self._batch_size = batch_size
150
151    @property
152    def envelope_or_template_id(self):
153        """Gets the envelope_or_template_id of this BulkSendResponse.  # noqa: E501
154
155          # noqa: E501
156
157        :return: The envelope_or_template_id of this BulkSendResponse.  # noqa: E501
158        :rtype: str
159        """
160        return self._envelope_or_template_id
161
162    @envelope_or_template_id.setter
163    def envelope_or_template_id(self, envelope_or_template_id):
164        """Sets the envelope_or_template_id of this BulkSendResponse.
165
166          # noqa: E501
167
168        :param envelope_or_template_id: The envelope_or_template_id of this BulkSendResponse.  # noqa: E501
169        :type: str
170        """
171
172        self._envelope_or_template_id = envelope_or_template_id
173
174    @property
175    def error_details(self):
176        """Gets the error_details of this BulkSendResponse.  # noqa: E501
177
178        Array or errors.  # noqa: E501
179
180        :return: The error_details of this BulkSendResponse.  # noqa: E501
181        :rtype: list[str]
182        """
183        return self._error_details
184
185    @error_details.setter
186    def error_details(self, error_details):
187        """Sets the error_details of this BulkSendResponse.
188
189        Array or errors.  # noqa: E501
190
191        :param error_details: The error_details of this BulkSendResponse.  # noqa: E501
192        :type: list[str]
193        """
194
195        self._error_details = error_details
196
197    @property
198    def errors(self):
199        """Gets the errors of this BulkSendResponse.  # noqa: E501
200
201          # noqa: E501
202
203        :return: The errors of this BulkSendResponse.  # noqa: E501
204        :rtype: list[str]
205        """
206        return self._errors
207
208    @errors.setter
209    def errors(self, errors):
210        """Sets the errors of this BulkSendResponse.
211
212          # noqa: E501
213
214        :param errors: The errors of this BulkSendResponse.  # noqa: E501
215        :type: list[str]
216        """
217
218        self._errors = errors
219
220    @property
221    def queue_limit(self):
222        """Gets the queue_limit of this BulkSendResponse.  # noqa: E501
223
224          # noqa: E501
225
226        :return: The queue_limit of this BulkSendResponse.  # noqa: E501
227        :rtype: str
228        """
229        return self._queue_limit
230
231    @queue_limit.setter
232    def queue_limit(self, queue_limit):
233        """Sets the queue_limit of this BulkSendResponse.
234
235          # noqa: E501
236
237        :param queue_limit: The queue_limit of this BulkSendResponse.  # noqa: E501
238        :type: str
239        """
240
241        self._queue_limit = queue_limit
242
243    @property
244    def total_queued(self):
245        """Gets the total_queued of this BulkSendResponse.  # noqa: E501
246
247          # noqa: E501
248
249        :return: The total_queued of this BulkSendResponse.  # noqa: E501
250        :rtype: str
251        """
252        return self._total_queued
253
254    @total_queued.setter
255    def total_queued(self, total_queued):
256        """Sets the total_queued of this BulkSendResponse.
257
258          # noqa: E501
259
260        :param total_queued: The total_queued of this BulkSendResponse.  # noqa: E501
261        :type: str
262        """
263
264        self._total_queued = total_queued
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(BulkSendResponse, 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, BulkSendResponse):
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, BulkSendResponse):
311            return True
312
313        return self.to_dict() != other.to_dict()
class BulkSendResponse:
 23class BulkSendResponse(object):
 24    """NOTE: This class is auto generated by the swagger code generator program.
 25
 26    Do not edit the class manually.
 27    """
 28
 29    """
 30    Attributes:
 31      swagger_types (dict): The key is attribute name
 32                            and the value is attribute type.
 33      attribute_map (dict): The key is attribute name
 34                            and the value is json key in definition.
 35    """
 36    swagger_types = {
 37        'batch_id': 'str',
 38        'batch_name': 'str',
 39        'batch_size': 'str',
 40        'envelope_or_template_id': 'str',
 41        'error_details': 'list[str]',
 42        'errors': 'list[str]',
 43        'queue_limit': 'str',
 44        'total_queued': 'str'
 45    }
 46
 47    attribute_map = {
 48        'batch_id': 'batchId',
 49        'batch_name': 'batchName',
 50        'batch_size': 'batchSize',
 51        'envelope_or_template_id': 'envelopeOrTemplateId',
 52        'error_details': 'errorDetails',
 53        'errors': 'errors',
 54        'queue_limit': 'queueLimit',
 55        'total_queued': 'totalQueued'
 56    }
 57
 58    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 59        """BulkSendResponse - a model defined in Swagger"""  # noqa: E501
 60        if _configuration is None:
 61            _configuration = Configuration()
 62        self._configuration = _configuration
 63
 64        self._batch_id = None
 65        self._batch_name = None
 66        self._batch_size = None
 67        self._envelope_or_template_id = None
 68        self._error_details = None
 69        self._errors = None
 70        self._queue_limit = None
 71        self._total_queued = None
 72        self.discriminator = None
 73
 74        setattr(self, "_{}".format('batch_id'), kwargs.get('batch_id', None))
 75        setattr(self, "_{}".format('batch_name'), kwargs.get('batch_name', None))
 76        setattr(self, "_{}".format('batch_size'), kwargs.get('batch_size', None))
 77        setattr(self, "_{}".format('envelope_or_template_id'), kwargs.get('envelope_or_template_id', None))
 78        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
 79        setattr(self, "_{}".format('errors'), kwargs.get('errors', None))
 80        setattr(self, "_{}".format('queue_limit'), kwargs.get('queue_limit', None))
 81        setattr(self, "_{}".format('total_queued'), kwargs.get('total_queued', None))
 82
 83    @property
 84    def batch_id(self):
 85        """Gets the batch_id of this BulkSendResponse.  # noqa: E501
 86
 87          # noqa: E501
 88
 89        :return: The batch_id of this BulkSendResponse.  # noqa: E501
 90        :rtype: str
 91        """
 92        return self._batch_id
 93
 94    @batch_id.setter
 95    def batch_id(self, batch_id):
 96        """Sets the batch_id of this BulkSendResponse.
 97
 98          # noqa: E501
 99
100        :param batch_id: The batch_id of this BulkSendResponse.  # noqa: E501
101        :type: str
102        """
103
104        self._batch_id = batch_id
105
106    @property
107    def batch_name(self):
108        """Gets the batch_name of this BulkSendResponse.  # noqa: E501
109
110          # noqa: E501
111
112        :return: The batch_name of this BulkSendResponse.  # noqa: E501
113        :rtype: str
114        """
115        return self._batch_name
116
117    @batch_name.setter
118    def batch_name(self, batch_name):
119        """Sets the batch_name of this BulkSendResponse.
120
121          # noqa: E501
122
123        :param batch_name: The batch_name of this BulkSendResponse.  # noqa: E501
124        :type: str
125        """
126
127        self._batch_name = batch_name
128
129    @property
130    def batch_size(self):
131        """Gets the batch_size of this BulkSendResponse.  # noqa: E501
132
133          # noqa: E501
134
135        :return: The batch_size of this BulkSendResponse.  # 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 BulkSendResponse.
143
144          # noqa: E501
145
146        :param batch_size: The batch_size of this BulkSendResponse.  # noqa: E501
147        :type: str
148        """
149
150        self._batch_size = batch_size
151
152    @property
153    def envelope_or_template_id(self):
154        """Gets the envelope_or_template_id of this BulkSendResponse.  # noqa: E501
155
156          # noqa: E501
157
158        :return: The envelope_or_template_id of this BulkSendResponse.  # noqa: E501
159        :rtype: str
160        """
161        return self._envelope_or_template_id
162
163    @envelope_or_template_id.setter
164    def envelope_or_template_id(self, envelope_or_template_id):
165        """Sets the envelope_or_template_id of this BulkSendResponse.
166
167          # noqa: E501
168
169        :param envelope_or_template_id: The envelope_or_template_id of this BulkSendResponse.  # noqa: E501
170        :type: str
171        """
172
173        self._envelope_or_template_id = envelope_or_template_id
174
175    @property
176    def error_details(self):
177        """Gets the error_details of this BulkSendResponse.  # noqa: E501
178
179        Array or errors.  # noqa: E501
180
181        :return: The error_details of this BulkSendResponse.  # noqa: E501
182        :rtype: list[str]
183        """
184        return self._error_details
185
186    @error_details.setter
187    def error_details(self, error_details):
188        """Sets the error_details of this BulkSendResponse.
189
190        Array or errors.  # noqa: E501
191
192        :param error_details: The error_details of this BulkSendResponse.  # noqa: E501
193        :type: list[str]
194        """
195
196        self._error_details = error_details
197
198    @property
199    def errors(self):
200        """Gets the errors of this BulkSendResponse.  # noqa: E501
201
202          # noqa: E501
203
204        :return: The errors of this BulkSendResponse.  # noqa: E501
205        :rtype: list[str]
206        """
207        return self._errors
208
209    @errors.setter
210    def errors(self, errors):
211        """Sets the errors of this BulkSendResponse.
212
213          # noqa: E501
214
215        :param errors: The errors of this BulkSendResponse.  # noqa: E501
216        :type: list[str]
217        """
218
219        self._errors = errors
220
221    @property
222    def queue_limit(self):
223        """Gets the queue_limit of this BulkSendResponse.  # noqa: E501
224
225          # noqa: E501
226
227        :return: The queue_limit of this BulkSendResponse.  # noqa: E501
228        :rtype: str
229        """
230        return self._queue_limit
231
232    @queue_limit.setter
233    def queue_limit(self, queue_limit):
234        """Sets the queue_limit of this BulkSendResponse.
235
236          # noqa: E501
237
238        :param queue_limit: The queue_limit of this BulkSendResponse.  # noqa: E501
239        :type: str
240        """
241
242        self._queue_limit = queue_limit
243
244    @property
245    def total_queued(self):
246        """Gets the total_queued of this BulkSendResponse.  # noqa: E501
247
248          # noqa: E501
249
250        :return: The total_queued of this BulkSendResponse.  # noqa: E501
251        :rtype: str
252        """
253        return self._total_queued
254
255    @total_queued.setter
256    def total_queued(self, total_queued):
257        """Sets the total_queued of this BulkSendResponse.
258
259          # noqa: E501
260
261        :param total_queued: The total_queued of this BulkSendResponse.  # noqa: E501
262        :type: str
263        """
264
265        self._total_queued = total_queued
266
267    def to_dict(self):
268        """Returns the model properties as a dict"""
269        result = {}
270
271        for attr, _ in six.iteritems(self.swagger_types):
272            value = getattr(self, attr)
273            if isinstance(value, list):
274                result[attr] = list(map(
275                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
276                    value
277                ))
278            elif hasattr(value, "to_dict"):
279                result[attr] = value.to_dict()
280            elif isinstance(value, dict):
281                result[attr] = dict(map(
282                    lambda item: (item[0], item[1].to_dict())
283                    if hasattr(item[1], "to_dict") else item,
284                    value.items()
285                ))
286            else:
287                result[attr] = value
288        if issubclass(BulkSendResponse, dict):
289            for key, value in self.items():
290                result[key] = value
291
292        return result
293
294    def to_str(self):
295        """Returns the string representation of the model"""
296        return pprint.pformat(self.to_dict())
297
298    def __repr__(self):
299        """For `print` and `pprint`"""
300        return self.to_str()
301
302    def __eq__(self, other):
303        """Returns true if both objects are equal"""
304        if not isinstance(other, BulkSendResponse):
305            return False
306
307        return self.to_dict() == other.to_dict()
308
309    def __ne__(self, other):
310        """Returns true if both objects are not equal"""
311        if not isinstance(other, BulkSendResponse):
312            return True
313
314        return self.to_dict() != other.to_dict()

NOTE: This class is auto generated by the swagger code generator program.

Do not edit the class manually.

BulkSendResponse(_configuration=None, **kwargs)
58    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
59        """BulkSendResponse - a model defined in Swagger"""  # noqa: E501
60        if _configuration is None:
61            _configuration = Configuration()
62        self._configuration = _configuration
63
64        self._batch_id = None
65        self._batch_name = None
66        self._batch_size = None
67        self._envelope_or_template_id = None
68        self._error_details = None
69        self._errors = None
70        self._queue_limit = None
71        self._total_queued = None
72        self.discriminator = None
73
74        setattr(self, "_{}".format('batch_id'), kwargs.get('batch_id', None))
75        setattr(self, "_{}".format('batch_name'), kwargs.get('batch_name', None))
76        setattr(self, "_{}".format('batch_size'), kwargs.get('batch_size', None))
77        setattr(self, "_{}".format('envelope_or_template_id'), kwargs.get('envelope_or_template_id', None))
78        setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None))
79        setattr(self, "_{}".format('errors'), kwargs.get('errors', None))
80        setattr(self, "_{}".format('queue_limit'), kwargs.get('queue_limit', None))
81        setattr(self, "_{}".format('total_queued'), kwargs.get('total_queued', None))

BulkSendResponse - a model defined in Swagger

swagger_types = {'batch_id': 'str', 'batch_name': 'str', 'batch_size': 'str', 'envelope_or_template_id': 'str', 'error_details': 'list[str]', 'errors': 'list[str]', 'queue_limit': 'str', 'total_queued': 'str'}
attribute_map = {'batch_id': 'batchId', 'batch_name': 'batchName', 'batch_size': 'batchSize', 'envelope_or_template_id': 'envelopeOrTemplateId', 'error_details': 'errorDetails', 'errors': 'errors', 'queue_limit': 'queueLimit', 'total_queued': 'totalQueued'}
batch_id

Gets the batch_id of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The batch_id of this BulkSendResponse. # noqa: E501

batch_name

Gets the batch_name of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The batch_name of this BulkSendResponse. # noqa: E501

batch_size

Gets the batch_size of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The batch_size of this BulkSendResponse. # noqa: E501

envelope_or_template_id

Gets the envelope_or_template_id of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The envelope_or_template_id of this BulkSendResponse. # noqa: E501

error_details

Gets the error_details of this BulkSendResponse. # noqa: E501

Array or errors. # noqa: E501

Returns

The error_details of this BulkSendResponse. # noqa: E501

errors

Gets the errors of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The errors of this BulkSendResponse. # noqa: E501

queue_limit

Gets the queue_limit of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The queue_limit of this BulkSendResponse. # noqa: E501

total_queued

Gets the total_queued of this BulkSendResponse. # noqa: E501

# noqa: E501

Returns

The total_queued of this BulkSendResponse. # noqa: E501

def to_dict(self)
267    def to_dict(self):
268        """Returns the model properties as a dict"""
269        result = {}
270
271        for attr, _ in six.iteritems(self.swagger_types):
272            value = getattr(self, attr)
273            if isinstance(value, list):
274                result[attr] = list(map(
275                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
276                    value
277                ))
278            elif hasattr(value, "to_dict"):
279                result[attr] = value.to_dict()
280            elif isinstance(value, dict):
281                result[attr] = dict(map(
282                    lambda item: (item[0], item[1].to_dict())
283                    if hasattr(item[1], "to_dict") else item,
284                    value.items()
285                ))
286            else:
287                result[attr] = value
288        if issubclass(BulkSendResponse, dict):
289            for key, value in self.items():
290                result[key] = value
291
292        return result

Returns the model properties as a dict

def to_str(self)
294    def to_str(self):
295        """Returns the string representation of the model"""
296        return pprint.pformat(self.to_dict())

Returns the string representation of the model