docusign_esign.models.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 Document(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 'apply_anchor_tabs': 'str', 37 'assign_tabs_to_recipient_id': 'str', 38 'display': 'str', 39 'doc_gen_form_fields': 'list[DocGenFormField]', 40 'document_base64': 'str', 41 'document_fields': 'list[NameValue]', 42 'document_id': 'str', 43 'encrypted_with_key_manager': 'str', 44 'file_extension': 'str', 45 'file_format_hint': 'str', 46 'html_definition': 'DocumentHtmlDefinition', 47 'include_in_download': 'str', 48 'is_doc_gen_document': 'str', 49 'match_boxes': 'list[MatchBox]', 50 'name': 'str', 51 'order': 'str', 52 'pages': 'str', 53 'password': 'str', 54 'pdf_form_field_option': 'str', 55 'remote_url': 'str', 56 'signer_must_acknowledge': 'str', 57 'signer_must_acknowledge_use_account_default': 'bool', 58 'tabs': 'Tabs', 59 'template_locked': 'str', 60 'template_required': 'str', 61 'transform_pdf_fields': 'str', 62 'uri': 'str' 63 } 64 65 attribute_map = { 66 'apply_anchor_tabs': 'applyAnchorTabs', 67 'assign_tabs_to_recipient_id': 'assignTabsToRecipientId', 68 'display': 'display', 69 'doc_gen_form_fields': 'docGenFormFields', 70 'document_base64': 'documentBase64', 71 'document_fields': 'documentFields', 72 'document_id': 'documentId', 73 'encrypted_with_key_manager': 'encryptedWithKeyManager', 74 'file_extension': 'fileExtension', 75 'file_format_hint': 'fileFormatHint', 76 'html_definition': 'htmlDefinition', 77 'include_in_download': 'includeInDownload', 78 'is_doc_gen_document': 'isDocGenDocument', 79 'match_boxes': 'matchBoxes', 80 'name': 'name', 81 'order': 'order', 82 'pages': 'pages', 83 'password': 'password', 84 'pdf_form_field_option': 'pdfFormFieldOption', 85 'remote_url': 'remoteUrl', 86 'signer_must_acknowledge': 'signerMustAcknowledge', 87 'signer_must_acknowledge_use_account_default': 'signerMustAcknowledgeUseAccountDefault', 88 'tabs': 'tabs', 89 'template_locked': 'templateLocked', 90 'template_required': 'templateRequired', 91 'transform_pdf_fields': 'transformPdfFields', 92 'uri': 'uri' 93 } 94 95 def __init__(self, _configuration=None, **kwargs): # noqa: E501 96 """Document - a model defined in Swagger""" # noqa: E501 97 if _configuration is None: 98 _configuration = Configuration() 99 self._configuration = _configuration 100 101 self._apply_anchor_tabs = None 102 self._assign_tabs_to_recipient_id = None 103 self._display = None 104 self._doc_gen_form_fields = None 105 self._document_base64 = None 106 self._document_fields = None 107 self._document_id = None 108 self._encrypted_with_key_manager = None 109 self._file_extension = None 110 self._file_format_hint = None 111 self._html_definition = None 112 self._include_in_download = None 113 self._is_doc_gen_document = None 114 self._match_boxes = None 115 self._name = None 116 self._order = None 117 self._pages = None 118 self._password = None 119 self._pdf_form_field_option = None 120 self._remote_url = None 121 self._signer_must_acknowledge = None 122 self._signer_must_acknowledge_use_account_default = None 123 self._tabs = None 124 self._template_locked = None 125 self._template_required = None 126 self._transform_pdf_fields = None 127 self._uri = None 128 self.discriminator = None 129 130 setattr(self, "_{}".format('apply_anchor_tabs'), kwargs.get('apply_anchor_tabs', None)) 131 setattr(self, "_{}".format('assign_tabs_to_recipient_id'), kwargs.get('assign_tabs_to_recipient_id', None)) 132 setattr(self, "_{}".format('display'), kwargs.get('display', None)) 133 setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) 134 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 135 setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None)) 136 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 137 setattr(self, "_{}".format('encrypted_with_key_manager'), kwargs.get('encrypted_with_key_manager', None)) 138 setattr(self, "_{}".format('file_extension'), kwargs.get('file_extension', None)) 139 setattr(self, "_{}".format('file_format_hint'), kwargs.get('file_format_hint', None)) 140 setattr(self, "_{}".format('html_definition'), kwargs.get('html_definition', None)) 141 setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None)) 142 setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None)) 143 setattr(self, "_{}".format('match_boxes'), kwargs.get('match_boxes', None)) 144 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 145 setattr(self, "_{}".format('order'), kwargs.get('order', None)) 146 setattr(self, "_{}".format('pages'), kwargs.get('pages', None)) 147 setattr(self, "_{}".format('password'), kwargs.get('password', None)) 148 setattr(self, "_{}".format('pdf_form_field_option'), kwargs.get('pdf_form_field_option', None)) 149 setattr(self, "_{}".format('remote_url'), kwargs.get('remote_url', None)) 150 setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None)) 151 setattr(self, "_{}".format('signer_must_acknowledge_use_account_default'), kwargs.get('signer_must_acknowledge_use_account_default', None)) 152 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 153 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 154 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 155 setattr(self, "_{}".format('transform_pdf_fields'), kwargs.get('transform_pdf_fields', None)) 156 setattr(self, "_{}".format('uri'), kwargs.get('uri', None)) 157 158 @property 159 def apply_anchor_tabs(self): 160 """Gets the apply_anchor_tabs of this Document. # noqa: E501 161 162 Reserved: TBD # noqa: E501 163 164 :return: The apply_anchor_tabs of this Document. # noqa: E501 165 :rtype: str 166 """ 167 return self._apply_anchor_tabs 168 169 @apply_anchor_tabs.setter 170 def apply_anchor_tabs(self, apply_anchor_tabs): 171 """Sets the apply_anchor_tabs of this Document. 172 173 Reserved: TBD # noqa: E501 174 175 :param apply_anchor_tabs: The apply_anchor_tabs of this Document. # noqa: E501 176 :type: str 177 """ 178 179 self._apply_anchor_tabs = apply_anchor_tabs 180 181 @property 182 def assign_tabs_to_recipient_id(self): 183 """Gets the assign_tabs_to_recipient_id of this Document. # noqa: E501 184 185 # noqa: E501 186 187 :return: The assign_tabs_to_recipient_id of this Document. # noqa: E501 188 :rtype: str 189 """ 190 return self._assign_tabs_to_recipient_id 191 192 @assign_tabs_to_recipient_id.setter 193 def assign_tabs_to_recipient_id(self, assign_tabs_to_recipient_id): 194 """Sets the assign_tabs_to_recipient_id of this Document. 195 196 # noqa: E501 197 198 :param assign_tabs_to_recipient_id: The assign_tabs_to_recipient_id of this Document. # noqa: E501 199 :type: str 200 """ 201 202 self._assign_tabs_to_recipient_id = assign_tabs_to_recipient_id 203 204 @property 205 def display(self): 206 """Gets the display of this Document. # noqa: E501 207 208 # noqa: E501 209 210 :return: The display of this Document. # noqa: E501 211 :rtype: str 212 """ 213 return self._display 214 215 @display.setter 216 def display(self, display): 217 """Sets the display of this Document. 218 219 # noqa: E501 220 221 :param display: The display of this Document. # noqa: E501 222 :type: str 223 """ 224 225 self._display = display 226 227 @property 228 def doc_gen_form_fields(self): 229 """Gets the doc_gen_form_fields of this Document. # noqa: E501 230 231 # noqa: E501 232 233 :return: The doc_gen_form_fields of this Document. # noqa: E501 234 :rtype: list[DocGenFormField] 235 """ 236 return self._doc_gen_form_fields 237 238 @doc_gen_form_fields.setter 239 def doc_gen_form_fields(self, doc_gen_form_fields): 240 """Sets the doc_gen_form_fields of this Document. 241 242 # noqa: E501 243 244 :param doc_gen_form_fields: The doc_gen_form_fields of this Document. # noqa: E501 245 :type: list[DocGenFormField] 246 """ 247 248 self._doc_gen_form_fields = doc_gen_form_fields 249 250 @property 251 def document_base64(self): 252 """Gets the document_base64 of this Document. # noqa: E501 253 254 The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. # noqa: E501 255 256 :return: The document_base64 of this Document. # noqa: E501 257 :rtype: str 258 """ 259 return self._document_base64 260 261 @document_base64.setter 262 def document_base64(self, document_base64): 263 """Sets the document_base64 of this Document. 264 265 The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. # noqa: E501 266 267 :param document_base64: The document_base64 of this Document. # noqa: E501 268 :type: str 269 """ 270 271 self._document_base64 = document_base64 272 273 @property 274 def document_fields(self): 275 """Gets the document_fields of this Document. # noqa: E501 276 277 # noqa: E501 278 279 :return: The document_fields of this Document. # noqa: E501 280 :rtype: list[NameValue] 281 """ 282 return self._document_fields 283 284 @document_fields.setter 285 def document_fields(self, document_fields): 286 """Sets the document_fields of this Document. 287 288 # noqa: E501 289 290 :param document_fields: The document_fields of this Document. # noqa: E501 291 :type: list[NameValue] 292 """ 293 294 self._document_fields = document_fields 295 296 @property 297 def document_id(self): 298 """Gets the document_id of this Document. # noqa: E501 299 300 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 301 302 :return: The document_id of this Document. # noqa: E501 303 :rtype: str 304 """ 305 return self._document_id 306 307 @document_id.setter 308 def document_id(self, document_id): 309 """Sets the document_id of this Document. 310 311 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 312 313 :param document_id: The document_id of this Document. # noqa: E501 314 :type: str 315 """ 316 317 self._document_id = document_id 318 319 @property 320 def encrypted_with_key_manager(self): 321 """Gets the encrypted_with_key_manager of this Document. # noqa: E501 322 323 When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. # noqa: E501 324 325 :return: The encrypted_with_key_manager of this Document. # noqa: E501 326 :rtype: str 327 """ 328 return self._encrypted_with_key_manager 329 330 @encrypted_with_key_manager.setter 331 def encrypted_with_key_manager(self, encrypted_with_key_manager): 332 """Sets the encrypted_with_key_manager of this Document. 333 334 When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. # noqa: E501 335 336 :param encrypted_with_key_manager: The encrypted_with_key_manager of this Document. # noqa: E501 337 :type: str 338 """ 339 340 self._encrypted_with_key_manager = encrypted_with_key_manager 341 342 @property 343 def file_extension(self): 344 """Gets the file_extension of this Document. # noqa: E501 345 346 The file extension type of the document. If the document is not a PDF it is converted to a PDF. # noqa: E501 347 348 :return: The file_extension of this Document. # noqa: E501 349 :rtype: str 350 """ 351 return self._file_extension 352 353 @file_extension.setter 354 def file_extension(self, file_extension): 355 """Sets the file_extension of this Document. 356 357 The file extension type of the document. If the document is not a PDF it is converted to a PDF. # noqa: E501 358 359 :param file_extension: The file_extension of this Document. # noqa: E501 360 :type: str 361 """ 362 363 self._file_extension = file_extension 364 365 @property 366 def file_format_hint(self): 367 """Gets the file_format_hint of this Document. # noqa: E501 368 369 # noqa: E501 370 371 :return: The file_format_hint of this Document. # noqa: E501 372 :rtype: str 373 """ 374 return self._file_format_hint 375 376 @file_format_hint.setter 377 def file_format_hint(self, file_format_hint): 378 """Sets the file_format_hint of this Document. 379 380 # noqa: E501 381 382 :param file_format_hint: The file_format_hint of this Document. # noqa: E501 383 :type: str 384 """ 385 386 self._file_format_hint = file_format_hint 387 388 @property 389 def html_definition(self): 390 """Gets the html_definition of this Document. # noqa: E501 391 392 Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). # noqa: E501 393 394 :return: The html_definition of this Document. # noqa: E501 395 :rtype: DocumentHtmlDefinition 396 """ 397 return self._html_definition 398 399 @html_definition.setter 400 def html_definition(self, html_definition): 401 """Sets the html_definition of this Document. 402 403 Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). # noqa: E501 404 405 :param html_definition: The html_definition of this Document. # noqa: E501 406 :type: DocumentHtmlDefinition 407 """ 408 409 self._html_definition = html_definition 410 411 @property 412 def include_in_download(self): 413 """Gets the include_in_download of this Document. # noqa: E501 414 415 # noqa: E501 416 417 :return: The include_in_download of this Document. # noqa: E501 418 :rtype: str 419 """ 420 return self._include_in_download 421 422 @include_in_download.setter 423 def include_in_download(self, include_in_download): 424 """Sets the include_in_download of this Document. 425 426 # noqa: E501 427 428 :param include_in_download: The include_in_download of this Document. # noqa: E501 429 :type: str 430 """ 431 432 self._include_in_download = include_in_download 433 434 @property 435 def is_doc_gen_document(self): 436 """Gets the is_doc_gen_document of this Document. # noqa: E501 437 438 # noqa: E501 439 440 :return: The is_doc_gen_document of this Document. # noqa: E501 441 :rtype: str 442 """ 443 return self._is_doc_gen_document 444 445 @is_doc_gen_document.setter 446 def is_doc_gen_document(self, is_doc_gen_document): 447 """Sets the is_doc_gen_document of this Document. 448 449 # noqa: E501 450 451 :param is_doc_gen_document: The is_doc_gen_document of this Document. # noqa: E501 452 :type: str 453 """ 454 455 self._is_doc_gen_document = is_doc_gen_document 456 457 @property 458 def match_boxes(self): 459 """Gets the match_boxes of this Document. # noqa: E501 460 461 Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. # noqa: E501 462 463 :return: The match_boxes of this Document. # noqa: E501 464 :rtype: list[MatchBox] 465 """ 466 return self._match_boxes 467 468 @match_boxes.setter 469 def match_boxes(self, match_boxes): 470 """Sets the match_boxes of this Document. 471 472 Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. # noqa: E501 473 474 :param match_boxes: The match_boxes of this Document. # noqa: E501 475 :type: list[MatchBox] 476 """ 477 478 self._match_boxes = match_boxes 479 480 @property 481 def name(self): 482 """Gets the name of this Document. # noqa: E501 483 484 # noqa: E501 485 486 :return: The name of this Document. # noqa: E501 487 :rtype: str 488 """ 489 return self._name 490 491 @name.setter 492 def name(self, name): 493 """Sets the name of this Document. 494 495 # noqa: E501 496 497 :param name: The name of this Document. # noqa: E501 498 :type: str 499 """ 500 501 self._name = name 502 503 @property 504 def order(self): 505 """Gets the order of this Document. # noqa: E501 506 507 # noqa: E501 508 509 :return: The order of this Document. # noqa: E501 510 :rtype: str 511 """ 512 return self._order 513 514 @order.setter 515 def order(self, order): 516 """Sets the order of this Document. 517 518 # noqa: E501 519 520 :param order: The order of this Document. # noqa: E501 521 :type: str 522 """ 523 524 self._order = order 525 526 @property 527 def pages(self): 528 """Gets the pages of this Document. # noqa: E501 529 530 # noqa: E501 531 532 :return: The pages of this Document. # noqa: E501 533 :rtype: str 534 """ 535 return self._pages 536 537 @pages.setter 538 def pages(self, pages): 539 """Sets the pages of this Document. 540 541 # noqa: E501 542 543 :param pages: The pages of this Document. # noqa: E501 544 :type: str 545 """ 546 547 self._pages = pages 548 549 @property 550 def password(self): 551 """Gets the password of this Document. # noqa: E501 552 553 # noqa: E501 554 555 :return: The password of this Document. # noqa: E501 556 :rtype: str 557 """ 558 return self._password 559 560 @password.setter 561 def password(self, password): 562 """Sets the password of this Document. 563 564 # noqa: E501 565 566 :param password: The password of this Document. # noqa: E501 567 :type: str 568 """ 569 570 self._password = password 571 572 @property 573 def pdf_form_field_option(self): 574 """Gets the pdf_form_field_option of this Document. # noqa: E501 575 576 # noqa: E501 577 578 :return: The pdf_form_field_option of this Document. # noqa: E501 579 :rtype: str 580 """ 581 return self._pdf_form_field_option 582 583 @pdf_form_field_option.setter 584 def pdf_form_field_option(self, pdf_form_field_option): 585 """Sets the pdf_form_field_option of this Document. 586 587 # noqa: E501 588 589 :param pdf_form_field_option: The pdf_form_field_option of this Document. # noqa: E501 590 :type: str 591 """ 592 593 self._pdf_form_field_option = pdf_form_field_option 594 595 @property 596 def remote_url(self): 597 """Gets the remote_url of this Document. # noqa: E501 598 599 The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. # noqa: E501 600 601 :return: The remote_url of this Document. # noqa: E501 602 :rtype: str 603 """ 604 return self._remote_url 605 606 @remote_url.setter 607 def remote_url(self, remote_url): 608 """Sets the remote_url of this Document. 609 610 The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. # noqa: E501 611 612 :param remote_url: The remote_url of this Document. # noqa: E501 613 :type: str 614 """ 615 616 self._remote_url = remote_url 617 618 @property 619 def signer_must_acknowledge(self): 620 """Gets the signer_must_acknowledge of this Document. # noqa: E501 621 622 # noqa: E501 623 624 :return: The signer_must_acknowledge of this Document. # noqa: E501 625 :rtype: str 626 """ 627 return self._signer_must_acknowledge 628 629 @signer_must_acknowledge.setter 630 def signer_must_acknowledge(self, signer_must_acknowledge): 631 """Sets the signer_must_acknowledge of this Document. 632 633 # noqa: E501 634 635 :param signer_must_acknowledge: The signer_must_acknowledge of this Document. # noqa: E501 636 :type: str 637 """ 638 639 self._signer_must_acknowledge = signer_must_acknowledge 640 641 @property 642 def signer_must_acknowledge_use_account_default(self): 643 """Gets the signer_must_acknowledge_use_account_default of this Document. # noqa: E501 644 645 # noqa: E501 646 647 :return: The signer_must_acknowledge_use_account_default of this Document. # noqa: E501 648 :rtype: bool 649 """ 650 return self._signer_must_acknowledge_use_account_default 651 652 @signer_must_acknowledge_use_account_default.setter 653 def signer_must_acknowledge_use_account_default(self, signer_must_acknowledge_use_account_default): 654 """Sets the signer_must_acknowledge_use_account_default of this Document. 655 656 # noqa: E501 657 658 :param signer_must_acknowledge_use_account_default: The signer_must_acknowledge_use_account_default of this Document. # noqa: E501 659 :type: bool 660 """ 661 662 self._signer_must_acknowledge_use_account_default = signer_must_acknowledge_use_account_default 663 664 @property 665 def tabs(self): 666 """Gets the tabs of this Document. # noqa: E501 667 668 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 669 670 :return: The tabs of this Document. # noqa: E501 671 :rtype: Tabs 672 """ 673 return self._tabs 674 675 @tabs.setter 676 def tabs(self, tabs): 677 """Sets the tabs of this Document. 678 679 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 680 681 :param tabs: The tabs of this Document. # noqa: E501 682 :type: Tabs 683 """ 684 685 self._tabs = tabs 686 687 @property 688 def template_locked(self): 689 """Gets the template_locked of this Document. # noqa: E501 690 691 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 692 693 :return: The template_locked of this Document. # noqa: E501 694 :rtype: str 695 """ 696 return self._template_locked 697 698 @template_locked.setter 699 def template_locked(self, template_locked): 700 """Sets the template_locked of this Document. 701 702 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 703 704 :param template_locked: The template_locked of this Document. # noqa: E501 705 :type: str 706 """ 707 708 self._template_locked = template_locked 709 710 @property 711 def template_required(self): 712 """Gets the template_required of this Document. # noqa: E501 713 714 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 715 716 :return: The template_required of this Document. # noqa: E501 717 :rtype: str 718 """ 719 return self._template_required 720 721 @template_required.setter 722 def template_required(self, template_required): 723 """Sets the template_required of this Document. 724 725 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 726 727 :param template_required: The template_required of this Document. # noqa: E501 728 :type: str 729 """ 730 731 self._template_required = template_required 732 733 @property 734 def transform_pdf_fields(self): 735 """Gets the transform_pdf_fields of this Document. # noqa: E501 736 737 When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. # noqa: E501 738 739 :return: The transform_pdf_fields of this Document. # noqa: E501 740 :rtype: str 741 """ 742 return self._transform_pdf_fields 743 744 @transform_pdf_fields.setter 745 def transform_pdf_fields(self, transform_pdf_fields): 746 """Sets the transform_pdf_fields of this Document. 747 748 When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. # noqa: E501 749 750 :param transform_pdf_fields: The transform_pdf_fields of this Document. # noqa: E501 751 :type: str 752 """ 753 754 self._transform_pdf_fields = transform_pdf_fields 755 756 @property 757 def uri(self): 758 """Gets the uri of this Document. # noqa: E501 759 760 # noqa: E501 761 762 :return: The uri of this Document. # noqa: E501 763 :rtype: str 764 """ 765 return self._uri 766 767 @uri.setter 768 def uri(self, uri): 769 """Sets the uri of this Document. 770 771 # noqa: E501 772 773 :param uri: The uri of this Document. # noqa: E501 774 :type: str 775 """ 776 777 self._uri = uri 778 779 def to_dict(self): 780 """Returns the model properties as a dict""" 781 result = {} 782 783 for attr, _ in six.iteritems(self.swagger_types): 784 value = getattr(self, attr) 785 if isinstance(value, list): 786 result[attr] = list(map( 787 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 788 value 789 )) 790 elif hasattr(value, "to_dict"): 791 result[attr] = value.to_dict() 792 elif isinstance(value, dict): 793 result[attr] = dict(map( 794 lambda item: (item[0], item[1].to_dict()) 795 if hasattr(item[1], "to_dict") else item, 796 value.items() 797 )) 798 else: 799 result[attr] = value 800 if issubclass(Document, dict): 801 for key, value in self.items(): 802 result[key] = value 803 804 return result 805 806 def to_str(self): 807 """Returns the string representation of the model""" 808 return pprint.pformat(self.to_dict()) 809 810 def __repr__(self): 811 """For `print` and `pprint`""" 812 return self.to_str() 813 814 def __eq__(self, other): 815 """Returns true if both objects are equal""" 816 if not isinstance(other, Document): 817 return False 818 819 return self.to_dict() == other.to_dict() 820 821 def __ne__(self, other): 822 """Returns true if both objects are not equal""" 823 if not isinstance(other, Document): 824 return True 825 826 return self.to_dict() != other.to_dict()
class
Document:
23class Document(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 'apply_anchor_tabs': 'str', 38 'assign_tabs_to_recipient_id': 'str', 39 'display': 'str', 40 'doc_gen_form_fields': 'list[DocGenFormField]', 41 'document_base64': 'str', 42 'document_fields': 'list[NameValue]', 43 'document_id': 'str', 44 'encrypted_with_key_manager': 'str', 45 'file_extension': 'str', 46 'file_format_hint': 'str', 47 'html_definition': 'DocumentHtmlDefinition', 48 'include_in_download': 'str', 49 'is_doc_gen_document': 'str', 50 'match_boxes': 'list[MatchBox]', 51 'name': 'str', 52 'order': 'str', 53 'pages': 'str', 54 'password': 'str', 55 'pdf_form_field_option': 'str', 56 'remote_url': 'str', 57 'signer_must_acknowledge': 'str', 58 'signer_must_acknowledge_use_account_default': 'bool', 59 'tabs': 'Tabs', 60 'template_locked': 'str', 61 'template_required': 'str', 62 'transform_pdf_fields': 'str', 63 'uri': 'str' 64 } 65 66 attribute_map = { 67 'apply_anchor_tabs': 'applyAnchorTabs', 68 'assign_tabs_to_recipient_id': 'assignTabsToRecipientId', 69 'display': 'display', 70 'doc_gen_form_fields': 'docGenFormFields', 71 'document_base64': 'documentBase64', 72 'document_fields': 'documentFields', 73 'document_id': 'documentId', 74 'encrypted_with_key_manager': 'encryptedWithKeyManager', 75 'file_extension': 'fileExtension', 76 'file_format_hint': 'fileFormatHint', 77 'html_definition': 'htmlDefinition', 78 'include_in_download': 'includeInDownload', 79 'is_doc_gen_document': 'isDocGenDocument', 80 'match_boxes': 'matchBoxes', 81 'name': 'name', 82 'order': 'order', 83 'pages': 'pages', 84 'password': 'password', 85 'pdf_form_field_option': 'pdfFormFieldOption', 86 'remote_url': 'remoteUrl', 87 'signer_must_acknowledge': 'signerMustAcknowledge', 88 'signer_must_acknowledge_use_account_default': 'signerMustAcknowledgeUseAccountDefault', 89 'tabs': 'tabs', 90 'template_locked': 'templateLocked', 91 'template_required': 'templateRequired', 92 'transform_pdf_fields': 'transformPdfFields', 93 'uri': 'uri' 94 } 95 96 def __init__(self, _configuration=None, **kwargs): # noqa: E501 97 """Document - a model defined in Swagger""" # noqa: E501 98 if _configuration is None: 99 _configuration = Configuration() 100 self._configuration = _configuration 101 102 self._apply_anchor_tabs = None 103 self._assign_tabs_to_recipient_id = None 104 self._display = None 105 self._doc_gen_form_fields = None 106 self._document_base64 = None 107 self._document_fields = None 108 self._document_id = None 109 self._encrypted_with_key_manager = None 110 self._file_extension = None 111 self._file_format_hint = None 112 self._html_definition = None 113 self._include_in_download = None 114 self._is_doc_gen_document = None 115 self._match_boxes = None 116 self._name = None 117 self._order = None 118 self._pages = None 119 self._password = None 120 self._pdf_form_field_option = None 121 self._remote_url = None 122 self._signer_must_acknowledge = None 123 self._signer_must_acknowledge_use_account_default = None 124 self._tabs = None 125 self._template_locked = None 126 self._template_required = None 127 self._transform_pdf_fields = None 128 self._uri = None 129 self.discriminator = None 130 131 setattr(self, "_{}".format('apply_anchor_tabs'), kwargs.get('apply_anchor_tabs', None)) 132 setattr(self, "_{}".format('assign_tabs_to_recipient_id'), kwargs.get('assign_tabs_to_recipient_id', None)) 133 setattr(self, "_{}".format('display'), kwargs.get('display', None)) 134 setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) 135 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 136 setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None)) 137 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 138 setattr(self, "_{}".format('encrypted_with_key_manager'), kwargs.get('encrypted_with_key_manager', None)) 139 setattr(self, "_{}".format('file_extension'), kwargs.get('file_extension', None)) 140 setattr(self, "_{}".format('file_format_hint'), kwargs.get('file_format_hint', None)) 141 setattr(self, "_{}".format('html_definition'), kwargs.get('html_definition', None)) 142 setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None)) 143 setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None)) 144 setattr(self, "_{}".format('match_boxes'), kwargs.get('match_boxes', None)) 145 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 146 setattr(self, "_{}".format('order'), kwargs.get('order', None)) 147 setattr(self, "_{}".format('pages'), kwargs.get('pages', None)) 148 setattr(self, "_{}".format('password'), kwargs.get('password', None)) 149 setattr(self, "_{}".format('pdf_form_field_option'), kwargs.get('pdf_form_field_option', None)) 150 setattr(self, "_{}".format('remote_url'), kwargs.get('remote_url', None)) 151 setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None)) 152 setattr(self, "_{}".format('signer_must_acknowledge_use_account_default'), kwargs.get('signer_must_acknowledge_use_account_default', None)) 153 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 154 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 155 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 156 setattr(self, "_{}".format('transform_pdf_fields'), kwargs.get('transform_pdf_fields', None)) 157 setattr(self, "_{}".format('uri'), kwargs.get('uri', None)) 158 159 @property 160 def apply_anchor_tabs(self): 161 """Gets the apply_anchor_tabs of this Document. # noqa: E501 162 163 Reserved: TBD # noqa: E501 164 165 :return: The apply_anchor_tabs of this Document. # noqa: E501 166 :rtype: str 167 """ 168 return self._apply_anchor_tabs 169 170 @apply_anchor_tabs.setter 171 def apply_anchor_tabs(self, apply_anchor_tabs): 172 """Sets the apply_anchor_tabs of this Document. 173 174 Reserved: TBD # noqa: E501 175 176 :param apply_anchor_tabs: The apply_anchor_tabs of this Document. # noqa: E501 177 :type: str 178 """ 179 180 self._apply_anchor_tabs = apply_anchor_tabs 181 182 @property 183 def assign_tabs_to_recipient_id(self): 184 """Gets the assign_tabs_to_recipient_id of this Document. # noqa: E501 185 186 # noqa: E501 187 188 :return: The assign_tabs_to_recipient_id of this Document. # noqa: E501 189 :rtype: str 190 """ 191 return self._assign_tabs_to_recipient_id 192 193 @assign_tabs_to_recipient_id.setter 194 def assign_tabs_to_recipient_id(self, assign_tabs_to_recipient_id): 195 """Sets the assign_tabs_to_recipient_id of this Document. 196 197 # noqa: E501 198 199 :param assign_tabs_to_recipient_id: The assign_tabs_to_recipient_id of this Document. # noqa: E501 200 :type: str 201 """ 202 203 self._assign_tabs_to_recipient_id = assign_tabs_to_recipient_id 204 205 @property 206 def display(self): 207 """Gets the display of this Document. # noqa: E501 208 209 # noqa: E501 210 211 :return: The display of this Document. # noqa: E501 212 :rtype: str 213 """ 214 return self._display 215 216 @display.setter 217 def display(self, display): 218 """Sets the display of this Document. 219 220 # noqa: E501 221 222 :param display: The display of this Document. # noqa: E501 223 :type: str 224 """ 225 226 self._display = display 227 228 @property 229 def doc_gen_form_fields(self): 230 """Gets the doc_gen_form_fields of this Document. # noqa: E501 231 232 # noqa: E501 233 234 :return: The doc_gen_form_fields of this Document. # noqa: E501 235 :rtype: list[DocGenFormField] 236 """ 237 return self._doc_gen_form_fields 238 239 @doc_gen_form_fields.setter 240 def doc_gen_form_fields(self, doc_gen_form_fields): 241 """Sets the doc_gen_form_fields of this Document. 242 243 # noqa: E501 244 245 :param doc_gen_form_fields: The doc_gen_form_fields of this Document. # noqa: E501 246 :type: list[DocGenFormField] 247 """ 248 249 self._doc_gen_form_fields = doc_gen_form_fields 250 251 @property 252 def document_base64(self): 253 """Gets the document_base64 of this Document. # noqa: E501 254 255 The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. # noqa: E501 256 257 :return: The document_base64 of this Document. # noqa: E501 258 :rtype: str 259 """ 260 return self._document_base64 261 262 @document_base64.setter 263 def document_base64(self, document_base64): 264 """Sets the document_base64 of this Document. 265 266 The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. # noqa: E501 267 268 :param document_base64: The document_base64 of this Document. # noqa: E501 269 :type: str 270 """ 271 272 self._document_base64 = document_base64 273 274 @property 275 def document_fields(self): 276 """Gets the document_fields of this Document. # noqa: E501 277 278 # noqa: E501 279 280 :return: The document_fields of this Document. # noqa: E501 281 :rtype: list[NameValue] 282 """ 283 return self._document_fields 284 285 @document_fields.setter 286 def document_fields(self, document_fields): 287 """Sets the document_fields of this Document. 288 289 # noqa: E501 290 291 :param document_fields: The document_fields of this Document. # noqa: E501 292 :type: list[NameValue] 293 """ 294 295 self._document_fields = document_fields 296 297 @property 298 def document_id(self): 299 """Gets the document_id of this Document. # noqa: E501 300 301 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 302 303 :return: The document_id of this Document. # noqa: E501 304 :rtype: str 305 """ 306 return self._document_id 307 308 @document_id.setter 309 def document_id(self, document_id): 310 """Sets the document_id of this Document. 311 312 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 313 314 :param document_id: The document_id of this Document. # noqa: E501 315 :type: str 316 """ 317 318 self._document_id = document_id 319 320 @property 321 def encrypted_with_key_manager(self): 322 """Gets the encrypted_with_key_manager of this Document. # noqa: E501 323 324 When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. # noqa: E501 325 326 :return: The encrypted_with_key_manager of this Document. # noqa: E501 327 :rtype: str 328 """ 329 return self._encrypted_with_key_manager 330 331 @encrypted_with_key_manager.setter 332 def encrypted_with_key_manager(self, encrypted_with_key_manager): 333 """Sets the encrypted_with_key_manager of this Document. 334 335 When set to **true**, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. # noqa: E501 336 337 :param encrypted_with_key_manager: The encrypted_with_key_manager of this Document. # noqa: E501 338 :type: str 339 """ 340 341 self._encrypted_with_key_manager = encrypted_with_key_manager 342 343 @property 344 def file_extension(self): 345 """Gets the file_extension of this Document. # noqa: E501 346 347 The file extension type of the document. If the document is not a PDF it is converted to a PDF. # noqa: E501 348 349 :return: The file_extension of this Document. # noqa: E501 350 :rtype: str 351 """ 352 return self._file_extension 353 354 @file_extension.setter 355 def file_extension(self, file_extension): 356 """Sets the file_extension of this Document. 357 358 The file extension type of the document. If the document is not a PDF it is converted to a PDF. # noqa: E501 359 360 :param file_extension: The file_extension of this Document. # noqa: E501 361 :type: str 362 """ 363 364 self._file_extension = file_extension 365 366 @property 367 def file_format_hint(self): 368 """Gets the file_format_hint of this Document. # noqa: E501 369 370 # noqa: E501 371 372 :return: The file_format_hint of this Document. # noqa: E501 373 :rtype: str 374 """ 375 return self._file_format_hint 376 377 @file_format_hint.setter 378 def file_format_hint(self, file_format_hint): 379 """Sets the file_format_hint of this Document. 380 381 # noqa: E501 382 383 :param file_format_hint: The file_format_hint of this Document. # noqa: E501 384 :type: str 385 """ 386 387 self._file_format_hint = file_format_hint 388 389 @property 390 def html_definition(self): 391 """Gets the html_definition of this Document. # noqa: E501 392 393 Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). # noqa: E501 394 395 :return: The html_definition of this Document. # noqa: E501 396 :rtype: DocumentHtmlDefinition 397 """ 398 return self._html_definition 399 400 @html_definition.setter 401 def html_definition(self, html_definition): 402 """Sets the html_definition of this Document. 403 404 Defines how to generate the responsive-formatted HTML for the document. See [Responsive signing](/docs/esign-rest-api/esign101/concepts/responsive/) in the [eSignature concepts guide](/docs/esign-rest-api/esign101/concepts/). # noqa: E501 405 406 :param html_definition: The html_definition of this Document. # noqa: E501 407 :type: DocumentHtmlDefinition 408 """ 409 410 self._html_definition = html_definition 411 412 @property 413 def include_in_download(self): 414 """Gets the include_in_download of this Document. # noqa: E501 415 416 # noqa: E501 417 418 :return: The include_in_download of this Document. # noqa: E501 419 :rtype: str 420 """ 421 return self._include_in_download 422 423 @include_in_download.setter 424 def include_in_download(self, include_in_download): 425 """Sets the include_in_download of this Document. 426 427 # noqa: E501 428 429 :param include_in_download: The include_in_download of this Document. # noqa: E501 430 :type: str 431 """ 432 433 self._include_in_download = include_in_download 434 435 @property 436 def is_doc_gen_document(self): 437 """Gets the is_doc_gen_document of this Document. # noqa: E501 438 439 # noqa: E501 440 441 :return: The is_doc_gen_document of this Document. # noqa: E501 442 :rtype: str 443 """ 444 return self._is_doc_gen_document 445 446 @is_doc_gen_document.setter 447 def is_doc_gen_document(self, is_doc_gen_document): 448 """Sets the is_doc_gen_document of this Document. 449 450 # noqa: E501 451 452 :param is_doc_gen_document: The is_doc_gen_document of this Document. # noqa: E501 453 :type: str 454 """ 455 456 self._is_doc_gen_document = is_doc_gen_document 457 458 @property 459 def match_boxes(self): 460 """Gets the match_boxes of this Document. # noqa: E501 461 462 Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. # noqa: E501 463 464 :return: The match_boxes of this Document. # noqa: E501 465 :rtype: list[MatchBox] 466 """ 467 return self._match_boxes 468 469 @match_boxes.setter 470 def match_boxes(self, match_boxes): 471 """Sets the match_boxes of this Document. 472 473 Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. # noqa: E501 474 475 :param match_boxes: The match_boxes of this Document. # noqa: E501 476 :type: list[MatchBox] 477 """ 478 479 self._match_boxes = match_boxes 480 481 @property 482 def name(self): 483 """Gets the name of this Document. # noqa: E501 484 485 # noqa: E501 486 487 :return: The name of this Document. # noqa: E501 488 :rtype: str 489 """ 490 return self._name 491 492 @name.setter 493 def name(self, name): 494 """Sets the name of this Document. 495 496 # noqa: E501 497 498 :param name: The name of this Document. # noqa: E501 499 :type: str 500 """ 501 502 self._name = name 503 504 @property 505 def order(self): 506 """Gets the order of this Document. # noqa: E501 507 508 # noqa: E501 509 510 :return: The order of this Document. # noqa: E501 511 :rtype: str 512 """ 513 return self._order 514 515 @order.setter 516 def order(self, order): 517 """Sets the order of this Document. 518 519 # noqa: E501 520 521 :param order: The order of this Document. # noqa: E501 522 :type: str 523 """ 524 525 self._order = order 526 527 @property 528 def pages(self): 529 """Gets the pages of this Document. # noqa: E501 530 531 # noqa: E501 532 533 :return: The pages of this Document. # noqa: E501 534 :rtype: str 535 """ 536 return self._pages 537 538 @pages.setter 539 def pages(self, pages): 540 """Sets the pages of this Document. 541 542 # noqa: E501 543 544 :param pages: The pages of this Document. # noqa: E501 545 :type: str 546 """ 547 548 self._pages = pages 549 550 @property 551 def password(self): 552 """Gets the password of this Document. # noqa: E501 553 554 # noqa: E501 555 556 :return: The password of this Document. # noqa: E501 557 :rtype: str 558 """ 559 return self._password 560 561 @password.setter 562 def password(self, password): 563 """Sets the password of this Document. 564 565 # noqa: E501 566 567 :param password: The password of this Document. # noqa: E501 568 :type: str 569 """ 570 571 self._password = password 572 573 @property 574 def pdf_form_field_option(self): 575 """Gets the pdf_form_field_option of this Document. # noqa: E501 576 577 # noqa: E501 578 579 :return: The pdf_form_field_option of this Document. # noqa: E501 580 :rtype: str 581 """ 582 return self._pdf_form_field_option 583 584 @pdf_form_field_option.setter 585 def pdf_form_field_option(self, pdf_form_field_option): 586 """Sets the pdf_form_field_option of this Document. 587 588 # noqa: E501 589 590 :param pdf_form_field_option: The pdf_form_field_option of this Document. # noqa: E501 591 :type: str 592 """ 593 594 self._pdf_form_field_option = pdf_form_field_option 595 596 @property 597 def remote_url(self): 598 """Gets the remote_url of this Document. # noqa: E501 599 600 The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. # noqa: E501 601 602 :return: The remote_url of this Document. # noqa: E501 603 :rtype: str 604 """ 605 return self._remote_url 606 607 @remote_url.setter 608 def remote_url(self, remote_url): 609 """Sets the remote_url of this Document. 610 611 The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. # noqa: E501 612 613 :param remote_url: The remote_url of this Document. # noqa: E501 614 :type: str 615 """ 616 617 self._remote_url = remote_url 618 619 @property 620 def signer_must_acknowledge(self): 621 """Gets the signer_must_acknowledge of this Document. # noqa: E501 622 623 # noqa: E501 624 625 :return: The signer_must_acknowledge of this Document. # noqa: E501 626 :rtype: str 627 """ 628 return self._signer_must_acknowledge 629 630 @signer_must_acknowledge.setter 631 def signer_must_acknowledge(self, signer_must_acknowledge): 632 """Sets the signer_must_acknowledge of this Document. 633 634 # noqa: E501 635 636 :param signer_must_acknowledge: The signer_must_acknowledge of this Document. # noqa: E501 637 :type: str 638 """ 639 640 self._signer_must_acknowledge = signer_must_acknowledge 641 642 @property 643 def signer_must_acknowledge_use_account_default(self): 644 """Gets the signer_must_acknowledge_use_account_default of this Document. # noqa: E501 645 646 # noqa: E501 647 648 :return: The signer_must_acknowledge_use_account_default of this Document. # noqa: E501 649 :rtype: bool 650 """ 651 return self._signer_must_acknowledge_use_account_default 652 653 @signer_must_acknowledge_use_account_default.setter 654 def signer_must_acknowledge_use_account_default(self, signer_must_acknowledge_use_account_default): 655 """Sets the signer_must_acknowledge_use_account_default of this Document. 656 657 # noqa: E501 658 659 :param signer_must_acknowledge_use_account_default: The signer_must_acknowledge_use_account_default of this Document. # noqa: E501 660 :type: bool 661 """ 662 663 self._signer_must_acknowledge_use_account_default = signer_must_acknowledge_use_account_default 664 665 @property 666 def tabs(self): 667 """Gets the tabs of this Document. # noqa: E501 668 669 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 670 671 :return: The tabs of this Document. # noqa: E501 672 :rtype: Tabs 673 """ 674 return self._tabs 675 676 @tabs.setter 677 def tabs(self, tabs): 678 """Sets the tabs of this Document. 679 680 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 681 682 :param tabs: The tabs of this Document. # noqa: E501 683 :type: Tabs 684 """ 685 686 self._tabs = tabs 687 688 @property 689 def template_locked(self): 690 """Gets the template_locked of this Document. # noqa: E501 691 692 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 693 694 :return: The template_locked of this Document. # noqa: E501 695 :rtype: str 696 """ 697 return self._template_locked 698 699 @template_locked.setter 700 def template_locked(self, template_locked): 701 """Sets the template_locked of this Document. 702 703 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 704 705 :param template_locked: The template_locked of this Document. # noqa: E501 706 :type: str 707 """ 708 709 self._template_locked = template_locked 710 711 @property 712 def template_required(self): 713 """Gets the template_required of this Document. # noqa: E501 714 715 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 716 717 :return: The template_required of this Document. # noqa: E501 718 :rtype: str 719 """ 720 return self._template_required 721 722 @template_required.setter 723 def template_required(self, template_required): 724 """Sets the template_required of this Document. 725 726 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 727 728 :param template_required: The template_required of this Document. # noqa: E501 729 :type: str 730 """ 731 732 self._template_required = template_required 733 734 @property 735 def transform_pdf_fields(self): 736 """Gets the transform_pdf_fields of this Document. # noqa: E501 737 738 When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. # noqa: E501 739 740 :return: The transform_pdf_fields of this Document. # noqa: E501 741 :rtype: str 742 """ 743 return self._transform_pdf_fields 744 745 @transform_pdf_fields.setter 746 def transform_pdf_fields(self, transform_pdf_fields): 747 """Sets the transform_pdf_fields of this Document. 748 749 When set to **true**, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. # noqa: E501 750 751 :param transform_pdf_fields: The transform_pdf_fields of this Document. # noqa: E501 752 :type: str 753 """ 754 755 self._transform_pdf_fields = transform_pdf_fields 756 757 @property 758 def uri(self): 759 """Gets the uri of this Document. # noqa: E501 760 761 # noqa: E501 762 763 :return: The uri of this Document. # noqa: E501 764 :rtype: str 765 """ 766 return self._uri 767 768 @uri.setter 769 def uri(self, uri): 770 """Sets the uri of this Document. 771 772 # noqa: E501 773 774 :param uri: The uri of this Document. # noqa: E501 775 :type: str 776 """ 777 778 self._uri = uri 779 780 def to_dict(self): 781 """Returns the model properties as a dict""" 782 result = {} 783 784 for attr, _ in six.iteritems(self.swagger_types): 785 value = getattr(self, attr) 786 if isinstance(value, list): 787 result[attr] = list(map( 788 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 789 value 790 )) 791 elif hasattr(value, "to_dict"): 792 result[attr] = value.to_dict() 793 elif isinstance(value, dict): 794 result[attr] = dict(map( 795 lambda item: (item[0], item[1].to_dict()) 796 if hasattr(item[1], "to_dict") else item, 797 value.items() 798 )) 799 else: 800 result[attr] = value 801 if issubclass(Document, dict): 802 for key, value in self.items(): 803 result[key] = value 804 805 return result 806 807 def to_str(self): 808 """Returns the string representation of the model""" 809 return pprint.pformat(self.to_dict()) 810 811 def __repr__(self): 812 """For `print` and `pprint`""" 813 return self.to_str() 814 815 def __eq__(self, other): 816 """Returns true if both objects are equal""" 817 if not isinstance(other, Document): 818 return False 819 820 return self.to_dict() == other.to_dict() 821 822 def __ne__(self, other): 823 """Returns true if both objects are not equal""" 824 if not isinstance(other, Document): 825 return True 826 827 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.
Document(_configuration=None, **kwargs)
96 def __init__(self, _configuration=None, **kwargs): # noqa: E501 97 """Document - a model defined in Swagger""" # noqa: E501 98 if _configuration is None: 99 _configuration = Configuration() 100 self._configuration = _configuration 101 102 self._apply_anchor_tabs = None 103 self._assign_tabs_to_recipient_id = None 104 self._display = None 105 self._doc_gen_form_fields = None 106 self._document_base64 = None 107 self._document_fields = None 108 self._document_id = None 109 self._encrypted_with_key_manager = None 110 self._file_extension = None 111 self._file_format_hint = None 112 self._html_definition = None 113 self._include_in_download = None 114 self._is_doc_gen_document = None 115 self._match_boxes = None 116 self._name = None 117 self._order = None 118 self._pages = None 119 self._password = None 120 self._pdf_form_field_option = None 121 self._remote_url = None 122 self._signer_must_acknowledge = None 123 self._signer_must_acknowledge_use_account_default = None 124 self._tabs = None 125 self._template_locked = None 126 self._template_required = None 127 self._transform_pdf_fields = None 128 self._uri = None 129 self.discriminator = None 130 131 setattr(self, "_{}".format('apply_anchor_tabs'), kwargs.get('apply_anchor_tabs', None)) 132 setattr(self, "_{}".format('assign_tabs_to_recipient_id'), kwargs.get('assign_tabs_to_recipient_id', None)) 133 setattr(self, "_{}".format('display'), kwargs.get('display', None)) 134 setattr(self, "_{}".format('doc_gen_form_fields'), kwargs.get('doc_gen_form_fields', None)) 135 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 136 setattr(self, "_{}".format('document_fields'), kwargs.get('document_fields', None)) 137 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 138 setattr(self, "_{}".format('encrypted_with_key_manager'), kwargs.get('encrypted_with_key_manager', None)) 139 setattr(self, "_{}".format('file_extension'), kwargs.get('file_extension', None)) 140 setattr(self, "_{}".format('file_format_hint'), kwargs.get('file_format_hint', None)) 141 setattr(self, "_{}".format('html_definition'), kwargs.get('html_definition', None)) 142 setattr(self, "_{}".format('include_in_download'), kwargs.get('include_in_download', None)) 143 setattr(self, "_{}".format('is_doc_gen_document'), kwargs.get('is_doc_gen_document', None)) 144 setattr(self, "_{}".format('match_boxes'), kwargs.get('match_boxes', None)) 145 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 146 setattr(self, "_{}".format('order'), kwargs.get('order', None)) 147 setattr(self, "_{}".format('pages'), kwargs.get('pages', None)) 148 setattr(self, "_{}".format('password'), kwargs.get('password', None)) 149 setattr(self, "_{}".format('pdf_form_field_option'), kwargs.get('pdf_form_field_option', None)) 150 setattr(self, "_{}".format('remote_url'), kwargs.get('remote_url', None)) 151 setattr(self, "_{}".format('signer_must_acknowledge'), kwargs.get('signer_must_acknowledge', None)) 152 setattr(self, "_{}".format('signer_must_acknowledge_use_account_default'), kwargs.get('signer_must_acknowledge_use_account_default', None)) 153 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 154 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 155 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 156 setattr(self, "_{}".format('transform_pdf_fields'), kwargs.get('transform_pdf_fields', None)) 157 setattr(self, "_{}".format('uri'), kwargs.get('uri', None))
Document - a model defined in Swagger
swagger_types = {'apply_anchor_tabs': 'str', 'assign_tabs_to_recipient_id': 'str', 'display': 'str', 'doc_gen_form_fields': 'list[DocGenFormField]', 'document_base64': 'str', 'document_fields': 'list[NameValue]', 'document_id': 'str', 'encrypted_with_key_manager': 'str', 'file_extension': 'str', 'file_format_hint': 'str', 'html_definition': 'DocumentHtmlDefinition', 'include_in_download': 'str', 'is_doc_gen_document': 'str', 'match_boxes': 'list[MatchBox]', 'name': 'str', 'order': 'str', 'pages': 'str', 'password': 'str', 'pdf_form_field_option': 'str', 'remote_url': 'str', 'signer_must_acknowledge': 'str', 'signer_must_acknowledge_use_account_default': 'bool', 'tabs': 'Tabs', 'template_locked': 'str', 'template_required': 'str', 'transform_pdf_fields': 'str', 'uri': 'str'}
attribute_map = {'apply_anchor_tabs': 'applyAnchorTabs', 'assign_tabs_to_recipient_id': 'assignTabsToRecipientId', 'display': 'display', 'doc_gen_form_fields': 'docGenFormFields', 'document_base64': 'documentBase64', 'document_fields': 'documentFields', 'document_id': 'documentId', 'encrypted_with_key_manager': 'encryptedWithKeyManager', 'file_extension': 'fileExtension', 'file_format_hint': 'fileFormatHint', 'html_definition': 'htmlDefinition', 'include_in_download': 'includeInDownload', 'is_doc_gen_document': 'isDocGenDocument', 'match_boxes': 'matchBoxes', 'name': 'name', 'order': 'order', 'pages': 'pages', 'password': 'password', 'pdf_form_field_option': 'pdfFormFieldOption', 'remote_url': 'remoteUrl', 'signer_must_acknowledge': 'signerMustAcknowledge', 'signer_must_acknowledge_use_account_default': 'signerMustAcknowledgeUseAccountDefault', 'tabs': 'tabs', 'template_locked': 'templateLocked', 'template_required': 'templateRequired', 'transform_pdf_fields': 'transformPdfFields', 'uri': 'uri'}
apply_anchor_tabs
Gets the apply_anchor_tabs of this Document. # noqa: E501
Reserved: TBD # noqa: E501
Returns
The apply_anchor_tabs of this Document. # noqa: E501
assign_tabs_to_recipient_id
Gets the assign_tabs_to_recipient_id of this Document. # noqa: E501
# noqa: E501
Returns
The assign_tabs_to_recipient_id of this Document. # noqa: E501
display
Gets the display of this Document. # noqa: E501
# noqa: E501
Returns
The display of this Document. # noqa: E501
doc_gen_form_fields
Gets the doc_gen_form_fields of this Document. # noqa: E501
# noqa: E501
Returns
The doc_gen_form_fields of this Document. # noqa: E501
document_base64
Gets the document_base64 of this Document. # noqa: E501
The document's bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. # noqa: E501
Returns
The document_base64 of this Document. # noqa: E501
document_fields
Gets the document_fields of this Document. # noqa: E501
# noqa: E501
Returns
The document_fields of this Document. # noqa: E501
document_id
Gets the document_id of this Document. # 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 Document. # noqa: E501
encrypted_with_key_manager
Gets the encrypted_with_key_manager of this Document. # noqa: E501
When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. # noqa: E501
Returns
The encrypted_with_key_manager of this Document. # noqa: E501
file_extension
Gets the file_extension of this Document. # noqa: E501
The file extension type of the document. If the document is not a PDF it is converted to a PDF. # noqa: E501
Returns
The file_extension of this Document. # noqa: E501
file_format_hint
Gets the file_format_hint of this Document. # noqa: E501
# noqa: E501
Returns
The file_format_hint of this Document. # noqa: E501
html_definition
Gets the html_definition of this Document. # noqa: E501
Defines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide. # noqa: E501
Returns
The html_definition of this Document. # noqa: E501
include_in_download
Gets the include_in_download of this Document. # noqa: E501
# noqa: E501
Returns
The include_in_download of this Document. # noqa: E501
is_doc_gen_document
Gets the is_doc_gen_document of this Document. # noqa: E501
# noqa: E501
Returns
The is_doc_gen_document of this Document. # noqa: E501
match_boxes
Gets the match_boxes of this Document. # noqa: E501
Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. # noqa: E501
Returns
The match_boxes of this Document. # noqa: E501
name
Gets the name of this Document. # noqa: E501
# noqa: E501
Returns
The name of this Document. # noqa: E501
order
Gets the order of this Document. # noqa: E501
# noqa: E501
Returns
The order of this Document. # noqa: E501
pages
Gets the pages of this Document. # noqa: E501
# noqa: E501
Returns
The pages of this Document. # noqa: E501
password
Gets the password of this Document. # noqa: E501
# noqa: E501
Returns
The password of this Document. # noqa: E501
pdf_form_field_option
Gets the pdf_form_field_option of this Document. # noqa: E501
# noqa: E501
Returns
The pdf_form_field_option of this Document. # noqa: E501
remote_url
Gets the remote_url of this Document. # noqa: E501
The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. # noqa: E501
Returns
The remote_url of this Document. # noqa: E501
signer_must_acknowledge
Gets the signer_must_acknowledge of this Document. # noqa: E501
# noqa: E501
Returns
The signer_must_acknowledge of this Document. # noqa: E501
signer_must_acknowledge_use_account_default
Gets the signer_must_acknowledge_use_account_default of this Document. # noqa: E501
# noqa: E501
Returns
The signer_must_acknowledge_use_account_default of this Document. # noqa: E501
tabs
Gets the tabs of this Document. # noqa: E501
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501
Returns
The tabs of this Document. # noqa: E501
template_locked
Gets the template_locked of this Document. # 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 Document. # noqa: E501
template_required
Gets the template_required of this Document. # 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 Document. # noqa: E501
transform_pdf_fields
Gets the transform_pdf_fields of this Document. # noqa: E501
When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. # noqa: E501
Returns
The transform_pdf_fields of this Document. # noqa: E501
uri
Gets the uri of this Document. # noqa: E501
# noqa: E501
Returns
The uri of this Document. # noqa: E501
def
to_dict(self)
780 def to_dict(self): 781 """Returns the model properties as a dict""" 782 result = {} 783 784 for attr, _ in six.iteritems(self.swagger_types): 785 value = getattr(self, attr) 786 if isinstance(value, list): 787 result[attr] = list(map( 788 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 789 value 790 )) 791 elif hasattr(value, "to_dict"): 792 result[attr] = value.to_dict() 793 elif isinstance(value, dict): 794 result[attr] = dict(map( 795 lambda item: (item[0], item[1].to_dict()) 796 if hasattr(item[1], "to_dict") else item, 797 value.items() 798 )) 799 else: 800 result[attr] = value 801 if issubclass(Document, dict): 802 for key, value in self.items(): 803 result[key] = value 804 805 return result
Returns the model properties as a dict