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