docusign_esign.models.envelope_document

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