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