docusign_esign.models.comment
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 Comment(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 'envelope_id': 'str', 37 'hmac': 'str', 38 'id': 'str', 39 'mentions': 'list[str]', 40 'read': 'bool', 41 'sent_by_email': 'str', 42 'sent_by_full_name': 'str', 43 'sent_by_image_id': 'str', 44 'sent_by_initials': 'str', 45 'sent_by_recipient_id': 'str', 46 'sent_by_user_id': 'str', 47 'signing_group_id': 'str', 48 'signing_group_name': 'str', 49 'subject': 'str', 50 'tab_id': 'str', 51 'text': 'str', 52 'thread_id': 'str', 53 'thread_originator_id': 'str', 54 'timestamp': 'str', 55 'time_stamp_formatted': 'str', 56 'visible_to': 'list[str]' 57 } 58 59 attribute_map = { 60 'envelope_id': 'envelopeId', 61 'hmac': 'hmac', 62 'id': 'id', 63 'mentions': 'mentions', 64 'read': 'read', 65 'sent_by_email': 'sentByEmail', 66 'sent_by_full_name': 'sentByFullName', 67 'sent_by_image_id': 'sentByImageId', 68 'sent_by_initials': 'sentByInitials', 69 'sent_by_recipient_id': 'sentByRecipientId', 70 'sent_by_user_id': 'sentByUserId', 71 'signing_group_id': 'signingGroupId', 72 'signing_group_name': 'signingGroupName', 73 'subject': 'subject', 74 'tab_id': 'tabId', 75 'text': 'text', 76 'thread_id': 'threadId', 77 'thread_originator_id': 'threadOriginatorId', 78 'timestamp': 'timestamp', 79 'time_stamp_formatted': 'timeStampFormatted', 80 'visible_to': 'visibleTo' 81 } 82 83 def __init__(self, _configuration=None, **kwargs): # noqa: E501 84 """Comment - a model defined in Swagger""" # noqa: E501 85 if _configuration is None: 86 _configuration = Configuration() 87 self._configuration = _configuration 88 89 self._envelope_id = None 90 self._hmac = None 91 self._id = None 92 self._mentions = None 93 self._read = None 94 self._sent_by_email = None 95 self._sent_by_full_name = None 96 self._sent_by_image_id = None 97 self._sent_by_initials = None 98 self._sent_by_recipient_id = None 99 self._sent_by_user_id = None 100 self._signing_group_id = None 101 self._signing_group_name = None 102 self._subject = None 103 self._tab_id = None 104 self._text = None 105 self._thread_id = None 106 self._thread_originator_id = None 107 self._timestamp = None 108 self._time_stamp_formatted = None 109 self._visible_to = None 110 self.discriminator = None 111 112 setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None)) 113 setattr(self, "_{}".format('hmac'), kwargs.get('hmac', None)) 114 setattr(self, "_{}".format('id'), kwargs.get('id', None)) 115 setattr(self, "_{}".format('mentions'), kwargs.get('mentions', None)) 116 setattr(self, "_{}".format('read'), kwargs.get('read', None)) 117 setattr(self, "_{}".format('sent_by_email'), kwargs.get('sent_by_email', None)) 118 setattr(self, "_{}".format('sent_by_full_name'), kwargs.get('sent_by_full_name', None)) 119 setattr(self, "_{}".format('sent_by_image_id'), kwargs.get('sent_by_image_id', None)) 120 setattr(self, "_{}".format('sent_by_initials'), kwargs.get('sent_by_initials', None)) 121 setattr(self, "_{}".format('sent_by_recipient_id'), kwargs.get('sent_by_recipient_id', None)) 122 setattr(self, "_{}".format('sent_by_user_id'), kwargs.get('sent_by_user_id', None)) 123 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 124 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 125 setattr(self, "_{}".format('subject'), kwargs.get('subject', None)) 126 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 127 setattr(self, "_{}".format('text'), kwargs.get('text', None)) 128 setattr(self, "_{}".format('thread_id'), kwargs.get('thread_id', None)) 129 setattr(self, "_{}".format('thread_originator_id'), kwargs.get('thread_originator_id', None)) 130 setattr(self, "_{}".format('timestamp'), kwargs.get('timestamp', None)) 131 setattr(self, "_{}".format('time_stamp_formatted'), kwargs.get('time_stamp_formatted', None)) 132 setattr(self, "_{}".format('visible_to'), kwargs.get('visible_to', None)) 133 134 @property 135 def envelope_id(self): 136 """Gets the envelope_id of this Comment. # noqa: E501 137 138 The envelope ID of the envelope status that failed to post. # noqa: E501 139 140 :return: The envelope_id of this Comment. # noqa: E501 141 :rtype: str 142 """ 143 return self._envelope_id 144 145 @envelope_id.setter 146 def envelope_id(self, envelope_id): 147 """Sets the envelope_id of this Comment. 148 149 The envelope ID of the envelope status that failed to post. # noqa: E501 150 151 :param envelope_id: The envelope_id of this Comment. # noqa: E501 152 :type: str 153 """ 154 155 self._envelope_id = envelope_id 156 157 @property 158 def hmac(self): 159 """Gets the hmac of this Comment. # noqa: E501 160 161 # noqa: E501 162 163 :return: The hmac of this Comment. # noqa: E501 164 :rtype: str 165 """ 166 return self._hmac 167 168 @hmac.setter 169 def hmac(self, hmac): 170 """Sets the hmac of this Comment. 171 172 # noqa: E501 173 174 :param hmac: The hmac of this Comment. # noqa: E501 175 :type: str 176 """ 177 178 self._hmac = hmac 179 180 @property 181 def id(self): 182 """Gets the id of this Comment. # noqa: E501 183 184 # noqa: E501 185 186 :return: The id of this Comment. # noqa: E501 187 :rtype: str 188 """ 189 return self._id 190 191 @id.setter 192 def id(self, id): 193 """Sets the id of this Comment. 194 195 # noqa: E501 196 197 :param id: The id of this Comment. # noqa: E501 198 :type: str 199 """ 200 201 self._id = id 202 203 @property 204 def mentions(self): 205 """Gets the mentions of this Comment. # noqa: E501 206 207 # noqa: E501 208 209 :return: The mentions of this Comment. # noqa: E501 210 :rtype: list[str] 211 """ 212 return self._mentions 213 214 @mentions.setter 215 def mentions(self, mentions): 216 """Sets the mentions of this Comment. 217 218 # noqa: E501 219 220 :param mentions: The mentions of this Comment. # noqa: E501 221 :type: list[str] 222 """ 223 224 self._mentions = mentions 225 226 @property 227 def read(self): 228 """Gets the read of this Comment. # noqa: E501 229 230 # noqa: E501 231 232 :return: The read of this Comment. # noqa: E501 233 :rtype: bool 234 """ 235 return self._read 236 237 @read.setter 238 def read(self, read): 239 """Sets the read of this Comment. 240 241 # noqa: E501 242 243 :param read: The read of this Comment. # noqa: E501 244 :type: bool 245 """ 246 247 self._read = read 248 249 @property 250 def sent_by_email(self): 251 """Gets the sent_by_email of this Comment. # noqa: E501 252 253 # noqa: E501 254 255 :return: The sent_by_email of this Comment. # noqa: E501 256 :rtype: str 257 """ 258 return self._sent_by_email 259 260 @sent_by_email.setter 261 def sent_by_email(self, sent_by_email): 262 """Sets the sent_by_email of this Comment. 263 264 # noqa: E501 265 266 :param sent_by_email: The sent_by_email of this Comment. # noqa: E501 267 :type: str 268 """ 269 270 self._sent_by_email = sent_by_email 271 272 @property 273 def sent_by_full_name(self): 274 """Gets the sent_by_full_name of this Comment. # noqa: E501 275 276 # noqa: E501 277 278 :return: The sent_by_full_name of this Comment. # noqa: E501 279 :rtype: str 280 """ 281 return self._sent_by_full_name 282 283 @sent_by_full_name.setter 284 def sent_by_full_name(self, sent_by_full_name): 285 """Sets the sent_by_full_name of this Comment. 286 287 # noqa: E501 288 289 :param sent_by_full_name: The sent_by_full_name of this Comment. # noqa: E501 290 :type: str 291 """ 292 293 self._sent_by_full_name = sent_by_full_name 294 295 @property 296 def sent_by_image_id(self): 297 """Gets the sent_by_image_id of this Comment. # noqa: E501 298 299 # noqa: E501 300 301 :return: The sent_by_image_id of this Comment. # noqa: E501 302 :rtype: str 303 """ 304 return self._sent_by_image_id 305 306 @sent_by_image_id.setter 307 def sent_by_image_id(self, sent_by_image_id): 308 """Sets the sent_by_image_id of this Comment. 309 310 # noqa: E501 311 312 :param sent_by_image_id: The sent_by_image_id of this Comment. # noqa: E501 313 :type: str 314 """ 315 316 self._sent_by_image_id = sent_by_image_id 317 318 @property 319 def sent_by_initials(self): 320 """Gets the sent_by_initials of this Comment. # noqa: E501 321 322 # noqa: E501 323 324 :return: The sent_by_initials of this Comment. # noqa: E501 325 :rtype: str 326 """ 327 return self._sent_by_initials 328 329 @sent_by_initials.setter 330 def sent_by_initials(self, sent_by_initials): 331 """Sets the sent_by_initials of this Comment. 332 333 # noqa: E501 334 335 :param sent_by_initials: The sent_by_initials of this Comment. # noqa: E501 336 :type: str 337 """ 338 339 self._sent_by_initials = sent_by_initials 340 341 @property 342 def sent_by_recipient_id(self): 343 """Gets the sent_by_recipient_id of this Comment. # noqa: E501 344 345 # noqa: E501 346 347 :return: The sent_by_recipient_id of this Comment. # noqa: E501 348 :rtype: str 349 """ 350 return self._sent_by_recipient_id 351 352 @sent_by_recipient_id.setter 353 def sent_by_recipient_id(self, sent_by_recipient_id): 354 """Sets the sent_by_recipient_id of this Comment. 355 356 # noqa: E501 357 358 :param sent_by_recipient_id: The sent_by_recipient_id of this Comment. # noqa: E501 359 :type: str 360 """ 361 362 self._sent_by_recipient_id = sent_by_recipient_id 363 364 @property 365 def sent_by_user_id(self): 366 """Gets the sent_by_user_id of this Comment. # noqa: E501 367 368 # noqa: E501 369 370 :return: The sent_by_user_id of this Comment. # noqa: E501 371 :rtype: str 372 """ 373 return self._sent_by_user_id 374 375 @sent_by_user_id.setter 376 def sent_by_user_id(self, sent_by_user_id): 377 """Sets the sent_by_user_id of this Comment. 378 379 # noqa: E501 380 381 :param sent_by_user_id: The sent_by_user_id of this Comment. # noqa: E501 382 :type: str 383 """ 384 385 self._sent_by_user_id = sent_by_user_id 386 387 @property 388 def signing_group_id(self): 389 """Gets the signing_group_id of this Comment. # noqa: E501 390 391 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 392 393 :return: The signing_group_id of this Comment. # noqa: E501 394 :rtype: str 395 """ 396 return self._signing_group_id 397 398 @signing_group_id.setter 399 def signing_group_id(self, signing_group_id): 400 """Sets the signing_group_id of this Comment. 401 402 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 403 404 :param signing_group_id: The signing_group_id of this Comment. # noqa: E501 405 :type: str 406 """ 407 408 self._signing_group_id = signing_group_id 409 410 @property 411 def signing_group_name(self): 412 """Gets the signing_group_name of this Comment. # noqa: E501 413 414 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 415 416 :return: The signing_group_name of this Comment. # noqa: E501 417 :rtype: str 418 """ 419 return self._signing_group_name 420 421 @signing_group_name.setter 422 def signing_group_name(self, signing_group_name): 423 """Sets the signing_group_name of this Comment. 424 425 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 426 427 :param signing_group_name: The signing_group_name of this Comment. # noqa: E501 428 :type: str 429 """ 430 431 self._signing_group_name = signing_group_name 432 433 @property 434 def subject(self): 435 """Gets the subject of this Comment. # noqa: E501 436 437 # noqa: E501 438 439 :return: The subject of this Comment. # noqa: E501 440 :rtype: str 441 """ 442 return self._subject 443 444 @subject.setter 445 def subject(self, subject): 446 """Sets the subject of this Comment. 447 448 # noqa: E501 449 450 :param subject: The subject of this Comment. # noqa: E501 451 :type: str 452 """ 453 454 self._subject = subject 455 456 @property 457 def tab_id(self): 458 """Gets the tab_id of this Comment. # noqa: E501 459 460 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 461 462 :return: The tab_id of this Comment. # noqa: E501 463 :rtype: str 464 """ 465 return self._tab_id 466 467 @tab_id.setter 468 def tab_id(self, tab_id): 469 """Sets the tab_id of this Comment. 470 471 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 472 473 :param tab_id: The tab_id of this Comment. # noqa: E501 474 :type: str 475 """ 476 477 self._tab_id = tab_id 478 479 @property 480 def text(self): 481 """Gets the text of this Comment. # noqa: E501 482 483 # noqa: E501 484 485 :return: The text of this Comment. # noqa: E501 486 :rtype: str 487 """ 488 return self._text 489 490 @text.setter 491 def text(self, text): 492 """Sets the text of this Comment. 493 494 # noqa: E501 495 496 :param text: The text of this Comment. # noqa: E501 497 :type: str 498 """ 499 500 self._text = text 501 502 @property 503 def thread_id(self): 504 """Gets the thread_id of this Comment. # noqa: E501 505 506 # noqa: E501 507 508 :return: The thread_id of this Comment. # noqa: E501 509 :rtype: str 510 """ 511 return self._thread_id 512 513 @thread_id.setter 514 def thread_id(self, thread_id): 515 """Sets the thread_id of this Comment. 516 517 # noqa: E501 518 519 :param thread_id: The thread_id of this Comment. # noqa: E501 520 :type: str 521 """ 522 523 self._thread_id = thread_id 524 525 @property 526 def thread_originator_id(self): 527 """Gets the thread_originator_id of this Comment. # noqa: E501 528 529 # noqa: E501 530 531 :return: The thread_originator_id of this Comment. # noqa: E501 532 :rtype: str 533 """ 534 return self._thread_originator_id 535 536 @thread_originator_id.setter 537 def thread_originator_id(self, thread_originator_id): 538 """Sets the thread_originator_id of this Comment. 539 540 # noqa: E501 541 542 :param thread_originator_id: The thread_originator_id of this Comment. # noqa: E501 543 :type: str 544 """ 545 546 self._thread_originator_id = thread_originator_id 547 548 @property 549 def timestamp(self): 550 """Gets the timestamp of this Comment. # noqa: E501 551 552 # noqa: E501 553 554 :return: The timestamp of this Comment. # noqa: E501 555 :rtype: str 556 """ 557 return self._timestamp 558 559 @timestamp.setter 560 def timestamp(self, timestamp): 561 """Sets the timestamp of this Comment. 562 563 # noqa: E501 564 565 :param timestamp: The timestamp of this Comment. # noqa: E501 566 :type: str 567 """ 568 569 self._timestamp = timestamp 570 571 @property 572 def time_stamp_formatted(self): 573 """Gets the time_stamp_formatted of this Comment. # noqa: E501 574 575 # noqa: E501 576 577 :return: The time_stamp_formatted of this Comment. # noqa: E501 578 :rtype: str 579 """ 580 return self._time_stamp_formatted 581 582 @time_stamp_formatted.setter 583 def time_stamp_formatted(self, time_stamp_formatted): 584 """Sets the time_stamp_formatted of this Comment. 585 586 # noqa: E501 587 588 :param time_stamp_formatted: The time_stamp_formatted of this Comment. # noqa: E501 589 :type: str 590 """ 591 592 self._time_stamp_formatted = time_stamp_formatted 593 594 @property 595 def visible_to(self): 596 """Gets the visible_to of this Comment. # noqa: E501 597 598 # noqa: E501 599 600 :return: The visible_to of this Comment. # noqa: E501 601 :rtype: list[str] 602 """ 603 return self._visible_to 604 605 @visible_to.setter 606 def visible_to(self, visible_to): 607 """Sets the visible_to of this Comment. 608 609 # noqa: E501 610 611 :param visible_to: The visible_to of this Comment. # noqa: E501 612 :type: list[str] 613 """ 614 615 self._visible_to = visible_to 616 617 def to_dict(self): 618 """Returns the model properties as a dict""" 619 result = {} 620 621 for attr, _ in six.iteritems(self.swagger_types): 622 value = getattr(self, attr) 623 if isinstance(value, list): 624 result[attr] = list(map( 625 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 626 value 627 )) 628 elif hasattr(value, "to_dict"): 629 result[attr] = value.to_dict() 630 elif isinstance(value, dict): 631 result[attr] = dict(map( 632 lambda item: (item[0], item[1].to_dict()) 633 if hasattr(item[1], "to_dict") else item, 634 value.items() 635 )) 636 else: 637 result[attr] = value 638 if issubclass(Comment, dict): 639 for key, value in self.items(): 640 result[key] = value 641 642 return result 643 644 def to_str(self): 645 """Returns the string representation of the model""" 646 return pprint.pformat(self.to_dict()) 647 648 def __repr__(self): 649 """For `print` and `pprint`""" 650 return self.to_str() 651 652 def __eq__(self, other): 653 """Returns true if both objects are equal""" 654 if not isinstance(other, Comment): 655 return False 656 657 return self.to_dict() == other.to_dict() 658 659 def __ne__(self, other): 660 """Returns true if both objects are not equal""" 661 if not isinstance(other, Comment): 662 return True 663 664 return self.to_dict() != other.to_dict()
class
Comment:
23class Comment(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 'envelope_id': 'str', 38 'hmac': 'str', 39 'id': 'str', 40 'mentions': 'list[str]', 41 'read': 'bool', 42 'sent_by_email': 'str', 43 'sent_by_full_name': 'str', 44 'sent_by_image_id': 'str', 45 'sent_by_initials': 'str', 46 'sent_by_recipient_id': 'str', 47 'sent_by_user_id': 'str', 48 'signing_group_id': 'str', 49 'signing_group_name': 'str', 50 'subject': 'str', 51 'tab_id': 'str', 52 'text': 'str', 53 'thread_id': 'str', 54 'thread_originator_id': 'str', 55 'timestamp': 'str', 56 'time_stamp_formatted': 'str', 57 'visible_to': 'list[str]' 58 } 59 60 attribute_map = { 61 'envelope_id': 'envelopeId', 62 'hmac': 'hmac', 63 'id': 'id', 64 'mentions': 'mentions', 65 'read': 'read', 66 'sent_by_email': 'sentByEmail', 67 'sent_by_full_name': 'sentByFullName', 68 'sent_by_image_id': 'sentByImageId', 69 'sent_by_initials': 'sentByInitials', 70 'sent_by_recipient_id': 'sentByRecipientId', 71 'sent_by_user_id': 'sentByUserId', 72 'signing_group_id': 'signingGroupId', 73 'signing_group_name': 'signingGroupName', 74 'subject': 'subject', 75 'tab_id': 'tabId', 76 'text': 'text', 77 'thread_id': 'threadId', 78 'thread_originator_id': 'threadOriginatorId', 79 'timestamp': 'timestamp', 80 'time_stamp_formatted': 'timeStampFormatted', 81 'visible_to': 'visibleTo' 82 } 83 84 def __init__(self, _configuration=None, **kwargs): # noqa: E501 85 """Comment - a model defined in Swagger""" # noqa: E501 86 if _configuration is None: 87 _configuration = Configuration() 88 self._configuration = _configuration 89 90 self._envelope_id = None 91 self._hmac = None 92 self._id = None 93 self._mentions = None 94 self._read = None 95 self._sent_by_email = None 96 self._sent_by_full_name = None 97 self._sent_by_image_id = None 98 self._sent_by_initials = None 99 self._sent_by_recipient_id = None 100 self._sent_by_user_id = None 101 self._signing_group_id = None 102 self._signing_group_name = None 103 self._subject = None 104 self._tab_id = None 105 self._text = None 106 self._thread_id = None 107 self._thread_originator_id = None 108 self._timestamp = None 109 self._time_stamp_formatted = None 110 self._visible_to = None 111 self.discriminator = None 112 113 setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None)) 114 setattr(self, "_{}".format('hmac'), kwargs.get('hmac', None)) 115 setattr(self, "_{}".format('id'), kwargs.get('id', None)) 116 setattr(self, "_{}".format('mentions'), kwargs.get('mentions', None)) 117 setattr(self, "_{}".format('read'), kwargs.get('read', None)) 118 setattr(self, "_{}".format('sent_by_email'), kwargs.get('sent_by_email', None)) 119 setattr(self, "_{}".format('sent_by_full_name'), kwargs.get('sent_by_full_name', None)) 120 setattr(self, "_{}".format('sent_by_image_id'), kwargs.get('sent_by_image_id', None)) 121 setattr(self, "_{}".format('sent_by_initials'), kwargs.get('sent_by_initials', None)) 122 setattr(self, "_{}".format('sent_by_recipient_id'), kwargs.get('sent_by_recipient_id', None)) 123 setattr(self, "_{}".format('sent_by_user_id'), kwargs.get('sent_by_user_id', None)) 124 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 125 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 126 setattr(self, "_{}".format('subject'), kwargs.get('subject', None)) 127 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 128 setattr(self, "_{}".format('text'), kwargs.get('text', None)) 129 setattr(self, "_{}".format('thread_id'), kwargs.get('thread_id', None)) 130 setattr(self, "_{}".format('thread_originator_id'), kwargs.get('thread_originator_id', None)) 131 setattr(self, "_{}".format('timestamp'), kwargs.get('timestamp', None)) 132 setattr(self, "_{}".format('time_stamp_formatted'), kwargs.get('time_stamp_formatted', None)) 133 setattr(self, "_{}".format('visible_to'), kwargs.get('visible_to', None)) 134 135 @property 136 def envelope_id(self): 137 """Gets the envelope_id of this Comment. # noqa: E501 138 139 The envelope ID of the envelope status that failed to post. # noqa: E501 140 141 :return: The envelope_id of this Comment. # noqa: E501 142 :rtype: str 143 """ 144 return self._envelope_id 145 146 @envelope_id.setter 147 def envelope_id(self, envelope_id): 148 """Sets the envelope_id of this Comment. 149 150 The envelope ID of the envelope status that failed to post. # noqa: E501 151 152 :param envelope_id: The envelope_id of this Comment. # noqa: E501 153 :type: str 154 """ 155 156 self._envelope_id = envelope_id 157 158 @property 159 def hmac(self): 160 """Gets the hmac of this Comment. # noqa: E501 161 162 # noqa: E501 163 164 :return: The hmac of this Comment. # noqa: E501 165 :rtype: str 166 """ 167 return self._hmac 168 169 @hmac.setter 170 def hmac(self, hmac): 171 """Sets the hmac of this Comment. 172 173 # noqa: E501 174 175 :param hmac: The hmac of this Comment. # noqa: E501 176 :type: str 177 """ 178 179 self._hmac = hmac 180 181 @property 182 def id(self): 183 """Gets the id of this Comment. # noqa: E501 184 185 # noqa: E501 186 187 :return: The id of this Comment. # noqa: E501 188 :rtype: str 189 """ 190 return self._id 191 192 @id.setter 193 def id(self, id): 194 """Sets the id of this Comment. 195 196 # noqa: E501 197 198 :param id: The id of this Comment. # noqa: E501 199 :type: str 200 """ 201 202 self._id = id 203 204 @property 205 def mentions(self): 206 """Gets the mentions of this Comment. # noqa: E501 207 208 # noqa: E501 209 210 :return: The mentions of this Comment. # noqa: E501 211 :rtype: list[str] 212 """ 213 return self._mentions 214 215 @mentions.setter 216 def mentions(self, mentions): 217 """Sets the mentions of this Comment. 218 219 # noqa: E501 220 221 :param mentions: The mentions of this Comment. # noqa: E501 222 :type: list[str] 223 """ 224 225 self._mentions = mentions 226 227 @property 228 def read(self): 229 """Gets the read of this Comment. # noqa: E501 230 231 # noqa: E501 232 233 :return: The read of this Comment. # noqa: E501 234 :rtype: bool 235 """ 236 return self._read 237 238 @read.setter 239 def read(self, read): 240 """Sets the read of this Comment. 241 242 # noqa: E501 243 244 :param read: The read of this Comment. # noqa: E501 245 :type: bool 246 """ 247 248 self._read = read 249 250 @property 251 def sent_by_email(self): 252 """Gets the sent_by_email of this Comment. # noqa: E501 253 254 # noqa: E501 255 256 :return: The sent_by_email of this Comment. # noqa: E501 257 :rtype: str 258 """ 259 return self._sent_by_email 260 261 @sent_by_email.setter 262 def sent_by_email(self, sent_by_email): 263 """Sets the sent_by_email of this Comment. 264 265 # noqa: E501 266 267 :param sent_by_email: The sent_by_email of this Comment. # noqa: E501 268 :type: str 269 """ 270 271 self._sent_by_email = sent_by_email 272 273 @property 274 def sent_by_full_name(self): 275 """Gets the sent_by_full_name of this Comment. # noqa: E501 276 277 # noqa: E501 278 279 :return: The sent_by_full_name of this Comment. # noqa: E501 280 :rtype: str 281 """ 282 return self._sent_by_full_name 283 284 @sent_by_full_name.setter 285 def sent_by_full_name(self, sent_by_full_name): 286 """Sets the sent_by_full_name of this Comment. 287 288 # noqa: E501 289 290 :param sent_by_full_name: The sent_by_full_name of this Comment. # noqa: E501 291 :type: str 292 """ 293 294 self._sent_by_full_name = sent_by_full_name 295 296 @property 297 def sent_by_image_id(self): 298 """Gets the sent_by_image_id of this Comment. # noqa: E501 299 300 # noqa: E501 301 302 :return: The sent_by_image_id of this Comment. # noqa: E501 303 :rtype: str 304 """ 305 return self._sent_by_image_id 306 307 @sent_by_image_id.setter 308 def sent_by_image_id(self, sent_by_image_id): 309 """Sets the sent_by_image_id of this Comment. 310 311 # noqa: E501 312 313 :param sent_by_image_id: The sent_by_image_id of this Comment. # noqa: E501 314 :type: str 315 """ 316 317 self._sent_by_image_id = sent_by_image_id 318 319 @property 320 def sent_by_initials(self): 321 """Gets the sent_by_initials of this Comment. # noqa: E501 322 323 # noqa: E501 324 325 :return: The sent_by_initials of this Comment. # noqa: E501 326 :rtype: str 327 """ 328 return self._sent_by_initials 329 330 @sent_by_initials.setter 331 def sent_by_initials(self, sent_by_initials): 332 """Sets the sent_by_initials of this Comment. 333 334 # noqa: E501 335 336 :param sent_by_initials: The sent_by_initials of this Comment. # noqa: E501 337 :type: str 338 """ 339 340 self._sent_by_initials = sent_by_initials 341 342 @property 343 def sent_by_recipient_id(self): 344 """Gets the sent_by_recipient_id of this Comment. # noqa: E501 345 346 # noqa: E501 347 348 :return: The sent_by_recipient_id of this Comment. # noqa: E501 349 :rtype: str 350 """ 351 return self._sent_by_recipient_id 352 353 @sent_by_recipient_id.setter 354 def sent_by_recipient_id(self, sent_by_recipient_id): 355 """Sets the sent_by_recipient_id of this Comment. 356 357 # noqa: E501 358 359 :param sent_by_recipient_id: The sent_by_recipient_id of this Comment. # noqa: E501 360 :type: str 361 """ 362 363 self._sent_by_recipient_id = sent_by_recipient_id 364 365 @property 366 def sent_by_user_id(self): 367 """Gets the sent_by_user_id of this Comment. # noqa: E501 368 369 # noqa: E501 370 371 :return: The sent_by_user_id of this Comment. # noqa: E501 372 :rtype: str 373 """ 374 return self._sent_by_user_id 375 376 @sent_by_user_id.setter 377 def sent_by_user_id(self, sent_by_user_id): 378 """Sets the sent_by_user_id of this Comment. 379 380 # noqa: E501 381 382 :param sent_by_user_id: The sent_by_user_id of this Comment. # noqa: E501 383 :type: str 384 """ 385 386 self._sent_by_user_id = sent_by_user_id 387 388 @property 389 def signing_group_id(self): 390 """Gets the signing_group_id of this Comment. # noqa: E501 391 392 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 393 394 :return: The signing_group_id of this Comment. # noqa: E501 395 :rtype: str 396 """ 397 return self._signing_group_id 398 399 @signing_group_id.setter 400 def signing_group_id(self, signing_group_id): 401 """Sets the signing_group_id of this Comment. 402 403 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 404 405 :param signing_group_id: The signing_group_id of this Comment. # noqa: E501 406 :type: str 407 """ 408 409 self._signing_group_id = signing_group_id 410 411 @property 412 def signing_group_name(self): 413 """Gets the signing_group_name of this Comment. # noqa: E501 414 415 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 416 417 :return: The signing_group_name of this Comment. # noqa: E501 418 :rtype: str 419 """ 420 return self._signing_group_name 421 422 @signing_group_name.setter 423 def signing_group_name(self, signing_group_name): 424 """Sets the signing_group_name of this Comment. 425 426 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 427 428 :param signing_group_name: The signing_group_name of this Comment. # noqa: E501 429 :type: str 430 """ 431 432 self._signing_group_name = signing_group_name 433 434 @property 435 def subject(self): 436 """Gets the subject of this Comment. # noqa: E501 437 438 # noqa: E501 439 440 :return: The subject of this Comment. # noqa: E501 441 :rtype: str 442 """ 443 return self._subject 444 445 @subject.setter 446 def subject(self, subject): 447 """Sets the subject of this Comment. 448 449 # noqa: E501 450 451 :param subject: The subject of this Comment. # noqa: E501 452 :type: str 453 """ 454 455 self._subject = subject 456 457 @property 458 def tab_id(self): 459 """Gets the tab_id of this Comment. # noqa: E501 460 461 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 462 463 :return: The tab_id of this Comment. # noqa: E501 464 :rtype: str 465 """ 466 return self._tab_id 467 468 @tab_id.setter 469 def tab_id(self, tab_id): 470 """Sets the tab_id of this Comment. 471 472 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 473 474 :param tab_id: The tab_id of this Comment. # noqa: E501 475 :type: str 476 """ 477 478 self._tab_id = tab_id 479 480 @property 481 def text(self): 482 """Gets the text of this Comment. # noqa: E501 483 484 # noqa: E501 485 486 :return: The text of this Comment. # noqa: E501 487 :rtype: str 488 """ 489 return self._text 490 491 @text.setter 492 def text(self, text): 493 """Sets the text of this Comment. 494 495 # noqa: E501 496 497 :param text: The text of this Comment. # noqa: E501 498 :type: str 499 """ 500 501 self._text = text 502 503 @property 504 def thread_id(self): 505 """Gets the thread_id of this Comment. # noqa: E501 506 507 # noqa: E501 508 509 :return: The thread_id of this Comment. # noqa: E501 510 :rtype: str 511 """ 512 return self._thread_id 513 514 @thread_id.setter 515 def thread_id(self, thread_id): 516 """Sets the thread_id of this Comment. 517 518 # noqa: E501 519 520 :param thread_id: The thread_id of this Comment. # noqa: E501 521 :type: str 522 """ 523 524 self._thread_id = thread_id 525 526 @property 527 def thread_originator_id(self): 528 """Gets the thread_originator_id of this Comment. # noqa: E501 529 530 # noqa: E501 531 532 :return: The thread_originator_id of this Comment. # noqa: E501 533 :rtype: str 534 """ 535 return self._thread_originator_id 536 537 @thread_originator_id.setter 538 def thread_originator_id(self, thread_originator_id): 539 """Sets the thread_originator_id of this Comment. 540 541 # noqa: E501 542 543 :param thread_originator_id: The thread_originator_id of this Comment. # noqa: E501 544 :type: str 545 """ 546 547 self._thread_originator_id = thread_originator_id 548 549 @property 550 def timestamp(self): 551 """Gets the timestamp of this Comment. # noqa: E501 552 553 # noqa: E501 554 555 :return: The timestamp of this Comment. # noqa: E501 556 :rtype: str 557 """ 558 return self._timestamp 559 560 @timestamp.setter 561 def timestamp(self, timestamp): 562 """Sets the timestamp of this Comment. 563 564 # noqa: E501 565 566 :param timestamp: The timestamp of this Comment. # noqa: E501 567 :type: str 568 """ 569 570 self._timestamp = timestamp 571 572 @property 573 def time_stamp_formatted(self): 574 """Gets the time_stamp_formatted of this Comment. # noqa: E501 575 576 # noqa: E501 577 578 :return: The time_stamp_formatted of this Comment. # noqa: E501 579 :rtype: str 580 """ 581 return self._time_stamp_formatted 582 583 @time_stamp_formatted.setter 584 def time_stamp_formatted(self, time_stamp_formatted): 585 """Sets the time_stamp_formatted of this Comment. 586 587 # noqa: E501 588 589 :param time_stamp_formatted: The time_stamp_formatted of this Comment. # noqa: E501 590 :type: str 591 """ 592 593 self._time_stamp_formatted = time_stamp_formatted 594 595 @property 596 def visible_to(self): 597 """Gets the visible_to of this Comment. # noqa: E501 598 599 # noqa: E501 600 601 :return: The visible_to of this Comment. # noqa: E501 602 :rtype: list[str] 603 """ 604 return self._visible_to 605 606 @visible_to.setter 607 def visible_to(self, visible_to): 608 """Sets the visible_to of this Comment. 609 610 # noqa: E501 611 612 :param visible_to: The visible_to of this Comment. # noqa: E501 613 :type: list[str] 614 """ 615 616 self._visible_to = visible_to 617 618 def to_dict(self): 619 """Returns the model properties as a dict""" 620 result = {} 621 622 for attr, _ in six.iteritems(self.swagger_types): 623 value = getattr(self, attr) 624 if isinstance(value, list): 625 result[attr] = list(map( 626 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 627 value 628 )) 629 elif hasattr(value, "to_dict"): 630 result[attr] = value.to_dict() 631 elif isinstance(value, dict): 632 result[attr] = dict(map( 633 lambda item: (item[0], item[1].to_dict()) 634 if hasattr(item[1], "to_dict") else item, 635 value.items() 636 )) 637 else: 638 result[attr] = value 639 if issubclass(Comment, dict): 640 for key, value in self.items(): 641 result[key] = value 642 643 return result 644 645 def to_str(self): 646 """Returns the string representation of the model""" 647 return pprint.pformat(self.to_dict()) 648 649 def __repr__(self): 650 """For `print` and `pprint`""" 651 return self.to_str() 652 653 def __eq__(self, other): 654 """Returns true if both objects are equal""" 655 if not isinstance(other, Comment): 656 return False 657 658 return self.to_dict() == other.to_dict() 659 660 def __ne__(self, other): 661 """Returns true if both objects are not equal""" 662 if not isinstance(other, Comment): 663 return True 664 665 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.
Comment(_configuration=None, **kwargs)
84 def __init__(self, _configuration=None, **kwargs): # noqa: E501 85 """Comment - a model defined in Swagger""" # noqa: E501 86 if _configuration is None: 87 _configuration = Configuration() 88 self._configuration = _configuration 89 90 self._envelope_id = None 91 self._hmac = None 92 self._id = None 93 self._mentions = None 94 self._read = None 95 self._sent_by_email = None 96 self._sent_by_full_name = None 97 self._sent_by_image_id = None 98 self._sent_by_initials = None 99 self._sent_by_recipient_id = None 100 self._sent_by_user_id = None 101 self._signing_group_id = None 102 self._signing_group_name = None 103 self._subject = None 104 self._tab_id = None 105 self._text = None 106 self._thread_id = None 107 self._thread_originator_id = None 108 self._timestamp = None 109 self._time_stamp_formatted = None 110 self._visible_to = None 111 self.discriminator = None 112 113 setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None)) 114 setattr(self, "_{}".format('hmac'), kwargs.get('hmac', None)) 115 setattr(self, "_{}".format('id'), kwargs.get('id', None)) 116 setattr(self, "_{}".format('mentions'), kwargs.get('mentions', None)) 117 setattr(self, "_{}".format('read'), kwargs.get('read', None)) 118 setattr(self, "_{}".format('sent_by_email'), kwargs.get('sent_by_email', None)) 119 setattr(self, "_{}".format('sent_by_full_name'), kwargs.get('sent_by_full_name', None)) 120 setattr(self, "_{}".format('sent_by_image_id'), kwargs.get('sent_by_image_id', None)) 121 setattr(self, "_{}".format('sent_by_initials'), kwargs.get('sent_by_initials', None)) 122 setattr(self, "_{}".format('sent_by_recipient_id'), kwargs.get('sent_by_recipient_id', None)) 123 setattr(self, "_{}".format('sent_by_user_id'), kwargs.get('sent_by_user_id', None)) 124 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 125 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 126 setattr(self, "_{}".format('subject'), kwargs.get('subject', None)) 127 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 128 setattr(self, "_{}".format('text'), kwargs.get('text', None)) 129 setattr(self, "_{}".format('thread_id'), kwargs.get('thread_id', None)) 130 setattr(self, "_{}".format('thread_originator_id'), kwargs.get('thread_originator_id', None)) 131 setattr(self, "_{}".format('timestamp'), kwargs.get('timestamp', None)) 132 setattr(self, "_{}".format('time_stamp_formatted'), kwargs.get('time_stamp_formatted', None)) 133 setattr(self, "_{}".format('visible_to'), kwargs.get('visible_to', None))
Comment - a model defined in Swagger
swagger_types = {'envelope_id': 'str', 'hmac': 'str', 'id': 'str', 'mentions': 'list[str]', 'read': 'bool', 'sent_by_email': 'str', 'sent_by_full_name': 'str', 'sent_by_image_id': 'str', 'sent_by_initials': 'str', 'sent_by_recipient_id': 'str', 'sent_by_user_id': 'str', 'signing_group_id': 'str', 'signing_group_name': 'str', 'subject': 'str', 'tab_id': 'str', 'text': 'str', 'thread_id': 'str', 'thread_originator_id': 'str', 'timestamp': 'str', 'time_stamp_formatted': 'str', 'visible_to': 'list[str]'}
attribute_map = {'envelope_id': 'envelopeId', 'hmac': 'hmac', 'id': 'id', 'mentions': 'mentions', 'read': 'read', 'sent_by_email': 'sentByEmail', 'sent_by_full_name': 'sentByFullName', 'sent_by_image_id': 'sentByImageId', 'sent_by_initials': 'sentByInitials', 'sent_by_recipient_id': 'sentByRecipientId', 'sent_by_user_id': 'sentByUserId', 'signing_group_id': 'signingGroupId', 'signing_group_name': 'signingGroupName', 'subject': 'subject', 'tab_id': 'tabId', 'text': 'text', 'thread_id': 'threadId', 'thread_originator_id': 'threadOriginatorId', 'timestamp': 'timestamp', 'time_stamp_formatted': 'timeStampFormatted', 'visible_to': 'visibleTo'}
envelope_id
Gets the envelope_id of this Comment. # noqa: E501
The envelope ID of the envelope status that failed to post. # noqa: E501
Returns
The envelope_id of this Comment. # noqa: E501
hmac
Gets the hmac of this Comment. # noqa: E501
# noqa: E501
Returns
The hmac of this Comment. # noqa: E501
id
Gets the id of this Comment. # noqa: E501
# noqa: E501
Returns
The id of this Comment. # noqa: E501
mentions
Gets the mentions of this Comment. # noqa: E501
# noqa: E501
Returns
The mentions of this Comment. # noqa: E501
read
Gets the read of this Comment. # noqa: E501
# noqa: E501
Returns
The read of this Comment. # noqa: E501
sent_by_email
Gets the sent_by_email of this Comment. # noqa: E501
# noqa: E501
Returns
The sent_by_email of this Comment. # noqa: E501
sent_by_full_name
Gets the sent_by_full_name of this Comment. # noqa: E501
# noqa: E501
Returns
The sent_by_full_name of this Comment. # noqa: E501
sent_by_image_id
Gets the sent_by_image_id of this Comment. # noqa: E501
# noqa: E501
Returns
The sent_by_image_id of this Comment. # noqa: E501
sent_by_initials
Gets the sent_by_initials of this Comment. # noqa: E501
# noqa: E501
Returns
The sent_by_initials of this Comment. # noqa: E501
sent_by_recipient_id
Gets the sent_by_recipient_id of this Comment. # noqa: E501
# noqa: E501
Returns
The sent_by_recipient_id of this Comment. # noqa: E501
sent_by_user_id
Gets the sent_by_user_id of this Comment. # noqa: E501
# noqa: E501
Returns
The sent_by_user_id of this Comment. # noqa: E501
signing_group_id
Gets the signing_group_id of this Comment. # noqa: E501
When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501
Returns
The signing_group_id of this Comment. # noqa: E501
signing_group_name
Gets the signing_group_name of this Comment. # noqa: E501
The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
Returns
The signing_group_name of this Comment. # noqa: E501
subject
Gets the subject of this Comment. # noqa: E501
# noqa: E501
Returns
The subject of this Comment. # noqa: E501
tab_id
Gets the tab_id of this Comment. # noqa: E501
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501
Returns
The tab_id of this Comment. # noqa: E501
text
Gets the text of this Comment. # noqa: E501
# noqa: E501
Returns
The text of this Comment. # noqa: E501
thread_id
Gets the thread_id of this Comment. # noqa: E501
# noqa: E501
Returns
The thread_id of this Comment. # noqa: E501
thread_originator_id
Gets the thread_originator_id of this Comment. # noqa: E501
# noqa: E501
Returns
The thread_originator_id of this Comment. # noqa: E501
timestamp
Gets the timestamp of this Comment. # noqa: E501
# noqa: E501
Returns
The timestamp of this Comment. # noqa: E501
time_stamp_formatted
Gets the time_stamp_formatted of this Comment. # noqa: E501
# noqa: E501
Returns
The time_stamp_formatted of this Comment. # noqa: E501
visible_to
Gets the visible_to of this Comment. # noqa: E501
# noqa: E501
Returns
The visible_to of this Comment. # noqa: E501
def
to_dict(self)
618 def to_dict(self): 619 """Returns the model properties as a dict""" 620 result = {} 621 622 for attr, _ in six.iteritems(self.swagger_types): 623 value = getattr(self, attr) 624 if isinstance(value, list): 625 result[attr] = list(map( 626 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 627 value 628 )) 629 elif hasattr(value, "to_dict"): 630 result[attr] = value.to_dict() 631 elif isinstance(value, dict): 632 result[attr] = dict(map( 633 lambda item: (item[0], item[1].to_dict()) 634 if hasattr(item[1], "to_dict") else item, 635 value.items() 636 )) 637 else: 638 result[attr] = value 639 if issubclass(Comment, dict): 640 for key, value in self.items(): 641 result[key] = value 642 643 return result
Returns the model properties as a dict