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