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