docusign_esign.models.envelope_document
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 EnvelopeDocument(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 'added_recipient_ids': 'list[str]', 37 'attachment_tab_id': 'str', 38 'authoritative_copy': 'str', 39 'authoritative_copy_metadata': 'PropertyMetadata', 40 'available_document_types': 'list[SignatureType]', 41 'contains_pdf_form_fields': 'str', 42 'display': 'str', 43 'display_metadata': 'PropertyMetadata', 44 'doc_gen_document_status': 'str', 45 'doc_gen_errors': 'list[DocGenSyntaxError]', 46 'doc_gen_form_fields': 'list[DocGenFormField]', 47 'document_base64': 'str', 48 'document_fields': 'list[NameValue]', 49 'document_id': 'str', 50 'document_id_guid': 'str', 51 'error_details': 'ErrorDetails', 52 'include_in_download': 'str', 53 'include_in_download_metadata': 'PropertyMetadata', 54 'is_doc_gen_document': 'str', 55 'name': 'str', 56 'name_metadata': 'PropertyMetadata', 57 'order': 'str', 58 'pages': 'list[Page]', 59 'signer_must_acknowledge': 'str', 60 'signer_must_acknowledge_metadata': 'PropertyMetadata', 61 'size_bytes': 'str', 62 'template_locked': 'str', 63 'template_required': 'str', 64 'type': 'str', 65 'uri': 'str' 66 } 67 68 attribute_map = { 69 'added_recipient_ids': 'addedRecipientIds', 70 'attachment_tab_id': 'attachmentTabId', 71 'authoritative_copy': 'authoritativeCopy', 72 'authoritative_copy_metadata': 'authoritativeCopyMetadata', 73 'available_document_types': 'availableDocumentTypes', 74 'contains_pdf_form_fields': 'containsPdfFormFields', 75 'display': 'display', 76 'display_metadata': 'displayMetadata', 77 'doc_gen_document_status': 'docGenDocumentStatus', 78 'doc_gen_errors': 'docGenErrors', 79 'doc_gen_form_fields': 'docGenFormFields', 80 'document_base64': 'documentBase64', 81 'document_fields': 'documentFields', 82 'document_id': 'documentId', 83 'document_id_guid': 'documentIdGuid', 84 'error_details': 'errorDetails', 85 'include_in_download': 'includeInDownload', 86 'include_in_download_metadata': 'includeInDownloadMetadata', 87 'is_doc_gen_document': 'isDocGenDocument', 88 'name': 'name', 89 'name_metadata': 'nameMetadata', 90 'order': 'order', 91 'pages': 'pages', 92 'signer_must_acknowledge': 'signerMustAcknowledge', 93 'signer_must_acknowledge_metadata': 'signerMustAcknowledgeMetadata', 94 'size_bytes': 'sizeBytes', 95 'template_locked': 'templateLocked', 96 'template_required': 'templateRequired', 97 'type': 'type', 98 'uri': 'uri' 99 } 100 101 def __init__(self, _configuration=None, **kwargs): # noqa: E501 102 """EnvelopeDocument - a model defined in Swagger""" # noqa: E501 103 if _configuration is None: 104 _configuration = Configuration() 105 self._configuration = _configuration 106 107 self._added_recipient_ids = None 108 self._attachment_tab_id = None 109 self._authoritative_copy = None 110 self._authoritative_copy_metadata = None 111 self._available_document_types = None 112 self._contains_pdf_form_fields = None 113 self._display = None 114 self._display_metadata = None 115 self._doc_gen_document_status = None 116 self._doc_gen_errors = None 117 self._doc_gen_form_fields = None 118 self._document_base64 = None 119 self._document_fields = None 120 self._document_id = None 121 self._document_id_guid = None 122 self._error_details = None 123 self._include_in_download = None 124 self._include_in_download_metadata = None 125 self._is_doc_gen_document = None 126 self._name = None 127 self._name_metadata = None 128 self._order = None 129 self._pages = None 130 self._signer_must_acknowledge = None 131 self._signer_must_acknowledge_metadata = None 132 self._size_bytes = None 133 self._template_locked = None 134 self._template_required = None 135 self._type = None 136 self._uri = None 137 self.discriminator = None 138 139 setattr(self, "_{}".format('added_recipient_ids'), kwargs.get('added_recipient_ids', None)) 140 setattr(self, "_{}".format('attachment_tab_id'), kwargs.get('attachment_tab_id', None)) 141 setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) 142 setattr(self, "_{}".format('authoritative_copy_metadata'), kwargs.get('authoritative_copy_metadata', None)) 143 setattr(self, "_{}".format('available_document_types'), kwargs.get('available_document_types', None)) 144 setattr(self, "_{}".format('contains_pdf_form_fields'), kwargs.get('contains_pdf_form_fields', None)) 145 setattr(self, "_{}".format('display'), kwargs.get('display', None)) 146 setattr(self, "_{}".format('display_metadata'), kwargs.get('display_metadata', None)) 147 setattr(self, "_{}".format('doc_gen_document_status'), kwargs.get('doc_gen_document_status', None)) 148 setattr(self, "_{}".format('doc_gen_errors'), kwargs.get('doc_gen_errors', None)) 149 setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) 150 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 151 setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None)) 152 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 153 setattr(self, "_{}".format('document_id_guid'), kwargs.get('document_id_guid', None)) 154 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 155 setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None)) 156 setattr(self, "_{}".format('include_in_download_metadata'), kwargs.get('include_in_download_metadata', None)) 157 setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None)) 158 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 159 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 160 setattr(self, "_{}".format('order'), kwargs.get('order', None)) 161 setattr(self, "_{}".format('pages'), kwargs.get('pages', None)) 162 setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None)) 163 setattr(self, "_{}".format('signer_must_acknowledge_metadata'), kwargs.get('signer_must_acknowledge_metadata', None)) 164 setattr(self, "_{}".format('size_bytes'), kwargs.get('size_bytes', None)) 165 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 166 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 167 setattr(self, "_{}".format('type'), kwargs.get('type', None)) 168 setattr(self, "_{}".format('uri'), kwargs.get('uri', None)) 169 170 @property 171 def added_recipient_ids(self): 172 """Gets the added_recipient_ids of this EnvelopeDocument. # noqa: E501 173 174 # noqa: E501 175 176 :return: The added_recipient_ids of this EnvelopeDocument. # noqa: E501 177 :rtype: list[str] 178 """ 179 return self._added_recipient_ids 180 181 @added_recipient_ids.setter 182 def added_recipient_ids(self, added_recipient_ids): 183 """Sets the added_recipient_ids of this EnvelopeDocument. 184 185 # noqa: E501 186 187 :param added_recipient_ids: The added_recipient_ids of this EnvelopeDocument. # noqa: E501 188 :type: list[str] 189 """ 190 191 self._added_recipient_ids = added_recipient_ids 192 193 @property 194 def attachment_tab_id(self): 195 """Gets the attachment_tab_id of this EnvelopeDocument. # noqa: E501 196 197 # noqa: E501 198 199 :return: The attachment_tab_id of this EnvelopeDocument. # noqa: E501 200 :rtype: str 201 """ 202 return self._attachment_tab_id 203 204 @attachment_tab_id.setter 205 def attachment_tab_id(self, attachment_tab_id): 206 """Sets the attachment_tab_id of this EnvelopeDocument. 207 208 # noqa: E501 209 210 :param attachment_tab_id: The attachment_tab_id of this EnvelopeDocument. # noqa: E501 211 :type: str 212 """ 213 214 self._attachment_tab_id = attachment_tab_id 215 216 @property 217 def authoritative_copy(self): 218 """Gets the authoritative_copy of this EnvelopeDocument. # noqa: E501 219 220 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 221 222 :return: The authoritative_copy of this EnvelopeDocument. # noqa: E501 223 :rtype: str 224 """ 225 return self._authoritative_copy 226 227 @authoritative_copy.setter 228 def authoritative_copy(self, authoritative_copy): 229 """Sets the authoritative_copy of this EnvelopeDocument. 230 231 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 232 233 :param authoritative_copy: The authoritative_copy of this EnvelopeDocument. # noqa: E501 234 :type: str 235 """ 236 237 self._authoritative_copy = authoritative_copy 238 239 @property 240 def authoritative_copy_metadata(self): 241 """Gets the authoritative_copy_metadata of this EnvelopeDocument. # noqa: E501 242 243 Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. # noqa: E501 244 245 :return: The authoritative_copy_metadata of this EnvelopeDocument. # noqa: E501 246 :rtype: PropertyMetadata 247 """ 248 return self._authoritative_copy_metadata 249 250 @authoritative_copy_metadata.setter 251 def authoritative_copy_metadata(self, authoritative_copy_metadata): 252 """Sets the authoritative_copy_metadata of this EnvelopeDocument. 253 254 Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. # noqa: E501 255 256 :param authoritative_copy_metadata: The authoritative_copy_metadata of this EnvelopeDocument. # noqa: E501 257 :type: PropertyMetadata 258 """ 259 260 self._authoritative_copy_metadata = authoritative_copy_metadata 261 262 @property 263 def available_document_types(self): 264 """Gets the available_document_types of this EnvelopeDocument. # noqa: E501 265 266 # noqa: E501 267 268 :return: The available_document_types of this EnvelopeDocument. # noqa: E501 269 :rtype: list[SignatureType] 270 """ 271 return self._available_document_types 272 273 @available_document_types.setter 274 def available_document_types(self, available_document_types): 275 """Sets the available_document_types of this EnvelopeDocument. 276 277 # noqa: E501 278 279 :param available_document_types: The available_document_types of this EnvelopeDocument. # noqa: E501 280 :type: list[SignatureType] 281 """ 282 283 self._available_document_types = available_document_types 284 285 @property 286 def contains_pdf_form_fields(self): 287 """Gets the contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501 288 289 # noqa: E501 290 291 :return: The contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501 292 :rtype: str 293 """ 294 return self._contains_pdf_form_fields 295 296 @contains_pdf_form_fields.setter 297 def contains_pdf_form_fields(self, contains_pdf_form_fields): 298 """Sets the contains_pdf_form_fields of this EnvelopeDocument. 299 300 # noqa: E501 301 302 :param contains_pdf_form_fields: The contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501 303 :type: str 304 """ 305 306 self._contains_pdf_form_fields = contains_pdf_form_fields 307 308 @property 309 def display(self): 310 """Gets the display of this EnvelopeDocument. # noqa: E501 311 312 # noqa: E501 313 314 :return: The display of this EnvelopeDocument. # noqa: E501 315 :rtype: str 316 """ 317 return self._display 318 319 @display.setter 320 def display(self, display): 321 """Sets the display of this EnvelopeDocument. 322 323 # noqa: E501 324 325 :param display: The display of this EnvelopeDocument. # noqa: E501 326 :type: str 327 """ 328 329 self._display = display 330 331 @property 332 def display_metadata(self): 333 """Gets the display_metadata of this EnvelopeDocument. # noqa: E501 334 335 Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. # noqa: E501 336 337 :return: The display_metadata of this EnvelopeDocument. # noqa: E501 338 :rtype: PropertyMetadata 339 """ 340 return self._display_metadata 341 342 @display_metadata.setter 343 def display_metadata(self, display_metadata): 344 """Sets the display_metadata of this EnvelopeDocument. 345 346 Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. # noqa: E501 347 348 :param display_metadata: The display_metadata of this EnvelopeDocument. # noqa: E501 349 :type: PropertyMetadata 350 """ 351 352 self._display_metadata = display_metadata 353 354 @property 355 def doc_gen_document_status(self): 356 """Gets the doc_gen_document_status of this EnvelopeDocument. # noqa: E501 357 358 # noqa: E501 359 360 :return: The doc_gen_document_status of this EnvelopeDocument. # noqa: E501 361 :rtype: str 362 """ 363 return self._doc_gen_document_status 364 365 @doc_gen_document_status.setter 366 def doc_gen_document_status(self, doc_gen_document_status): 367 """Sets the doc_gen_document_status of this EnvelopeDocument. 368 369 # noqa: E501 370 371 :param doc_gen_document_status: The doc_gen_document_status of this EnvelopeDocument. # noqa: E501 372 :type: str 373 """ 374 375 self._doc_gen_document_status = doc_gen_document_status 376 377 @property 378 def doc_gen_errors(self): 379 """Gets the doc_gen_errors of this EnvelopeDocument. # noqa: E501 380 381 # noqa: E501 382 383 :return: The doc_gen_errors of this EnvelopeDocument. # noqa: E501 384 :rtype: list[DocGenSyntaxError] 385 """ 386 return self._doc_gen_errors 387 388 @doc_gen_errors.setter 389 def doc_gen_errors(self, doc_gen_errors): 390 """Sets the doc_gen_errors of this EnvelopeDocument. 391 392 # noqa: E501 393 394 :param doc_gen_errors: The doc_gen_errors of this EnvelopeDocument. # noqa: E501 395 :type: list[DocGenSyntaxError] 396 """ 397 398 self._doc_gen_errors = doc_gen_errors 399 400 @property 401 def doc_gen_form_fields(self): 402 """Gets the doc_gen_form_fields of this EnvelopeDocument. # noqa: E501 403 404 # noqa: E501 405 406 :return: The doc_gen_form_fields of this EnvelopeDocument. # noqa: E501 407 :rtype: list[DocGenFormField] 408 """ 409 return self._doc_gen_form_fields 410 411 @doc_gen_form_fields.setter 412 def doc_gen_form_fields(self, doc_gen_form_fields): 413 """Sets the doc_gen_form_fields of this EnvelopeDocument. 414 415 # noqa: E501 416 417 :param doc_gen_form_fields: The doc_gen_form_fields of this EnvelopeDocument. # noqa: E501 418 :type: list[DocGenFormField] 419 """ 420 421 self._doc_gen_form_fields = doc_gen_form_fields 422 423 @property 424 def document_base64(self): 425 """Gets the document_base64 of this EnvelopeDocument. # noqa: E501 426 427 # noqa: E501 428 429 :return: The document_base64 of this EnvelopeDocument. # noqa: E501 430 :rtype: str 431 """ 432 return self._document_base64 433 434 @document_base64.setter 435 def document_base64(self, document_base64): 436 """Sets the document_base64 of this EnvelopeDocument. 437 438 # noqa: E501 439 440 :param document_base64: The document_base64 of this EnvelopeDocument. # noqa: E501 441 :type: str 442 """ 443 444 self._document_base64 = document_base64 445 446 @property 447 def document_fields(self): 448 """Gets the document_fields of this EnvelopeDocument. # noqa: E501 449 450 # noqa: E501 451 452 :return: The document_fields of this EnvelopeDocument. # noqa: E501 453 :rtype: list[NameValue] 454 """ 455 return self._document_fields 456 457 @document_fields.setter 458 def document_fields(self, document_fields): 459 """Sets the document_fields of this EnvelopeDocument. 460 461 # noqa: E501 462 463 :param document_fields: The document_fields of this EnvelopeDocument. # noqa: E501 464 :type: list[NameValue] 465 """ 466 467 self._document_fields = document_fields 468 469 @property 470 def document_id(self): 471 """Gets the document_id of this EnvelopeDocument. # noqa: E501 472 473 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 474 475 :return: The document_id of this EnvelopeDocument. # noqa: E501 476 :rtype: str 477 """ 478 return self._document_id 479 480 @document_id.setter 481 def document_id(self, document_id): 482 """Sets the document_id of this EnvelopeDocument. 483 484 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 485 486 :param document_id: The document_id of this EnvelopeDocument. # noqa: E501 487 :type: str 488 """ 489 490 self._document_id = document_id 491 492 @property 493 def document_id_guid(self): 494 """Gets the document_id_guid of this EnvelopeDocument. # noqa: E501 495 496 # noqa: E501 497 498 :return: The document_id_guid of this EnvelopeDocument. # noqa: E501 499 :rtype: str 500 """ 501 return self._document_id_guid 502 503 @document_id_guid.setter 504 def document_id_guid(self, document_id_guid): 505 """Sets the document_id_guid of this EnvelopeDocument. 506 507 # noqa: E501 508 509 :param document_id_guid: The document_id_guid of this EnvelopeDocument. # noqa: E501 510 :type: str 511 """ 512 513 self._document_id_guid = document_id_guid 514 515 @property 516 def error_details(self): 517 """Gets the error_details of this EnvelopeDocument. # noqa: E501 518 519 Array or errors. # noqa: E501 520 521 :return: The error_details of this EnvelopeDocument. # noqa: E501 522 :rtype: ErrorDetails 523 """ 524 return self._error_details 525 526 @error_details.setter 527 def error_details(self, error_details): 528 """Sets the error_details of this EnvelopeDocument. 529 530 Array or errors. # noqa: E501 531 532 :param error_details: The error_details of this EnvelopeDocument. # noqa: E501 533 :type: ErrorDetails 534 """ 535 536 self._error_details = error_details 537 538 @property 539 def include_in_download(self): 540 """Gets the include_in_download of this EnvelopeDocument. # noqa: E501 541 542 # noqa: E501 543 544 :return: The include_in_download of this EnvelopeDocument. # noqa: E501 545 :rtype: str 546 """ 547 return self._include_in_download 548 549 @include_in_download.setter 550 def include_in_download(self, include_in_download): 551 """Sets the include_in_download of this EnvelopeDocument. 552 553 # noqa: E501 554 555 :param include_in_download: The include_in_download of this EnvelopeDocument. # noqa: E501 556 :type: str 557 """ 558 559 self._include_in_download = include_in_download 560 561 @property 562 def include_in_download_metadata(self): 563 """Gets the include_in_download_metadata of this EnvelopeDocument. # noqa: E501 564 565 Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents. # noqa: E501 566 567 :return: The include_in_download_metadata of this EnvelopeDocument. # noqa: E501 568 :rtype: PropertyMetadata 569 """ 570 return self._include_in_download_metadata 571 572 @include_in_download_metadata.setter 573 def include_in_download_metadata(self, include_in_download_metadata): 574 """Sets the include_in_download_metadata of this EnvelopeDocument. 575 576 Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents. # noqa: E501 577 578 :param include_in_download_metadata: The include_in_download_metadata of this EnvelopeDocument. # noqa: E501 579 :type: PropertyMetadata 580 """ 581 582 self._include_in_download_metadata = include_in_download_metadata 583 584 @property 585 def is_doc_gen_document(self): 586 """Gets the is_doc_gen_document of this EnvelopeDocument. # noqa: E501 587 588 # noqa: E501 589 590 :return: The is_doc_gen_document of this EnvelopeDocument. # noqa: E501 591 :rtype: str 592 """ 593 return self._is_doc_gen_document 594 595 @is_doc_gen_document.setter 596 def is_doc_gen_document(self, is_doc_gen_document): 597 """Sets the is_doc_gen_document of this EnvelopeDocument. 598 599 # noqa: E501 600 601 :param is_doc_gen_document: The is_doc_gen_document of this EnvelopeDocument. # noqa: E501 602 :type: str 603 """ 604 605 self._is_doc_gen_document = is_doc_gen_document 606 607 @property 608 def name(self): 609 """Gets the name of this EnvelopeDocument. # noqa: E501 610 611 # noqa: E501 612 613 :return: The name of this EnvelopeDocument. # noqa: E501 614 :rtype: str 615 """ 616 return self._name 617 618 @name.setter 619 def name(self, name): 620 """Sets the name of this EnvelopeDocument. 621 622 # noqa: E501 623 624 :param name: The name of this EnvelopeDocument. # noqa: E501 625 :type: str 626 """ 627 628 self._name = name 629 630 @property 631 def name_metadata(self): 632 """Gets the name_metadata of this EnvelopeDocument. # noqa: E501 633 634 Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. # noqa: E501 635 636 :return: The name_metadata of this EnvelopeDocument. # noqa: E501 637 :rtype: PropertyMetadata 638 """ 639 return self._name_metadata 640 641 @name_metadata.setter 642 def name_metadata(self, name_metadata): 643 """Sets the name_metadata of this EnvelopeDocument. 644 645 Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. # noqa: E501 646 647 :param name_metadata: The name_metadata of this EnvelopeDocument. # noqa: E501 648 :type: PropertyMetadata 649 """ 650 651 self._name_metadata = name_metadata 652 653 @property 654 def order(self): 655 """Gets the order of this EnvelopeDocument. # noqa: E501 656 657 # noqa: E501 658 659 :return: The order of this EnvelopeDocument. # noqa: E501 660 :rtype: str 661 """ 662 return self._order 663 664 @order.setter 665 def order(self, order): 666 """Sets the order of this EnvelopeDocument. 667 668 # noqa: E501 669 670 :param order: The order of this EnvelopeDocument. # noqa: E501 671 :type: str 672 """ 673 674 self._order = order 675 676 @property 677 def pages(self): 678 """Gets the pages of this EnvelopeDocument. # noqa: E501 679 680 # noqa: E501 681 682 :return: The pages of this EnvelopeDocument. # noqa: E501 683 :rtype: list[Page] 684 """ 685 return self._pages 686 687 @pages.setter 688 def pages(self, pages): 689 """Sets the pages of this EnvelopeDocument. 690 691 # noqa: E501 692 693 :param pages: The pages of this EnvelopeDocument. # noqa: E501 694 :type: list[Page] 695 """ 696 697 self._pages = pages 698 699 @property 700 def signer_must_acknowledge(self): 701 """Gets the signer_must_acknowledge of this EnvelopeDocument. # noqa: E501 702 703 # noqa: E501 704 705 :return: The signer_must_acknowledge of this EnvelopeDocument. # noqa: E501 706 :rtype: str 707 """ 708 return self._signer_must_acknowledge 709 710 @signer_must_acknowledge.setter 711 def signer_must_acknowledge(self, signer_must_acknowledge): 712 """Sets the signer_must_acknowledge of this EnvelopeDocument. 713 714 # noqa: E501 715 716 :param signer_must_acknowledge: The signer_must_acknowledge of this EnvelopeDocument. # noqa: E501 717 :type: str 718 """ 719 720 self._signer_must_acknowledge = signer_must_acknowledge 721 722 @property 723 def signer_must_acknowledge_metadata(self): 724 """Gets the signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501 725 726 Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. # noqa: E501 727 728 :return: The signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501 729 :rtype: PropertyMetadata 730 """ 731 return self._signer_must_acknowledge_metadata 732 733 @signer_must_acknowledge_metadata.setter 734 def signer_must_acknowledge_metadata(self, signer_must_acknowledge_metadata): 735 """Sets the signer_must_acknowledge_metadata of this EnvelopeDocument. 736 737 Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. # noqa: E501 738 739 :param signer_must_acknowledge_metadata: The signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501 740 :type: PropertyMetadata 741 """ 742 743 self._signer_must_acknowledge_metadata = signer_must_acknowledge_metadata 744 745 @property 746 def size_bytes(self): 747 """Gets the size_bytes of this EnvelopeDocument. # noqa: E501 748 749 # noqa: E501 750 751 :return: The size_bytes of this EnvelopeDocument. # noqa: E501 752 :rtype: str 753 """ 754 return self._size_bytes 755 756 @size_bytes.setter 757 def size_bytes(self, size_bytes): 758 """Sets the size_bytes of this EnvelopeDocument. 759 760 # noqa: E501 761 762 :param size_bytes: The size_bytes of this EnvelopeDocument. # noqa: E501 763 :type: str 764 """ 765 766 self._size_bytes = size_bytes 767 768 @property 769 def template_locked(self): 770 """Gets the template_locked of this EnvelopeDocument. # noqa: E501 771 772 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 773 774 :return: The template_locked of this EnvelopeDocument. # noqa: E501 775 :rtype: str 776 """ 777 return self._template_locked 778 779 @template_locked.setter 780 def template_locked(self, template_locked): 781 """Sets the template_locked of this EnvelopeDocument. 782 783 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 784 785 :param template_locked: The template_locked of this EnvelopeDocument. # noqa: E501 786 :type: str 787 """ 788 789 self._template_locked = template_locked 790 791 @property 792 def template_required(self): 793 """Gets the template_required of this EnvelopeDocument. # noqa: E501 794 795 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 796 797 :return: The template_required of this EnvelopeDocument. # noqa: E501 798 :rtype: str 799 """ 800 return self._template_required 801 802 @template_required.setter 803 def template_required(self, template_required): 804 """Sets the template_required of this EnvelopeDocument. 805 806 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 807 808 :param template_required: The template_required of this EnvelopeDocument. # noqa: E501 809 :type: str 810 """ 811 812 self._template_required = template_required 813 814 @property 815 def type(self): 816 """Gets the type of this EnvelopeDocument. # noqa: E501 817 818 # noqa: E501 819 820 :return: The type of this EnvelopeDocument. # noqa: E501 821 :rtype: str 822 """ 823 return self._type 824 825 @type.setter 826 def type(self, type): 827 """Sets the type of this EnvelopeDocument. 828 829 # noqa: E501 830 831 :param type: The type of this EnvelopeDocument. # noqa: E501 832 :type: str 833 """ 834 835 self._type = type 836 837 @property 838 def uri(self): 839 """Gets the uri of this EnvelopeDocument. # noqa: E501 840 841 # noqa: E501 842 843 :return: The uri of this EnvelopeDocument. # noqa: E501 844 :rtype: str 845 """ 846 return self._uri 847 848 @uri.setter 849 def uri(self, uri): 850 """Sets the uri of this EnvelopeDocument. 851 852 # noqa: E501 853 854 :param uri: The uri of this EnvelopeDocument. # noqa: E501 855 :type: str 856 """ 857 858 self._uri = uri 859 860 def to_dict(self): 861 """Returns the model properties as a dict""" 862 result = {} 863 864 for attr, _ in six.iteritems(self.swagger_types): 865 value = getattr(self, attr) 866 if isinstance(value, list): 867 result[attr] = list(map( 868 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 869 value 870 )) 871 elif hasattr(value, "to_dict"): 872 result[attr] = value.to_dict() 873 elif isinstance(value, dict): 874 result[attr] = dict(map( 875 lambda item: (item[0], item[1].to_dict()) 876 if hasattr(item[1], "to_dict") else item, 877 value.items() 878 )) 879 else: 880 result[attr] = value 881 if issubclass(EnvelopeDocument, dict): 882 for key, value in self.items(): 883 result[key] = value 884 885 return result 886 887 def to_str(self): 888 """Returns the string representation of the model""" 889 return pprint.pformat(self.to_dict()) 890 891 def __repr__(self): 892 """For `print` and `pprint`""" 893 return self.to_str() 894 895 def __eq__(self, other): 896 """Returns true if both objects are equal""" 897 if not isinstance(other, EnvelopeDocument): 898 return False 899 900 return self.to_dict() == other.to_dict() 901 902 def __ne__(self, other): 903 """Returns true if both objects are not equal""" 904 if not isinstance(other, EnvelopeDocument): 905 return True 906 907 return self.to_dict() != other.to_dict()
class
EnvelopeDocument:
23class EnvelopeDocument(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 'added_recipient_ids': 'list[str]', 38 'attachment_tab_id': 'str', 39 'authoritative_copy': 'str', 40 'authoritative_copy_metadata': 'PropertyMetadata', 41 'available_document_types': 'list[SignatureType]', 42 'contains_pdf_form_fields': 'str', 43 'display': 'str', 44 'display_metadata': 'PropertyMetadata', 45 'doc_gen_document_status': 'str', 46 'doc_gen_errors': 'list[DocGenSyntaxError]', 47 'doc_gen_form_fields': 'list[DocGenFormField]', 48 'document_base64': 'str', 49 'document_fields': 'list[NameValue]', 50 'document_id': 'str', 51 'document_id_guid': 'str', 52 'error_details': 'ErrorDetails', 53 'include_in_download': 'str', 54 'include_in_download_metadata': 'PropertyMetadata', 55 'is_doc_gen_document': 'str', 56 'name': 'str', 57 'name_metadata': 'PropertyMetadata', 58 'order': 'str', 59 'pages': 'list[Page]', 60 'signer_must_acknowledge': 'str', 61 'signer_must_acknowledge_metadata': 'PropertyMetadata', 62 'size_bytes': 'str', 63 'template_locked': 'str', 64 'template_required': 'str', 65 'type': 'str', 66 'uri': 'str' 67 } 68 69 attribute_map = { 70 'added_recipient_ids': 'addedRecipientIds', 71 'attachment_tab_id': 'attachmentTabId', 72 'authoritative_copy': 'authoritativeCopy', 73 'authoritative_copy_metadata': 'authoritativeCopyMetadata', 74 'available_document_types': 'availableDocumentTypes', 75 'contains_pdf_form_fields': 'containsPdfFormFields', 76 'display': 'display', 77 'display_metadata': 'displayMetadata', 78 'doc_gen_document_status': 'docGenDocumentStatus', 79 'doc_gen_errors': 'docGenErrors', 80 'doc_gen_form_fields': 'docGenFormFields', 81 'document_base64': 'documentBase64', 82 'document_fields': 'documentFields', 83 'document_id': 'documentId', 84 'document_id_guid': 'documentIdGuid', 85 'error_details': 'errorDetails', 86 'include_in_download': 'includeInDownload', 87 'include_in_download_metadata': 'includeInDownloadMetadata', 88 'is_doc_gen_document': 'isDocGenDocument', 89 'name': 'name', 90 'name_metadata': 'nameMetadata', 91 'order': 'order', 92 'pages': 'pages', 93 'signer_must_acknowledge': 'signerMustAcknowledge', 94 'signer_must_acknowledge_metadata': 'signerMustAcknowledgeMetadata', 95 'size_bytes': 'sizeBytes', 96 'template_locked': 'templateLocked', 97 'template_required': 'templateRequired', 98 'type': 'type', 99 'uri': 'uri' 100 } 101 102 def __init__(self, _configuration=None, **kwargs): # noqa: E501 103 """EnvelopeDocument - a model defined in Swagger""" # noqa: E501 104 if _configuration is None: 105 _configuration = Configuration() 106 self._configuration = _configuration 107 108 self._added_recipient_ids = None 109 self._attachment_tab_id = None 110 self._authoritative_copy = None 111 self._authoritative_copy_metadata = None 112 self._available_document_types = None 113 self._contains_pdf_form_fields = None 114 self._display = None 115 self._display_metadata = None 116 self._doc_gen_document_status = None 117 self._doc_gen_errors = None 118 self._doc_gen_form_fields = None 119 self._document_base64 = None 120 self._document_fields = None 121 self._document_id = None 122 self._document_id_guid = None 123 self._error_details = None 124 self._include_in_download = None 125 self._include_in_download_metadata = None 126 self._is_doc_gen_document = None 127 self._name = None 128 self._name_metadata = None 129 self._order = None 130 self._pages = None 131 self._signer_must_acknowledge = None 132 self._signer_must_acknowledge_metadata = None 133 self._size_bytes = None 134 self._template_locked = None 135 self._template_required = None 136 self._type = None 137 self._uri = None 138 self.discriminator = None 139 140 setattr(self, "_{}".format('added_recipient_ids'), kwargs.get('added_recipient_ids', None)) 141 setattr(self, "_{}".format('attachment_tab_id'), kwargs.get('attachment_tab_id', None)) 142 setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) 143 setattr(self, "_{}".format('authoritative_copy_metadata'), kwargs.get('authoritative_copy_metadata', None)) 144 setattr(self, "_{}".format('available_document_types'), kwargs.get('available_document_types', None)) 145 setattr(self, "_{}".format('contains_pdf_form_fields'), kwargs.get('contains_pdf_form_fields', None)) 146 setattr(self, "_{}".format('display'), kwargs.get('display', None)) 147 setattr(self, "_{}".format('display_metadata'), kwargs.get('display_metadata', None)) 148 setattr(self, "_{}".format('doc_gen_document_status'), kwargs.get('doc_gen_document_status', None)) 149 setattr(self, "_{}".format('doc_gen_errors'), kwargs.get('doc_gen_errors', None)) 150 setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) 151 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 152 setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None)) 153 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 154 setattr(self, "_{}".format('document_id_guid'), kwargs.get('document_id_guid', None)) 155 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 156 setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None)) 157 setattr(self, "_{}".format('include_in_download_metadata'), kwargs.get('include_in_download_metadata', None)) 158 setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None)) 159 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 160 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 161 setattr(self, "_{}".format('order'), kwargs.get('order', None)) 162 setattr(self, "_{}".format('pages'), kwargs.get('pages', None)) 163 setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None)) 164 setattr(self, "_{}".format('signer_must_acknowledge_metadata'), kwargs.get('signer_must_acknowledge_metadata', None)) 165 setattr(self, "_{}".format('size_bytes'), kwargs.get('size_bytes', None)) 166 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 167 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 168 setattr(self, "_{}".format('type'), kwargs.get('type', None)) 169 setattr(self, "_{}".format('uri'), kwargs.get('uri', None)) 170 171 @property 172 def added_recipient_ids(self): 173 """Gets the added_recipient_ids of this EnvelopeDocument. # noqa: E501 174 175 # noqa: E501 176 177 :return: The added_recipient_ids of this EnvelopeDocument. # noqa: E501 178 :rtype: list[str] 179 """ 180 return self._added_recipient_ids 181 182 @added_recipient_ids.setter 183 def added_recipient_ids(self, added_recipient_ids): 184 """Sets the added_recipient_ids of this EnvelopeDocument. 185 186 # noqa: E501 187 188 :param added_recipient_ids: The added_recipient_ids of this EnvelopeDocument. # noqa: E501 189 :type: list[str] 190 """ 191 192 self._added_recipient_ids = added_recipient_ids 193 194 @property 195 def attachment_tab_id(self): 196 """Gets the attachment_tab_id of this EnvelopeDocument. # noqa: E501 197 198 # noqa: E501 199 200 :return: The attachment_tab_id of this EnvelopeDocument. # noqa: E501 201 :rtype: str 202 """ 203 return self._attachment_tab_id 204 205 @attachment_tab_id.setter 206 def attachment_tab_id(self, attachment_tab_id): 207 """Sets the attachment_tab_id of this EnvelopeDocument. 208 209 # noqa: E501 210 211 :param attachment_tab_id: The attachment_tab_id of this EnvelopeDocument. # noqa: E501 212 :type: str 213 """ 214 215 self._attachment_tab_id = attachment_tab_id 216 217 @property 218 def authoritative_copy(self): 219 """Gets the authoritative_copy of this EnvelopeDocument. # noqa: E501 220 221 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 222 223 :return: The authoritative_copy of this EnvelopeDocument. # noqa: E501 224 :rtype: str 225 """ 226 return self._authoritative_copy 227 228 @authoritative_copy.setter 229 def authoritative_copy(self, authoritative_copy): 230 """Sets the authoritative_copy of this EnvelopeDocument. 231 232 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 233 234 :param authoritative_copy: The authoritative_copy of this EnvelopeDocument. # noqa: E501 235 :type: str 236 """ 237 238 self._authoritative_copy = authoritative_copy 239 240 @property 241 def authoritative_copy_metadata(self): 242 """Gets the authoritative_copy_metadata of this EnvelopeDocument. # noqa: E501 243 244 Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. # noqa: E501 245 246 :return: The authoritative_copy_metadata of this EnvelopeDocument. # noqa: E501 247 :rtype: PropertyMetadata 248 """ 249 return self._authoritative_copy_metadata 250 251 @authoritative_copy_metadata.setter 252 def authoritative_copy_metadata(self, authoritative_copy_metadata): 253 """Sets the authoritative_copy_metadata of this EnvelopeDocument. 254 255 Metadata that indicates if the sender can edit the `authoritativeCopy` property. Not applicable for template documents. # noqa: E501 256 257 :param authoritative_copy_metadata: The authoritative_copy_metadata of this EnvelopeDocument. # noqa: E501 258 :type: PropertyMetadata 259 """ 260 261 self._authoritative_copy_metadata = authoritative_copy_metadata 262 263 @property 264 def available_document_types(self): 265 """Gets the available_document_types of this EnvelopeDocument. # noqa: E501 266 267 # noqa: E501 268 269 :return: The available_document_types of this EnvelopeDocument. # noqa: E501 270 :rtype: list[SignatureType] 271 """ 272 return self._available_document_types 273 274 @available_document_types.setter 275 def available_document_types(self, available_document_types): 276 """Sets the available_document_types of this EnvelopeDocument. 277 278 # noqa: E501 279 280 :param available_document_types: The available_document_types of this EnvelopeDocument. # noqa: E501 281 :type: list[SignatureType] 282 """ 283 284 self._available_document_types = available_document_types 285 286 @property 287 def contains_pdf_form_fields(self): 288 """Gets the contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501 289 290 # noqa: E501 291 292 :return: The contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501 293 :rtype: str 294 """ 295 return self._contains_pdf_form_fields 296 297 @contains_pdf_form_fields.setter 298 def contains_pdf_form_fields(self, contains_pdf_form_fields): 299 """Sets the contains_pdf_form_fields of this EnvelopeDocument. 300 301 # noqa: E501 302 303 :param contains_pdf_form_fields: The contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501 304 :type: str 305 """ 306 307 self._contains_pdf_form_fields = contains_pdf_form_fields 308 309 @property 310 def display(self): 311 """Gets the display of this EnvelopeDocument. # noqa: E501 312 313 # noqa: E501 314 315 :return: The display of this EnvelopeDocument. # noqa: E501 316 :rtype: str 317 """ 318 return self._display 319 320 @display.setter 321 def display(self, display): 322 """Sets the display of this EnvelopeDocument. 323 324 # noqa: E501 325 326 :param display: The display of this EnvelopeDocument. # noqa: E501 327 :type: str 328 """ 329 330 self._display = display 331 332 @property 333 def display_metadata(self): 334 """Gets the display_metadata of this EnvelopeDocument. # noqa: E501 335 336 Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. # noqa: E501 337 338 :return: The display_metadata of this EnvelopeDocument. # noqa: E501 339 :rtype: PropertyMetadata 340 """ 341 return self._display_metadata 342 343 @display_metadata.setter 344 def display_metadata(self, display_metadata): 345 """Sets the display_metadata of this EnvelopeDocument. 346 347 Metadata that indicates if the sender can edit the `display` property. Not applicable for template documents. # noqa: E501 348 349 :param display_metadata: The display_metadata of this EnvelopeDocument. # noqa: E501 350 :type: PropertyMetadata 351 """ 352 353 self._display_metadata = display_metadata 354 355 @property 356 def doc_gen_document_status(self): 357 """Gets the doc_gen_document_status of this EnvelopeDocument. # noqa: E501 358 359 # noqa: E501 360 361 :return: The doc_gen_document_status of this EnvelopeDocument. # noqa: E501 362 :rtype: str 363 """ 364 return self._doc_gen_document_status 365 366 @doc_gen_document_status.setter 367 def doc_gen_document_status(self, doc_gen_document_status): 368 """Sets the doc_gen_document_status of this EnvelopeDocument. 369 370 # noqa: E501 371 372 :param doc_gen_document_status: The doc_gen_document_status of this EnvelopeDocument. # noqa: E501 373 :type: str 374 """ 375 376 self._doc_gen_document_status = doc_gen_document_status 377 378 @property 379 def doc_gen_errors(self): 380 """Gets the doc_gen_errors of this EnvelopeDocument. # noqa: E501 381 382 # noqa: E501 383 384 :return: The doc_gen_errors of this EnvelopeDocument. # noqa: E501 385 :rtype: list[DocGenSyntaxError] 386 """ 387 return self._doc_gen_errors 388 389 @doc_gen_errors.setter 390 def doc_gen_errors(self, doc_gen_errors): 391 """Sets the doc_gen_errors of this EnvelopeDocument. 392 393 # noqa: E501 394 395 :param doc_gen_errors: The doc_gen_errors of this EnvelopeDocument. # noqa: E501 396 :type: list[DocGenSyntaxError] 397 """ 398 399 self._doc_gen_errors = doc_gen_errors 400 401 @property 402 def doc_gen_form_fields(self): 403 """Gets the doc_gen_form_fields of this EnvelopeDocument. # noqa: E501 404 405 # noqa: E501 406 407 :return: The doc_gen_form_fields of this EnvelopeDocument. # noqa: E501 408 :rtype: list[DocGenFormField] 409 """ 410 return self._doc_gen_form_fields 411 412 @doc_gen_form_fields.setter 413 def doc_gen_form_fields(self, doc_gen_form_fields): 414 """Sets the doc_gen_form_fields of this EnvelopeDocument. 415 416 # noqa: E501 417 418 :param doc_gen_form_fields: The doc_gen_form_fields of this EnvelopeDocument. # noqa: E501 419 :type: list[DocGenFormField] 420 """ 421 422 self._doc_gen_form_fields = doc_gen_form_fields 423 424 @property 425 def document_base64(self): 426 """Gets the document_base64 of this EnvelopeDocument. # noqa: E501 427 428 # noqa: E501 429 430 :return: The document_base64 of this EnvelopeDocument. # noqa: E501 431 :rtype: str 432 """ 433 return self._document_base64 434 435 @document_base64.setter 436 def document_base64(self, document_base64): 437 """Sets the document_base64 of this EnvelopeDocument. 438 439 # noqa: E501 440 441 :param document_base64: The document_base64 of this EnvelopeDocument. # noqa: E501 442 :type: str 443 """ 444 445 self._document_base64 = document_base64 446 447 @property 448 def document_fields(self): 449 """Gets the document_fields of this EnvelopeDocument. # noqa: E501 450 451 # noqa: E501 452 453 :return: The document_fields of this EnvelopeDocument. # noqa: E501 454 :rtype: list[NameValue] 455 """ 456 return self._document_fields 457 458 @document_fields.setter 459 def document_fields(self, document_fields): 460 """Sets the document_fields of this EnvelopeDocument. 461 462 # noqa: E501 463 464 :param document_fields: The document_fields of this EnvelopeDocument. # noqa: E501 465 :type: list[NameValue] 466 """ 467 468 self._document_fields = document_fields 469 470 @property 471 def document_id(self): 472 """Gets the document_id of this EnvelopeDocument. # noqa: E501 473 474 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 475 476 :return: The document_id of this EnvelopeDocument. # noqa: E501 477 :rtype: str 478 """ 479 return self._document_id 480 481 @document_id.setter 482 def document_id(self, document_id): 483 """Sets the document_id of this EnvelopeDocument. 484 485 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 486 487 :param document_id: The document_id of this EnvelopeDocument. # noqa: E501 488 :type: str 489 """ 490 491 self._document_id = document_id 492 493 @property 494 def document_id_guid(self): 495 """Gets the document_id_guid of this EnvelopeDocument. # noqa: E501 496 497 # noqa: E501 498 499 :return: The document_id_guid of this EnvelopeDocument. # noqa: E501 500 :rtype: str 501 """ 502 return self._document_id_guid 503 504 @document_id_guid.setter 505 def document_id_guid(self, document_id_guid): 506 """Sets the document_id_guid of this EnvelopeDocument. 507 508 # noqa: E501 509 510 :param document_id_guid: The document_id_guid of this EnvelopeDocument. # noqa: E501 511 :type: str 512 """ 513 514 self._document_id_guid = document_id_guid 515 516 @property 517 def error_details(self): 518 """Gets the error_details of this EnvelopeDocument. # noqa: E501 519 520 Array or errors. # noqa: E501 521 522 :return: The error_details of this EnvelopeDocument. # noqa: E501 523 :rtype: ErrorDetails 524 """ 525 return self._error_details 526 527 @error_details.setter 528 def error_details(self, error_details): 529 """Sets the error_details of this EnvelopeDocument. 530 531 Array or errors. # noqa: E501 532 533 :param error_details: The error_details of this EnvelopeDocument. # noqa: E501 534 :type: ErrorDetails 535 """ 536 537 self._error_details = error_details 538 539 @property 540 def include_in_download(self): 541 """Gets the include_in_download of this EnvelopeDocument. # noqa: E501 542 543 # noqa: E501 544 545 :return: The include_in_download of this EnvelopeDocument. # noqa: E501 546 :rtype: str 547 """ 548 return self._include_in_download 549 550 @include_in_download.setter 551 def include_in_download(self, include_in_download): 552 """Sets the include_in_download of this EnvelopeDocument. 553 554 # noqa: E501 555 556 :param include_in_download: The include_in_download of this EnvelopeDocument. # noqa: E501 557 :type: str 558 """ 559 560 self._include_in_download = include_in_download 561 562 @property 563 def include_in_download_metadata(self): 564 """Gets the include_in_download_metadata of this EnvelopeDocument. # noqa: E501 565 566 Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents. # noqa: E501 567 568 :return: The include_in_download_metadata of this EnvelopeDocument. # noqa: E501 569 :rtype: PropertyMetadata 570 """ 571 return self._include_in_download_metadata 572 573 @include_in_download_metadata.setter 574 def include_in_download_metadata(self, include_in_download_metadata): 575 """Sets the include_in_download_metadata of this EnvelopeDocument. 576 577 Metadata that indicates if the sender can edit the `includeInDownload` property. Not applicable for template documents. # noqa: E501 578 579 :param include_in_download_metadata: The include_in_download_metadata of this EnvelopeDocument. # noqa: E501 580 :type: PropertyMetadata 581 """ 582 583 self._include_in_download_metadata = include_in_download_metadata 584 585 @property 586 def is_doc_gen_document(self): 587 """Gets the is_doc_gen_document of this EnvelopeDocument. # noqa: E501 588 589 # noqa: E501 590 591 :return: The is_doc_gen_document of this EnvelopeDocument. # noqa: E501 592 :rtype: str 593 """ 594 return self._is_doc_gen_document 595 596 @is_doc_gen_document.setter 597 def is_doc_gen_document(self, is_doc_gen_document): 598 """Sets the is_doc_gen_document of this EnvelopeDocument. 599 600 # noqa: E501 601 602 :param is_doc_gen_document: The is_doc_gen_document of this EnvelopeDocument. # noqa: E501 603 :type: str 604 """ 605 606 self._is_doc_gen_document = is_doc_gen_document 607 608 @property 609 def name(self): 610 """Gets the name of this EnvelopeDocument. # noqa: E501 611 612 # noqa: E501 613 614 :return: The name of this EnvelopeDocument. # noqa: E501 615 :rtype: str 616 """ 617 return self._name 618 619 @name.setter 620 def name(self, name): 621 """Sets the name of this EnvelopeDocument. 622 623 # noqa: E501 624 625 :param name: The name of this EnvelopeDocument. # noqa: E501 626 :type: str 627 """ 628 629 self._name = name 630 631 @property 632 def name_metadata(self): 633 """Gets the name_metadata of this EnvelopeDocument. # noqa: E501 634 635 Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. # noqa: E501 636 637 :return: The name_metadata of this EnvelopeDocument. # noqa: E501 638 :rtype: PropertyMetadata 639 """ 640 return self._name_metadata 641 642 @name_metadata.setter 643 def name_metadata(self, name_metadata): 644 """Sets the name_metadata of this EnvelopeDocument. 645 646 Metadata that indicates if the sender can edit the `name` property. Not applicable for template documents. # noqa: E501 647 648 :param name_metadata: The name_metadata of this EnvelopeDocument. # noqa: E501 649 :type: PropertyMetadata 650 """ 651 652 self._name_metadata = name_metadata 653 654 @property 655 def order(self): 656 """Gets the order of this EnvelopeDocument. # noqa: E501 657 658 # noqa: E501 659 660 :return: The order of this EnvelopeDocument. # noqa: E501 661 :rtype: str 662 """ 663 return self._order 664 665 @order.setter 666 def order(self, order): 667 """Sets the order of this EnvelopeDocument. 668 669 # noqa: E501 670 671 :param order: The order of this EnvelopeDocument. # noqa: E501 672 :type: str 673 """ 674 675 self._order = order 676 677 @property 678 def pages(self): 679 """Gets the pages of this EnvelopeDocument. # noqa: E501 680 681 # noqa: E501 682 683 :return: The pages of this EnvelopeDocument. # noqa: E501 684 :rtype: list[Page] 685 """ 686 return self._pages 687 688 @pages.setter 689 def pages(self, pages): 690 """Sets the pages of this EnvelopeDocument. 691 692 # noqa: E501 693 694 :param pages: The pages of this EnvelopeDocument. # noqa: E501 695 :type: list[Page] 696 """ 697 698 self._pages = pages 699 700 @property 701 def signer_must_acknowledge(self): 702 """Gets the signer_must_acknowledge of this EnvelopeDocument. # noqa: E501 703 704 # noqa: E501 705 706 :return: The signer_must_acknowledge of this EnvelopeDocument. # noqa: E501 707 :rtype: str 708 """ 709 return self._signer_must_acknowledge 710 711 @signer_must_acknowledge.setter 712 def signer_must_acknowledge(self, signer_must_acknowledge): 713 """Sets the signer_must_acknowledge of this EnvelopeDocument. 714 715 # noqa: E501 716 717 :param signer_must_acknowledge: The signer_must_acknowledge of this EnvelopeDocument. # noqa: E501 718 :type: str 719 """ 720 721 self._signer_must_acknowledge = signer_must_acknowledge 722 723 @property 724 def signer_must_acknowledge_metadata(self): 725 """Gets the signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501 726 727 Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. # noqa: E501 728 729 :return: The signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501 730 :rtype: PropertyMetadata 731 """ 732 return self._signer_must_acknowledge_metadata 733 734 @signer_must_acknowledge_metadata.setter 735 def signer_must_acknowledge_metadata(self, signer_must_acknowledge_metadata): 736 """Sets the signer_must_acknowledge_metadata of this EnvelopeDocument. 737 738 Metadata that indicates if the sender can edit the `signerMustAcknowledge` property. Not applicable for template documents. # noqa: E501 739 740 :param signer_must_acknowledge_metadata: The signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501 741 :type: PropertyMetadata 742 """ 743 744 self._signer_must_acknowledge_metadata = signer_must_acknowledge_metadata 745 746 @property 747 def size_bytes(self): 748 """Gets the size_bytes of this EnvelopeDocument. # noqa: E501 749 750 # noqa: E501 751 752 :return: The size_bytes of this EnvelopeDocument. # noqa: E501 753 :rtype: str 754 """ 755 return self._size_bytes 756 757 @size_bytes.setter 758 def size_bytes(self, size_bytes): 759 """Sets the size_bytes of this EnvelopeDocument. 760 761 # noqa: E501 762 763 :param size_bytes: The size_bytes of this EnvelopeDocument. # noqa: E501 764 :type: str 765 """ 766 767 self._size_bytes = size_bytes 768 769 @property 770 def template_locked(self): 771 """Gets the template_locked of this EnvelopeDocument. # noqa: E501 772 773 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 774 775 :return: The template_locked of this EnvelopeDocument. # noqa: E501 776 :rtype: str 777 """ 778 return self._template_locked 779 780 @template_locked.setter 781 def template_locked(self, template_locked): 782 """Sets the template_locked of this EnvelopeDocument. 783 784 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 785 786 :param template_locked: The template_locked of this EnvelopeDocument. # noqa: E501 787 :type: str 788 """ 789 790 self._template_locked = template_locked 791 792 @property 793 def template_required(self): 794 """Gets the template_required of this EnvelopeDocument. # noqa: E501 795 796 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 797 798 :return: The template_required of this EnvelopeDocument. # noqa: E501 799 :rtype: str 800 """ 801 return self._template_required 802 803 @template_required.setter 804 def template_required(self, template_required): 805 """Sets the template_required of this EnvelopeDocument. 806 807 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 808 809 :param template_required: The template_required of this EnvelopeDocument. # noqa: E501 810 :type: str 811 """ 812 813 self._template_required = template_required 814 815 @property 816 def type(self): 817 """Gets the type of this EnvelopeDocument. # noqa: E501 818 819 # noqa: E501 820 821 :return: The type of this EnvelopeDocument. # noqa: E501 822 :rtype: str 823 """ 824 return self._type 825 826 @type.setter 827 def type(self, type): 828 """Sets the type of this EnvelopeDocument. 829 830 # noqa: E501 831 832 :param type: The type of this EnvelopeDocument. # noqa: E501 833 :type: str 834 """ 835 836 self._type = type 837 838 @property 839 def uri(self): 840 """Gets the uri of this EnvelopeDocument. # noqa: E501 841 842 # noqa: E501 843 844 :return: The uri of this EnvelopeDocument. # noqa: E501 845 :rtype: str 846 """ 847 return self._uri 848 849 @uri.setter 850 def uri(self, uri): 851 """Sets the uri of this EnvelopeDocument. 852 853 # noqa: E501 854 855 :param uri: The uri of this EnvelopeDocument. # noqa: E501 856 :type: str 857 """ 858 859 self._uri = uri 860 861 def to_dict(self): 862 """Returns the model properties as a dict""" 863 result = {} 864 865 for attr, _ in six.iteritems(self.swagger_types): 866 value = getattr(self, attr) 867 if isinstance(value, list): 868 result[attr] = list(map( 869 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 870 value 871 )) 872 elif hasattr(value, "to_dict"): 873 result[attr] = value.to_dict() 874 elif isinstance(value, dict): 875 result[attr] = dict(map( 876 lambda item: (item[0], item[1].to_dict()) 877 if hasattr(item[1], "to_dict") else item, 878 value.items() 879 )) 880 else: 881 result[attr] = value 882 if issubclass(EnvelopeDocument, dict): 883 for key, value in self.items(): 884 result[key] = value 885 886 return result 887 888 def to_str(self): 889 """Returns the string representation of the model""" 890 return pprint.pformat(self.to_dict()) 891 892 def __repr__(self): 893 """For `print` and `pprint`""" 894 return self.to_str() 895 896 def __eq__(self, other): 897 """Returns true if both objects are equal""" 898 if not isinstance(other, EnvelopeDocument): 899 return False 900 901 return self.to_dict() == other.to_dict() 902 903 def __ne__(self, other): 904 """Returns true if both objects are not equal""" 905 if not isinstance(other, EnvelopeDocument): 906 return True 907 908 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.
EnvelopeDocument(_configuration=None, **kwargs)
102 def __init__(self, _configuration=None, **kwargs): # noqa: E501 103 """EnvelopeDocument - a model defined in Swagger""" # noqa: E501 104 if _configuration is None: 105 _configuration = Configuration() 106 self._configuration = _configuration 107 108 self._added_recipient_ids = None 109 self._attachment_tab_id = None 110 self._authoritative_copy = None 111 self._authoritative_copy_metadata = None 112 self._available_document_types = None 113 self._contains_pdf_form_fields = None 114 self._display = None 115 self._display_metadata = None 116 self._doc_gen_document_status = None 117 self._doc_gen_errors = None 118 self._doc_gen_form_fields = None 119 self._document_base64 = None 120 self._document_fields = None 121 self._document_id = None 122 self._document_id_guid = None 123 self._error_details = None 124 self._include_in_download = None 125 self._include_in_download_metadata = None 126 self._is_doc_gen_document = None 127 self._name = None 128 self._name_metadata = None 129 self._order = None 130 self._pages = None 131 self._signer_must_acknowledge = None 132 self._signer_must_acknowledge_metadata = None 133 self._size_bytes = None 134 self._template_locked = None 135 self._template_required = None 136 self._type = None 137 self._uri = None 138 self.discriminator = None 139 140 setattr(self, "_{}".format('added_recipient_ids'), kwargs.get('added_recipient_ids', None)) 141 setattr(self, "_{}".format('attachment_tab_id'), kwargs.get('attachment_tab_id', None)) 142 setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) 143 setattr(self, "_{}".format('authoritative_copy_metadata'), kwargs.get('authoritative_copy_metadata', None)) 144 setattr(self, "_{}".format('available_document_types'), kwargs.get('available_document_types', None)) 145 setattr(self, "_{}".format('contains_pdf_form_fields'), kwargs.get('contains_pdf_form_fields', None)) 146 setattr(self, "_{}".format('display'), kwargs.get('display', None)) 147 setattr(self, "_{}".format('display_metadata'), kwargs.get('display_metadata', None)) 148 setattr(self, "_{}".format('doc_gen_document_status'), kwargs.get('doc_gen_document_status', None)) 149 setattr(self, "_{}".format('doc_gen_errors'), kwargs.get('doc_gen_errors', None)) 150 setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) 151 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 152 setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None)) 153 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 154 setattr(self, "_{}".format('document_id_guid'), kwargs.get('document_id_guid', None)) 155 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 156 setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None)) 157 setattr(self, "_{}".format('include_in_download_metadata'), kwargs.get('include_in_download_metadata', None)) 158 setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None)) 159 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 160 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 161 setattr(self, "_{}".format('order'), kwargs.get('order', None)) 162 setattr(self, "_{}".format('pages'), kwargs.get('pages', None)) 163 setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None)) 164 setattr(self, "_{}".format('signer_must_acknowledge_metadata'), kwargs.get('signer_must_acknowledge_metadata', None)) 165 setattr(self, "_{}".format('size_bytes'), kwargs.get('size_bytes', None)) 166 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 167 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 168 setattr(self, "_{}".format('type'), kwargs.get('type', None)) 169 setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
EnvelopeDocument - a model defined in Swagger
swagger_types = {'added_recipient_ids': 'list[str]', 'attachment_tab_id': 'str', 'authoritative_copy': 'str', 'authoritative_copy_metadata': 'PropertyMetadata', 'available_document_types': 'list[SignatureType]', 'contains_pdf_form_fields': 'str', 'display': 'str', 'display_metadata': 'PropertyMetadata', 'doc_gen_document_status': 'str', 'doc_gen_errors': 'list[DocGenSyntaxError]', 'doc_gen_form_fields': 'list[DocGenFormField]', 'document_base64': 'str', 'document_fields': 'list[NameValue]', 'document_id': 'str', 'document_id_guid': 'str', 'error_details': 'ErrorDetails', 'include_in_download': 'str', 'include_in_download_metadata': 'PropertyMetadata', 'is_doc_gen_document': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', 'order': 'str', 'pages': 'list[Page]', 'signer_must_acknowledge': 'str', 'signer_must_acknowledge_metadata': 'PropertyMetadata', 'size_bytes': 'str', 'template_locked': 'str', 'template_required': 'str', 'type': 'str', 'uri': 'str'}
attribute_map = {'added_recipient_ids': 'addedRecipientIds', 'attachment_tab_id': 'attachmentTabId', 'authoritative_copy': 'authoritativeCopy', 'authoritative_copy_metadata': 'authoritativeCopyMetadata', 'available_document_types': 'availableDocumentTypes', 'contains_pdf_form_fields': 'containsPdfFormFields', 'display': 'display', 'display_metadata': 'displayMetadata', 'doc_gen_document_status': 'docGenDocumentStatus', 'doc_gen_errors': 'docGenErrors', 'doc_gen_form_fields': 'docGenFormFields', 'document_base64': 'documentBase64', 'document_fields': 'documentFields', 'document_id': 'documentId', 'document_id_guid': 'documentIdGuid', 'error_details': 'errorDetails', 'include_in_download': 'includeInDownload', 'include_in_download_metadata': 'includeInDownloadMetadata', 'is_doc_gen_document': 'isDocGenDocument', 'name': 'name', 'name_metadata': 'nameMetadata', 'order': 'order', 'pages': 'pages', 'signer_must_acknowledge': 'signerMustAcknowledge', 'signer_must_acknowledge_metadata': 'signerMustAcknowledgeMetadata', 'size_bytes': 'sizeBytes', 'template_locked': 'templateLocked', 'template_required': 'templateRequired', 'type': 'type', 'uri': 'uri'}
added_recipient_ids
Gets the added_recipient_ids of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The added_recipient_ids of this EnvelopeDocument. # noqa: E501
attachment_tab_id
Gets the attachment_tab_id of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The attachment_tab_id of this EnvelopeDocument. # noqa: E501
available_document_types
Gets the available_document_types of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The available_document_types of this EnvelopeDocument. # noqa: E501
contains_pdf_form_fields
Gets the contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The contains_pdf_form_fields of this EnvelopeDocument. # noqa: E501
display
Gets the display of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The display of this EnvelopeDocument. # noqa: E501
display_metadata
Gets the display_metadata of this EnvelopeDocument. # noqa: E501
Metadata that indicates if the sender can edit the display property. Not applicable for template documents. # noqa: E501
Returns
The display_metadata of this EnvelopeDocument. # noqa: E501
doc_gen_document_status
Gets the doc_gen_document_status of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The doc_gen_document_status of this EnvelopeDocument. # noqa: E501
doc_gen_errors
Gets the doc_gen_errors of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The doc_gen_errors of this EnvelopeDocument. # noqa: E501
doc_gen_form_fields
Gets the doc_gen_form_fields of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The doc_gen_form_fields of this EnvelopeDocument. # noqa: E501
document_base64
Gets the document_base64 of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The document_base64 of this EnvelopeDocument. # noqa: E501
document_fields
Gets the document_fields of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The document_fields of this EnvelopeDocument. # noqa: E501
document_id
Gets the document_id of this EnvelopeDocument. # noqa: E501
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
Returns
The document_id of this EnvelopeDocument. # noqa: E501
document_id_guid
Gets the document_id_guid of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The document_id_guid of this EnvelopeDocument. # noqa: E501
error_details
Gets the error_details of this EnvelopeDocument. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this EnvelopeDocument. # noqa: E501
include_in_download
Gets the include_in_download of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The include_in_download of this EnvelopeDocument. # noqa: E501
include_in_download_metadata
Gets the include_in_download_metadata of this EnvelopeDocument. # noqa: E501
Metadata that indicates if the sender can edit the includeInDownload property. Not applicable for template documents. # noqa: E501
Returns
The include_in_download_metadata of this EnvelopeDocument. # noqa: E501
is_doc_gen_document
Gets the is_doc_gen_document of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The is_doc_gen_document of this EnvelopeDocument. # noqa: E501
name
Gets the name of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The name of this EnvelopeDocument. # noqa: E501
name_metadata
Gets the name_metadata of this EnvelopeDocument. # noqa: E501
Metadata that indicates if the sender can edit the name property. Not applicable for template documents. # noqa: E501
Returns
The name_metadata of this EnvelopeDocument. # noqa: E501
order
Gets the order of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The order of this EnvelopeDocument. # noqa: E501
pages
Gets the pages of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The pages of this EnvelopeDocument. # noqa: E501
signer_must_acknowledge
Gets the signer_must_acknowledge of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The signer_must_acknowledge of this EnvelopeDocument. # noqa: E501
signer_must_acknowledge_metadata
Gets the signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501
Metadata that indicates if the sender can edit the signerMustAcknowledge property. Not applicable for template documents. # noqa: E501
Returns
The signer_must_acknowledge_metadata of this EnvelopeDocument. # noqa: E501
size_bytes
Gets the size_bytes of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The size_bytes of this EnvelopeDocument. # noqa: E501
template_locked
Gets the template_locked of this EnvelopeDocument. # noqa: E501
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_locked of this EnvelopeDocument. # noqa: E501
template_required
Gets the template_required of this EnvelopeDocument. # noqa: E501
When set to true, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_required of this EnvelopeDocument. # noqa: E501
type
Gets the type of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The type of this EnvelopeDocument. # noqa: E501
uri
Gets the uri of this EnvelopeDocument. # noqa: E501
# noqa: E501
Returns
The uri of this EnvelopeDocument. # noqa: E501
def
to_dict(self)
861 def to_dict(self): 862 """Returns the model properties as a dict""" 863 result = {} 864 865 for attr, _ in six.iteritems(self.swagger_types): 866 value = getattr(self, attr) 867 if isinstance(value, list): 868 result[attr] = list(map( 869 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 870 value 871 )) 872 elif hasattr(value, "to_dict"): 873 result[attr] = value.to_dict() 874 elif isinstance(value, dict): 875 result[attr] = dict(map( 876 lambda item: (item[0], item[1].to_dict()) 877 if hasattr(item[1], "to_dict") else item, 878 value.items() 879 )) 880 else: 881 result[attr] = value 882 if issubclass(EnvelopeDocument, dict): 883 for key, value in self.items(): 884 result[key] = value 885 886 return result
Returns the model properties as a dict