docusign_esign.models.envelope_template_result

   1# coding: utf-8
   2
   3"""
   4    DocuSign REST API
   5
   6    The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign.
   7
   8    OpenAPI spec version: v2
   9    Contact: devcenter@docusign.com
  10    Generated by: https://github.com/swagger-api/swagger-codegen.git
  11"""
  12
  13
  14from pprint import pformat
  15from six import iteritems
  16import re
  17
  18
  19class EnvelopeTemplateResult(object):
  20    """
  21    NOTE: This class is auto generated by the swagger code generator program.
  22    Do not edit the class manually.
  23    """
  24    def __init__(self, allow_markup=None, allow_reassign=None, allow_view_history=None, asynchronous=None, attachments_uri=None, authoritative_copy=None, authoritative_copy_default=None, auto_navigation=None, brand_id=None, brand_lock=None, certificate_uri=None, completed_date_time=None, created=None, created_date_time=None, custom_fields=None, custom_fields_uri=None, declined_date_time=None, deleted_date_time=None, delivered_date_time=None, description=None, documents=None, documents_combined_uri=None, documents_uri=None, email_blurb=None, email_settings=None, email_subject=None, enable_wet_sign=None, enforce_signer_visibility=None, envelope_id=None, envelope_id_stamping=None, envelope_uri=None, folder_id=None, folder_name=None, folder_uri=None, initial_sent_date_time=None, is21_cfr_part11=None, is_signature_provider_envelope=None, last_modified=None, last_modified_date_time=None, lock_information=None, message_lock=None, name=None, notification=None, notification_uri=None, owner=None, page_count=None, parent_folder_uri=None, password=None, purge_state=None, recipients=None, recipients_lock=None, recipients_uri=None, sent_date_time=None, shared=None, signer_can_sign_on_mobile=None, signing_location=None, status=None, status_changed_date_time=None, template_id=None, templates_uri=None, transaction_id=None, uri=None, use_disclosure=None, voided_date_time=None, voided_reason=None):
  25        """
  26        EnvelopeTemplateResult - a model defined in Swagger
  27
  28        :param dict swaggerTypes: The key is attribute name
  29                                  and the value is attribute type.
  30        :param dict attributeMap: The key is attribute name
  31                                  and the value is json key in definition.
  32        """
  33        self.swagger_types = {
  34            'allow_markup': 'str',
  35            'allow_reassign': 'str',
  36            'allow_view_history': 'str',
  37            'asynchronous': 'str',
  38            'attachments_uri': 'str',
  39            'authoritative_copy': 'str',
  40            'authoritative_copy_default': 'str',
  41            'auto_navigation': 'str',
  42            'brand_id': 'str',
  43            'brand_lock': 'str',
  44            'certificate_uri': 'str',
  45            'completed_date_time': 'str',
  46            'created': 'str',
  47            'created_date_time': 'str',
  48            'custom_fields': 'CustomFields',
  49            'custom_fields_uri': 'str',
  50            'declined_date_time': 'str',
  51            'deleted_date_time': 'str',
  52            'delivered_date_time': 'str',
  53            'description': 'str',
  54            'documents': 'list[Document]',
  55            'documents_combined_uri': 'str',
  56            'documents_uri': 'str',
  57            'email_blurb': 'str',
  58            'email_settings': 'EmailSettings',
  59            'email_subject': 'str',
  60            'enable_wet_sign': 'str',
  61            'enforce_signer_visibility': 'str',
  62            'envelope_id': 'str',
  63            'envelope_id_stamping': 'str',
  64            'envelope_uri': 'str',
  65            'folder_id': 'str',
  66            'folder_name': 'str',
  67            'folder_uri': 'str',
  68            'initial_sent_date_time': 'str',
  69            'is21_cfr_part11': 'str',
  70            'is_signature_provider_envelope': 'str',
  71            'last_modified': 'str',
  72            'last_modified_date_time': 'str',
  73            'lock_information': 'LockInformation',
  74            'message_lock': 'str',
  75            'name': 'str',
  76            'notification': 'Notification',
  77            'notification_uri': 'str',
  78            'owner': 'UserInfo',
  79            'page_count': 'int',
  80            'parent_folder_uri': 'str',
  81            'password': 'str',
  82            'purge_state': 'str',
  83            'recipients': 'Recipients',
  84            'recipients_lock': 'str',
  85            'recipients_uri': 'str',
  86            'sent_date_time': 'str',
  87            'shared': 'str',
  88            'signer_can_sign_on_mobile': 'str',
  89            'signing_location': 'str',
  90            'status': 'str',
  91            'status_changed_date_time': 'str',
  92            'template_id': 'str',
  93            'templates_uri': 'str',
  94            'transaction_id': 'str',
  95            'uri': 'str',
  96            'use_disclosure': 'str',
  97            'voided_date_time': 'str',
  98            'voided_reason': 'str'
  99        }
 100
 101        self.attribute_map = {
 102            'allow_markup': 'allowMarkup',
 103            'allow_reassign': 'allowReassign',
 104            'allow_view_history': 'allowViewHistory',
 105            'asynchronous': 'asynchronous',
 106            'attachments_uri': 'attachmentsUri',
 107            'authoritative_copy': 'authoritativeCopy',
 108            'authoritative_copy_default': 'authoritativeCopyDefault',
 109            'auto_navigation': 'autoNavigation',
 110            'brand_id': 'brandId',
 111            'brand_lock': 'brandLock',
 112            'certificate_uri': 'certificateUri',
 113            'completed_date_time': 'completedDateTime',
 114            'created': 'created',
 115            'created_date_time': 'createdDateTime',
 116            'custom_fields': 'customFields',
 117            'custom_fields_uri': 'customFieldsUri',
 118            'declined_date_time': 'declinedDateTime',
 119            'deleted_date_time': 'deletedDateTime',
 120            'delivered_date_time': 'deliveredDateTime',
 121            'description': 'description',
 122            'documents': 'documents',
 123            'documents_combined_uri': 'documentsCombinedUri',
 124            'documents_uri': 'documentsUri',
 125            'email_blurb': 'emailBlurb',
 126            'email_settings': 'emailSettings',
 127            'email_subject': 'emailSubject',
 128            'enable_wet_sign': 'enableWetSign',
 129            'enforce_signer_visibility': 'enforceSignerVisibility',
 130            'envelope_id': 'envelopeId',
 131            'envelope_id_stamping': 'envelopeIdStamping',
 132            'envelope_uri': 'envelopeUri',
 133            'folder_id': 'folderId',
 134            'folder_name': 'folderName',
 135            'folder_uri': 'folderUri',
 136            'initial_sent_date_time': 'initialSentDateTime',
 137            'is21_cfr_part11': 'is21CFRPart11',
 138            'is_signature_provider_envelope': 'isSignatureProviderEnvelope',
 139            'last_modified': 'lastModified',
 140            'last_modified_date_time': 'lastModifiedDateTime',
 141            'lock_information': 'lockInformation',
 142            'message_lock': 'messageLock',
 143            'name': 'name',
 144            'notification': 'notification',
 145            'notification_uri': 'notificationUri',
 146            'owner': 'owner',
 147            'page_count': 'pageCount',
 148            'parent_folder_uri': 'parentFolderUri',
 149            'password': 'password',
 150            'purge_state': 'purgeState',
 151            'recipients': 'recipients',
 152            'recipients_lock': 'recipientsLock',
 153            'recipients_uri': 'recipientsUri',
 154            'sent_date_time': 'sentDateTime',
 155            'shared': 'shared',
 156            'signer_can_sign_on_mobile': 'signerCanSignOnMobile',
 157            'signing_location': 'signingLocation',
 158            'status': 'status',
 159            'status_changed_date_time': 'statusChangedDateTime',
 160            'template_id': 'templateId',
 161            'templates_uri': 'templatesUri',
 162            'transaction_id': 'transactionId',
 163            'uri': 'uri',
 164            'use_disclosure': 'useDisclosure',
 165            'voided_date_time': 'voidedDateTime',
 166            'voided_reason': 'voidedReason'
 167        }
 168
 169        self._allow_markup = allow_markup
 170        self._allow_reassign = allow_reassign
 171        self._allow_view_history = allow_view_history
 172        self._asynchronous = asynchronous
 173        self._attachments_uri = attachments_uri
 174        self._authoritative_copy = authoritative_copy
 175        self._authoritative_copy_default = authoritative_copy_default
 176        self._auto_navigation = auto_navigation
 177        self._brand_id = brand_id
 178        self._brand_lock = brand_lock
 179        self._certificate_uri = certificate_uri
 180        self._completed_date_time = completed_date_time
 181        self._created = created
 182        self._created_date_time = created_date_time
 183        self._custom_fields = custom_fields
 184        self._custom_fields_uri = custom_fields_uri
 185        self._declined_date_time = declined_date_time
 186        self._deleted_date_time = deleted_date_time
 187        self._delivered_date_time = delivered_date_time
 188        self._description = description
 189        self._documents = documents
 190        self._documents_combined_uri = documents_combined_uri
 191        self._documents_uri = documents_uri
 192        self._email_blurb = email_blurb
 193        self._email_settings = email_settings
 194        self._email_subject = email_subject
 195        self._enable_wet_sign = enable_wet_sign
 196        self._enforce_signer_visibility = enforce_signer_visibility
 197        self._envelope_id = envelope_id
 198        self._envelope_id_stamping = envelope_id_stamping
 199        self._envelope_uri = envelope_uri
 200        self._folder_id = folder_id
 201        self._folder_name = folder_name
 202        self._folder_uri = folder_uri
 203        self._initial_sent_date_time = initial_sent_date_time
 204        self._is21_cfr_part11 = is21_cfr_part11
 205        self._is_signature_provider_envelope = is_signature_provider_envelope
 206        self._last_modified = last_modified
 207        self._last_modified_date_time = last_modified_date_time
 208        self._lock_information = lock_information
 209        self._message_lock = message_lock
 210        self._name = name
 211        self._notification = notification
 212        self._notification_uri = notification_uri
 213        self._owner = owner
 214        self._page_count = page_count
 215        self._parent_folder_uri = parent_folder_uri
 216        self._password = password
 217        self._purge_state = purge_state
 218        self._recipients = recipients
 219        self._recipients_lock = recipients_lock
 220        self._recipients_uri = recipients_uri
 221        self._sent_date_time = sent_date_time
 222        self._shared = shared
 223        self._signer_can_sign_on_mobile = signer_can_sign_on_mobile
 224        self._signing_location = signing_location
 225        self._status = status
 226        self._status_changed_date_time = status_changed_date_time
 227        self._template_id = template_id
 228        self._templates_uri = templates_uri
 229        self._transaction_id = transaction_id
 230        self._uri = uri
 231        self._use_disclosure = use_disclosure
 232        self._voided_date_time = voided_date_time
 233        self._voided_reason = voided_reason
 234
 235    @property
 236    def allow_markup(self):
 237        """
 238        Gets the allow_markup of this EnvelopeTemplateResult.
 239        When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
 240
 241        :return: The allow_markup of this EnvelopeTemplateResult.
 242        :rtype: str
 243        """
 244        return self._allow_markup
 245
 246    @allow_markup.setter
 247    def allow_markup(self, allow_markup):
 248        """
 249        Sets the allow_markup of this EnvelopeTemplateResult.
 250        When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
 251
 252        :param allow_markup: The allow_markup of this EnvelopeTemplateResult.
 253        :type: str
 254        """
 255
 256        self._allow_markup = allow_markup
 257
 258    @property
 259    def allow_reassign(self):
 260        """
 261        Gets the allow_reassign of this EnvelopeTemplateResult.
 262        When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
 263
 264        :return: The allow_reassign of this EnvelopeTemplateResult.
 265        :rtype: str
 266        """
 267        return self._allow_reassign
 268
 269    @allow_reassign.setter
 270    def allow_reassign(self, allow_reassign):
 271        """
 272        Sets the allow_reassign of this EnvelopeTemplateResult.
 273        When set to **true**, the recipient can redirect an envelope to a more appropriate recipient.
 274
 275        :param allow_reassign: The allow_reassign of this EnvelopeTemplateResult.
 276        :type: str
 277        """
 278
 279        self._allow_reassign = allow_reassign
 280
 281    @property
 282    def allow_view_history(self):
 283        """
 284        Gets the allow_view_history of this EnvelopeTemplateResult.
 285        
 286
 287        :return: The allow_view_history of this EnvelopeTemplateResult.
 288        :rtype: str
 289        """
 290        return self._allow_view_history
 291
 292    @allow_view_history.setter
 293    def allow_view_history(self, allow_view_history):
 294        """
 295        Sets the allow_view_history of this EnvelopeTemplateResult.
 296        
 297
 298        :param allow_view_history: The allow_view_history of this EnvelopeTemplateResult.
 299        :type: str
 300        """
 301
 302        self._allow_view_history = allow_view_history
 303
 304    @property
 305    def asynchronous(self):
 306        """
 307        Gets the asynchronous of this EnvelopeTemplateResult.
 308        When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
 309
 310        :return: The asynchronous of this EnvelopeTemplateResult.
 311        :rtype: str
 312        """
 313        return self._asynchronous
 314
 315    @asynchronous.setter
 316    def asynchronous(self, asynchronous):
 317        """
 318        Sets the asynchronous of this EnvelopeTemplateResult.
 319        When set to **true**, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.
 320
 321        :param asynchronous: The asynchronous of this EnvelopeTemplateResult.
 322        :type: str
 323        """
 324
 325        self._asynchronous = asynchronous
 326
 327    @property
 328    def attachments_uri(self):
 329        """
 330        Gets the attachments_uri of this EnvelopeTemplateResult.
 331        
 332
 333        :return: The attachments_uri of this EnvelopeTemplateResult.
 334        :rtype: str
 335        """
 336        return self._attachments_uri
 337
 338    @attachments_uri.setter
 339    def attachments_uri(self, attachments_uri):
 340        """
 341        Sets the attachments_uri of this EnvelopeTemplateResult.
 342        
 343
 344        :param attachments_uri: The attachments_uri of this EnvelopeTemplateResult.
 345        :type: str
 346        """
 347
 348        self._attachments_uri = attachments_uri
 349
 350    @property
 351    def authoritative_copy(self):
 352        """
 353        Gets the authoritative_copy of this EnvelopeTemplateResult.
 354        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
 355
 356        :return: The authoritative_copy of this EnvelopeTemplateResult.
 357        :rtype: str
 358        """
 359        return self._authoritative_copy
 360
 361    @authoritative_copy.setter
 362    def authoritative_copy(self, authoritative_copy):
 363        """
 364        Sets the authoritative_copy of this EnvelopeTemplateResult.
 365        Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
 366
 367        :param authoritative_copy: The authoritative_copy of this EnvelopeTemplateResult.
 368        :type: str
 369        """
 370
 371        self._authoritative_copy = authoritative_copy
 372
 373    @property
 374    def authoritative_copy_default(self):
 375        """
 376        Gets the authoritative_copy_default of this EnvelopeTemplateResult.
 377        
 378
 379        :return: The authoritative_copy_default of this EnvelopeTemplateResult.
 380        :rtype: str
 381        """
 382        return self._authoritative_copy_default
 383
 384    @authoritative_copy_default.setter
 385    def authoritative_copy_default(self, authoritative_copy_default):
 386        """
 387        Sets the authoritative_copy_default of this EnvelopeTemplateResult.
 388        
 389
 390        :param authoritative_copy_default: The authoritative_copy_default of this EnvelopeTemplateResult.
 391        :type: str
 392        """
 393
 394        self._authoritative_copy_default = authoritative_copy_default
 395
 396    @property
 397    def auto_navigation(self):
 398        """
 399        Gets the auto_navigation of this EnvelopeTemplateResult.
 400        
 401
 402        :return: The auto_navigation of this EnvelopeTemplateResult.
 403        :rtype: str
 404        """
 405        return self._auto_navigation
 406
 407    @auto_navigation.setter
 408    def auto_navigation(self, auto_navigation):
 409        """
 410        Sets the auto_navigation of this EnvelopeTemplateResult.
 411        
 412
 413        :param auto_navigation: The auto_navigation of this EnvelopeTemplateResult.
 414        :type: str
 415        """
 416
 417        self._auto_navigation = auto_navigation
 418
 419    @property
 420    def brand_id(self):
 421        """
 422        Gets the brand_id of this EnvelopeTemplateResult.
 423        
 424
 425        :return: The brand_id of this EnvelopeTemplateResult.
 426        :rtype: str
 427        """
 428        return self._brand_id
 429
 430    @brand_id.setter
 431    def brand_id(self, brand_id):
 432        """
 433        Sets the brand_id of this EnvelopeTemplateResult.
 434        
 435
 436        :param brand_id: The brand_id of this EnvelopeTemplateResult.
 437        :type: str
 438        """
 439
 440        self._brand_id = brand_id
 441
 442    @property
 443    def brand_lock(self):
 444        """
 445        Gets the brand_lock of this EnvelopeTemplateResult.
 446        
 447
 448        :return: The brand_lock of this EnvelopeTemplateResult.
 449        :rtype: str
 450        """
 451        return self._brand_lock
 452
 453    @brand_lock.setter
 454    def brand_lock(self, brand_lock):
 455        """
 456        Sets the brand_lock of this EnvelopeTemplateResult.
 457        
 458
 459        :param brand_lock: The brand_lock of this EnvelopeTemplateResult.
 460        :type: str
 461        """
 462
 463        self._brand_lock = brand_lock
 464
 465    @property
 466    def certificate_uri(self):
 467        """
 468        Gets the certificate_uri of this EnvelopeTemplateResult.
 469        Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
 470
 471        :return: The certificate_uri of this EnvelopeTemplateResult.
 472        :rtype: str
 473        """
 474        return self._certificate_uri
 475
 476    @certificate_uri.setter
 477    def certificate_uri(self, certificate_uri):
 478        """
 479        Sets the certificate_uri of this EnvelopeTemplateResult.
 480        Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
 481
 482        :param certificate_uri: The certificate_uri of this EnvelopeTemplateResult.
 483        :type: str
 484        """
 485
 486        self._certificate_uri = certificate_uri
 487
 488    @property
 489    def completed_date_time(self):
 490        """
 491        Gets the completed_date_time of this EnvelopeTemplateResult.
 492        Specifies the date and time this item was completed.
 493
 494        :return: The completed_date_time of this EnvelopeTemplateResult.
 495        :rtype: str
 496        """
 497        return self._completed_date_time
 498
 499    @completed_date_time.setter
 500    def completed_date_time(self, completed_date_time):
 501        """
 502        Sets the completed_date_time of this EnvelopeTemplateResult.
 503        Specifies the date and time this item was completed.
 504
 505        :param completed_date_time: The completed_date_time of this EnvelopeTemplateResult.
 506        :type: str
 507        """
 508
 509        self._completed_date_time = completed_date_time
 510
 511    @property
 512    def created(self):
 513        """
 514        Gets the created of this EnvelopeTemplateResult.
 515        
 516
 517        :return: The created of this EnvelopeTemplateResult.
 518        :rtype: str
 519        """
 520        return self._created
 521
 522    @created.setter
 523    def created(self, created):
 524        """
 525        Sets the created of this EnvelopeTemplateResult.
 526        
 527
 528        :param created: The created of this EnvelopeTemplateResult.
 529        :type: str
 530        """
 531
 532        self._created = created
 533
 534    @property
 535    def created_date_time(self):
 536        """
 537        Gets the created_date_time of this EnvelopeTemplateResult.
 538        Indicates the date and time the item was created.
 539
 540        :return: The created_date_time of this EnvelopeTemplateResult.
 541        :rtype: str
 542        """
 543        return self._created_date_time
 544
 545    @created_date_time.setter
 546    def created_date_time(self, created_date_time):
 547        """
 548        Sets the created_date_time of this EnvelopeTemplateResult.
 549        Indicates the date and time the item was created.
 550
 551        :param created_date_time: The created_date_time of this EnvelopeTemplateResult.
 552        :type: str
 553        """
 554
 555        self._created_date_time = created_date_time
 556
 557    @property
 558    def custom_fields(self):
 559        """
 560        Gets the custom_fields of this EnvelopeTemplateResult.
 561
 562        :return: The custom_fields of this EnvelopeTemplateResult.
 563        :rtype: CustomFields
 564        """
 565        return self._custom_fields
 566
 567    @custom_fields.setter
 568    def custom_fields(self, custom_fields):
 569        """
 570        Sets the custom_fields of this EnvelopeTemplateResult.
 571
 572        :param custom_fields: The custom_fields of this EnvelopeTemplateResult.
 573        :type: CustomFields
 574        """
 575
 576        self._custom_fields = custom_fields
 577
 578    @property
 579    def custom_fields_uri(self):
 580        """
 581        Gets the custom_fields_uri of this EnvelopeTemplateResult.
 582        Contains a URI for an endpoint that you can use to retrieve the custom fields.
 583
 584        :return: The custom_fields_uri of this EnvelopeTemplateResult.
 585        :rtype: str
 586        """
 587        return self._custom_fields_uri
 588
 589    @custom_fields_uri.setter
 590    def custom_fields_uri(self, custom_fields_uri):
 591        """
 592        Sets the custom_fields_uri of this EnvelopeTemplateResult.
 593        Contains a URI for an endpoint that you can use to retrieve the custom fields.
 594
 595        :param custom_fields_uri: The custom_fields_uri of this EnvelopeTemplateResult.
 596        :type: str
 597        """
 598
 599        self._custom_fields_uri = custom_fields_uri
 600
 601    @property
 602    def declined_date_time(self):
 603        """
 604        Gets the declined_date_time of this EnvelopeTemplateResult.
 605        The date and time the recipient declined the document.
 606
 607        :return: The declined_date_time of this EnvelopeTemplateResult.
 608        :rtype: str
 609        """
 610        return self._declined_date_time
 611
 612    @declined_date_time.setter
 613    def declined_date_time(self, declined_date_time):
 614        """
 615        Sets the declined_date_time of this EnvelopeTemplateResult.
 616        The date and time the recipient declined the document.
 617
 618        :param declined_date_time: The declined_date_time of this EnvelopeTemplateResult.
 619        :type: str
 620        """
 621
 622        self._declined_date_time = declined_date_time
 623
 624    @property
 625    def deleted_date_time(self):
 626        """
 627        Gets the deleted_date_time of this EnvelopeTemplateResult.
 628        Specifies the data and time the item was deleted.
 629
 630        :return: The deleted_date_time of this EnvelopeTemplateResult.
 631        :rtype: str
 632        """
 633        return self._deleted_date_time
 634
 635    @deleted_date_time.setter
 636    def deleted_date_time(self, deleted_date_time):
 637        """
 638        Sets the deleted_date_time of this EnvelopeTemplateResult.
 639        Specifies the data and time the item was deleted.
 640
 641        :param deleted_date_time: The deleted_date_time of this EnvelopeTemplateResult.
 642        :type: str
 643        """
 644
 645        self._deleted_date_time = deleted_date_time
 646
 647    @property
 648    def delivered_date_time(self):
 649        """
 650        Gets the delivered_date_time of this EnvelopeTemplateResult.
 651        Reserved: For DocuSign use only.
 652
 653        :return: The delivered_date_time of this EnvelopeTemplateResult.
 654        :rtype: str
 655        """
 656        return self._delivered_date_time
 657
 658    @delivered_date_time.setter
 659    def delivered_date_time(self, delivered_date_time):
 660        """
 661        Sets the delivered_date_time of this EnvelopeTemplateResult.
 662        Reserved: For DocuSign use only.
 663
 664        :param delivered_date_time: The delivered_date_time of this EnvelopeTemplateResult.
 665        :type: str
 666        """
 667
 668        self._delivered_date_time = delivered_date_time
 669
 670    @property
 671    def description(self):
 672        """
 673        Gets the description of this EnvelopeTemplateResult.
 674        
 675
 676        :return: The description of this EnvelopeTemplateResult.
 677        :rtype: str
 678        """
 679        return self._description
 680
 681    @description.setter
 682    def description(self, description):
 683        """
 684        Sets the description of this EnvelopeTemplateResult.
 685        
 686
 687        :param description: The description of this EnvelopeTemplateResult.
 688        :type: str
 689        """
 690
 691        self._description = description
 692
 693    @property
 694    def documents(self):
 695        """
 696        Gets the documents of this EnvelopeTemplateResult.
 697        Complex element contains the details on the documents in the envelope.
 698
 699        :return: The documents of this EnvelopeTemplateResult.
 700        :rtype: list[Document]
 701        """
 702        return self._documents
 703
 704    @documents.setter
 705    def documents(self, documents):
 706        """
 707        Sets the documents of this EnvelopeTemplateResult.
 708        Complex element contains the details on the documents in the envelope.
 709
 710        :param documents: The documents of this EnvelopeTemplateResult.
 711        :type: list[Document]
 712        """
 713
 714        self._documents = documents
 715
 716    @property
 717    def documents_combined_uri(self):
 718        """
 719        Gets the documents_combined_uri of this EnvelopeTemplateResult.
 720        
 721
 722        :return: The documents_combined_uri of this EnvelopeTemplateResult.
 723        :rtype: str
 724        """
 725        return self._documents_combined_uri
 726
 727    @documents_combined_uri.setter
 728    def documents_combined_uri(self, documents_combined_uri):
 729        """
 730        Sets the documents_combined_uri of this EnvelopeTemplateResult.
 731        
 732
 733        :param documents_combined_uri: The documents_combined_uri of this EnvelopeTemplateResult.
 734        :type: str
 735        """
 736
 737        self._documents_combined_uri = documents_combined_uri
 738
 739    @property
 740    def documents_uri(self):
 741        """
 742        Gets the documents_uri of this EnvelopeTemplateResult.
 743        Contains a URI for an endpoint that you can use to retrieve the documents.
 744
 745        :return: The documents_uri of this EnvelopeTemplateResult.
 746        :rtype: str
 747        """
 748        return self._documents_uri
 749
 750    @documents_uri.setter
 751    def documents_uri(self, documents_uri):
 752        """
 753        Sets the documents_uri of this EnvelopeTemplateResult.
 754        Contains a URI for an endpoint that you can use to retrieve the documents.
 755
 756        :param documents_uri: The documents_uri of this EnvelopeTemplateResult.
 757        :type: str
 758        """
 759
 760        self._documents_uri = documents_uri
 761
 762    @property
 763    def email_blurb(self):
 764        """
 765        Gets the email_blurb of this EnvelopeTemplateResult.
 766        
 767
 768        :return: The email_blurb of this EnvelopeTemplateResult.
 769        :rtype: str
 770        """
 771        return self._email_blurb
 772
 773    @email_blurb.setter
 774    def email_blurb(self, email_blurb):
 775        """
 776        Sets the email_blurb of this EnvelopeTemplateResult.
 777        
 778
 779        :param email_blurb: The email_blurb of this EnvelopeTemplateResult.
 780        :type: str
 781        """
 782
 783        self._email_blurb = email_blurb
 784
 785    @property
 786    def email_settings(self):
 787        """
 788        Gets the email_settings of this EnvelopeTemplateResult.
 789
 790        :return: The email_settings of this EnvelopeTemplateResult.
 791        :rtype: EmailSettings
 792        """
 793        return self._email_settings
 794
 795    @email_settings.setter
 796    def email_settings(self, email_settings):
 797        """
 798        Sets the email_settings of this EnvelopeTemplateResult.
 799
 800        :param email_settings: The email_settings of this EnvelopeTemplateResult.
 801        :type: EmailSettings
 802        """
 803
 804        self._email_settings = email_settings
 805
 806    @property
 807    def email_subject(self):
 808        """
 809        Gets the email_subject of this EnvelopeTemplateResult.
 810        Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
 811
 812        :return: The email_subject of this EnvelopeTemplateResult.
 813        :rtype: str
 814        """
 815        return self._email_subject
 816
 817    @email_subject.setter
 818    def email_subject(self, email_subject):
 819        """
 820        Sets the email_subject of this EnvelopeTemplateResult.
 821        Specifies the subject of the email that is sent to all recipients.  See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.
 822
 823        :param email_subject: The email_subject of this EnvelopeTemplateResult.
 824        :type: str
 825        """
 826
 827        self._email_subject = email_subject
 828
 829    @property
 830    def enable_wet_sign(self):
 831        """
 832        Gets the enable_wet_sign of this EnvelopeTemplateResult.
 833        When set to **true**, the signer is allowed to print the document and sign it on paper.
 834
 835        :return: The enable_wet_sign of this EnvelopeTemplateResult.
 836        :rtype: str
 837        """
 838        return self._enable_wet_sign
 839
 840    @enable_wet_sign.setter
 841    def enable_wet_sign(self, enable_wet_sign):
 842        """
 843        Sets the enable_wet_sign of this EnvelopeTemplateResult.
 844        When set to **true**, the signer is allowed to print the document and sign it on paper.
 845
 846        :param enable_wet_sign: The enable_wet_sign of this EnvelopeTemplateResult.
 847        :type: str
 848        """
 849
 850        self._enable_wet_sign = enable_wet_sign
 851
 852    @property
 853    def enforce_signer_visibility(self):
 854        """
 855        Gets the enforce_signer_visibility of this EnvelopeTemplateResult.
 856        When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.  Your account must have Document Visibility enabled to use this.
 857
 858        :return: The enforce_signer_visibility of this EnvelopeTemplateResult.
 859        :rtype: str
 860        """
 861        return self._enforce_signer_visibility
 862
 863    @enforce_signer_visibility.setter
 864    def enforce_signer_visibility(self, enforce_signer_visibility):
 865        """
 866        Sets the enforce_signer_visibility of this EnvelopeTemplateResult.
 867        When set to **true**, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.  Your account must have Document Visibility enabled to use this.
 868
 869        :param enforce_signer_visibility: The enforce_signer_visibility of this EnvelopeTemplateResult.
 870        :type: str
 871        """
 872
 873        self._enforce_signer_visibility = enforce_signer_visibility
 874
 875    @property
 876    def envelope_id(self):
 877        """
 878        Gets the envelope_id of this EnvelopeTemplateResult.
 879        The envelope ID of the envelope status that failed to post.
 880
 881        :return: The envelope_id of this EnvelopeTemplateResult.
 882        :rtype: str
 883        """
 884        return self._envelope_id
 885
 886    @envelope_id.setter
 887    def envelope_id(self, envelope_id):
 888        """
 889        Sets the envelope_id of this EnvelopeTemplateResult.
 890        The envelope ID of the envelope status that failed to post.
 891
 892        :param envelope_id: The envelope_id of this EnvelopeTemplateResult.
 893        :type: str
 894        """
 895
 896        self._envelope_id = envelope_id
 897
 898    @property
 899    def envelope_id_stamping(self):
 900        """
 901        Gets the envelope_id_stamping of this EnvelopeTemplateResult.
 902        When set to **true**, Envelope ID Stamping is enabled.
 903
 904        :return: The envelope_id_stamping of this EnvelopeTemplateResult.
 905        :rtype: str
 906        """
 907        return self._envelope_id_stamping
 908
 909    @envelope_id_stamping.setter
 910    def envelope_id_stamping(self, envelope_id_stamping):
 911        """
 912        Sets the envelope_id_stamping of this EnvelopeTemplateResult.
 913        When set to **true**, Envelope ID Stamping is enabled.
 914
 915        :param envelope_id_stamping: The envelope_id_stamping of this EnvelopeTemplateResult.
 916        :type: str
 917        """
 918
 919        self._envelope_id_stamping = envelope_id_stamping
 920
 921    @property
 922    def envelope_uri(self):
 923        """
 924        Gets the envelope_uri of this EnvelopeTemplateResult.
 925        Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
 926
 927        :return: The envelope_uri of this EnvelopeTemplateResult.
 928        :rtype: str
 929        """
 930        return self._envelope_uri
 931
 932    @envelope_uri.setter
 933    def envelope_uri(self, envelope_uri):
 934        """
 935        Sets the envelope_uri of this EnvelopeTemplateResult.
 936        Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
 937
 938        :param envelope_uri: The envelope_uri of this EnvelopeTemplateResult.
 939        :type: str
 940        """
 941
 942        self._envelope_uri = envelope_uri
 943
 944    @property
 945    def folder_id(self):
 946        """
 947        Gets the folder_id of this EnvelopeTemplateResult.
 948        
 949
 950        :return: The folder_id of this EnvelopeTemplateResult.
 951        :rtype: str
 952        """
 953        return self._folder_id
 954
 955    @folder_id.setter
 956    def folder_id(self, folder_id):
 957        """
 958        Sets the folder_id of this EnvelopeTemplateResult.
 959        
 960
 961        :param folder_id: The folder_id of this EnvelopeTemplateResult.
 962        :type: str
 963        """
 964
 965        self._folder_id = folder_id
 966
 967    @property
 968    def folder_name(self):
 969        """
 970        Gets the folder_name of this EnvelopeTemplateResult.
 971        
 972
 973        :return: The folder_name of this EnvelopeTemplateResult.
 974        :rtype: str
 975        """
 976        return self._folder_name
 977
 978    @folder_name.setter
 979    def folder_name(self, folder_name):
 980        """
 981        Sets the folder_name of this EnvelopeTemplateResult.
 982        
 983
 984        :param folder_name: The folder_name of this EnvelopeTemplateResult.
 985        :type: str
 986        """
 987
 988        self._folder_name = folder_name
 989
 990    @property
 991    def folder_uri(self):
 992        """
 993        Gets the folder_uri of this EnvelopeTemplateResult.
 994        
 995
 996        :return: The folder_uri of this EnvelopeTemplateResult.
 997        :rtype: str
 998        """
 999        return self._folder_uri
1000
1001    @folder_uri.setter
1002    def folder_uri(self, folder_uri):
1003        """
1004        Sets the folder_uri of this EnvelopeTemplateResult.
1005        
1006
1007        :param folder_uri: The folder_uri of this EnvelopeTemplateResult.
1008        :type: str
1009        """
1010
1011        self._folder_uri = folder_uri
1012
1013    @property
1014    def initial_sent_date_time(self):
1015        """
1016        Gets the initial_sent_date_time of this EnvelopeTemplateResult.
1017        
1018
1019        :return: The initial_sent_date_time of this EnvelopeTemplateResult.
1020        :rtype: str
1021        """
1022        return self._initial_sent_date_time
1023
1024    @initial_sent_date_time.setter
1025    def initial_sent_date_time(self, initial_sent_date_time):
1026        """
1027        Sets the initial_sent_date_time of this EnvelopeTemplateResult.
1028        
1029
1030        :param initial_sent_date_time: The initial_sent_date_time of this EnvelopeTemplateResult.
1031        :type: str
1032        """
1033
1034        self._initial_sent_date_time = initial_sent_date_time
1035
1036    @property
1037    def is21_cfr_part11(self):
1038        """
1039        Gets the is21_cfr_part11 of this EnvelopeTemplateResult.
1040        When set to **true**, indicates that this module is enabled on the account.
1041
1042        :return: The is21_cfr_part11 of this EnvelopeTemplateResult.
1043        :rtype: str
1044        """
1045        return self._is21_cfr_part11
1046
1047    @is21_cfr_part11.setter
1048    def is21_cfr_part11(self, is21_cfr_part11):
1049        """
1050        Sets the is21_cfr_part11 of this EnvelopeTemplateResult.
1051        When set to **true**, indicates that this module is enabled on the account.
1052
1053        :param is21_cfr_part11: The is21_cfr_part11 of this EnvelopeTemplateResult.
1054        :type: str
1055        """
1056
1057        self._is21_cfr_part11 = is21_cfr_part11
1058
1059    @property
1060    def is_signature_provider_envelope(self):
1061        """
1062        Gets the is_signature_provider_envelope of this EnvelopeTemplateResult.
1063        
1064
1065        :return: The is_signature_provider_envelope of this EnvelopeTemplateResult.
1066        :rtype: str
1067        """
1068        return self._is_signature_provider_envelope
1069
1070    @is_signature_provider_envelope.setter
1071    def is_signature_provider_envelope(self, is_signature_provider_envelope):
1072        """
1073        Sets the is_signature_provider_envelope of this EnvelopeTemplateResult.
1074        
1075
1076        :param is_signature_provider_envelope: The is_signature_provider_envelope of this EnvelopeTemplateResult.
1077        :type: str
1078        """
1079
1080        self._is_signature_provider_envelope = is_signature_provider_envelope
1081
1082    @property
1083    def last_modified(self):
1084        """
1085        Gets the last_modified of this EnvelopeTemplateResult.
1086        
1087
1088        :return: The last_modified of this EnvelopeTemplateResult.
1089        :rtype: str
1090        """
1091        return self._last_modified
1092
1093    @last_modified.setter
1094    def last_modified(self, last_modified):
1095        """
1096        Sets the last_modified of this EnvelopeTemplateResult.
1097        
1098
1099        :param last_modified: The last_modified of this EnvelopeTemplateResult.
1100        :type: str
1101        """
1102
1103        self._last_modified = last_modified
1104
1105    @property
1106    def last_modified_date_time(self):
1107        """
1108        Gets the last_modified_date_time of this EnvelopeTemplateResult.
1109        The date and time the item was last modified.
1110
1111        :return: The last_modified_date_time of this EnvelopeTemplateResult.
1112        :rtype: str
1113        """
1114        return self._last_modified_date_time
1115
1116    @last_modified_date_time.setter
1117    def last_modified_date_time(self, last_modified_date_time):
1118        """
1119        Sets the last_modified_date_time of this EnvelopeTemplateResult.
1120        The date and time the item was last modified.
1121
1122        :param last_modified_date_time: The last_modified_date_time of this EnvelopeTemplateResult.
1123        :type: str
1124        """
1125
1126        self._last_modified_date_time = last_modified_date_time
1127
1128    @property
1129    def lock_information(self):
1130        """
1131        Gets the lock_information of this EnvelopeTemplateResult.
1132
1133        :return: The lock_information of this EnvelopeTemplateResult.
1134        :rtype: LockInformation
1135        """
1136        return self._lock_information
1137
1138    @lock_information.setter
1139    def lock_information(self, lock_information):
1140        """
1141        Sets the lock_information of this EnvelopeTemplateResult.
1142
1143        :param lock_information: The lock_information of this EnvelopeTemplateResult.
1144        :type: LockInformation
1145        """
1146
1147        self._lock_information = lock_information
1148
1149    @property
1150    def message_lock(self):
1151        """
1152        Gets the message_lock of this EnvelopeTemplateResult.
1153        When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.   Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.   However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
1154
1155        :return: The message_lock of this EnvelopeTemplateResult.
1156        :rtype: str
1157        """
1158        return self._message_lock
1159
1160    @message_lock.setter
1161    def message_lock(self, message_lock):
1162        """
1163        Sets the message_lock of this EnvelopeTemplateResult.
1164        When set to **true**, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope.   Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes.   However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.
1165
1166        :param message_lock: The message_lock of this EnvelopeTemplateResult.
1167        :type: str
1168        """
1169
1170        self._message_lock = message_lock
1171
1172    @property
1173    def name(self):
1174        """
1175        Gets the name of this EnvelopeTemplateResult.
1176        
1177
1178        :return: The name of this EnvelopeTemplateResult.
1179        :rtype: str
1180        """
1181        return self._name
1182
1183    @name.setter
1184    def name(self, name):
1185        """
1186        Sets the name of this EnvelopeTemplateResult.
1187        
1188
1189        :param name: The name of this EnvelopeTemplateResult.
1190        :type: str
1191        """
1192
1193        self._name = name
1194
1195    @property
1196    def notification(self):
1197        """
1198        Gets the notification of this EnvelopeTemplateResult.
1199
1200        :return: The notification of this EnvelopeTemplateResult.
1201        :rtype: Notification
1202        """
1203        return self._notification
1204
1205    @notification.setter
1206    def notification(self, notification):
1207        """
1208        Sets the notification of this EnvelopeTemplateResult.
1209
1210        :param notification: The notification of this EnvelopeTemplateResult.
1211        :type: Notification
1212        """
1213
1214        self._notification = notification
1215
1216    @property
1217    def notification_uri(self):
1218        """
1219        Gets the notification_uri of this EnvelopeTemplateResult.
1220        Contains a URI for an endpoint that you can use to retrieve the notifications.
1221
1222        :return: The notification_uri of this EnvelopeTemplateResult.
1223        :rtype: str
1224        """
1225        return self._notification_uri
1226
1227    @notification_uri.setter
1228    def notification_uri(self, notification_uri):
1229        """
1230        Sets the notification_uri of this EnvelopeTemplateResult.
1231        Contains a URI for an endpoint that you can use to retrieve the notifications.
1232
1233        :param notification_uri: The notification_uri of this EnvelopeTemplateResult.
1234        :type: str
1235        """
1236
1237        self._notification_uri = notification_uri
1238
1239    @property
1240    def owner(self):
1241        """
1242        Gets the owner of this EnvelopeTemplateResult.
1243
1244        :return: The owner of this EnvelopeTemplateResult.
1245        :rtype: UserInfo
1246        """
1247        return self._owner
1248
1249    @owner.setter
1250    def owner(self, owner):
1251        """
1252        Sets the owner of this EnvelopeTemplateResult.
1253
1254        :param owner: The owner of this EnvelopeTemplateResult.
1255        :type: UserInfo
1256        """
1257
1258        self._owner = owner
1259
1260    @property
1261    def page_count(self):
1262        """
1263        Gets the page_count of this EnvelopeTemplateResult.
1264        
1265
1266        :return: The page_count of this EnvelopeTemplateResult.
1267        :rtype: int
1268        """
1269        return self._page_count
1270
1271    @page_count.setter
1272    def page_count(self, page_count):
1273        """
1274        Sets the page_count of this EnvelopeTemplateResult.
1275        
1276
1277        :param page_count: The page_count of this EnvelopeTemplateResult.
1278        :type: int
1279        """
1280
1281        self._page_count = page_count
1282
1283    @property
1284    def parent_folder_uri(self):
1285        """
1286        Gets the parent_folder_uri of this EnvelopeTemplateResult.
1287        
1288
1289        :return: The parent_folder_uri of this EnvelopeTemplateResult.
1290        :rtype: str
1291        """
1292        return self._parent_folder_uri
1293
1294    @parent_folder_uri.setter
1295    def parent_folder_uri(self, parent_folder_uri):
1296        """
1297        Sets the parent_folder_uri of this EnvelopeTemplateResult.
1298        
1299
1300        :param parent_folder_uri: The parent_folder_uri of this EnvelopeTemplateResult.
1301        :type: str
1302        """
1303
1304        self._parent_folder_uri = parent_folder_uri
1305
1306    @property
1307    def password(self):
1308        """
1309        Gets the password of this EnvelopeTemplateResult.
1310        
1311
1312        :return: The password of this EnvelopeTemplateResult.
1313        :rtype: str
1314        """
1315        return self._password
1316
1317    @password.setter
1318    def password(self, password):
1319        """
1320        Sets the password of this EnvelopeTemplateResult.
1321        
1322
1323        :param password: The password of this EnvelopeTemplateResult.
1324        :type: str
1325        """
1326
1327        self._password = password
1328
1329    @property
1330    def purge_state(self):
1331        """
1332        Gets the purge_state of this EnvelopeTemplateResult.
1333        
1334
1335        :return: The purge_state of this EnvelopeTemplateResult.
1336        :rtype: str
1337        """
1338        return self._purge_state
1339
1340    @purge_state.setter
1341    def purge_state(self, purge_state):
1342        """
1343        Sets the purge_state of this EnvelopeTemplateResult.
1344        
1345
1346        :param purge_state: The purge_state of this EnvelopeTemplateResult.
1347        :type: str
1348        """
1349
1350        self._purge_state = purge_state
1351
1352    @property
1353    def recipients(self):
1354        """
1355        Gets the recipients of this EnvelopeTemplateResult.
1356
1357        :return: The recipients of this EnvelopeTemplateResult.
1358        :rtype: Recipients
1359        """
1360        return self._recipients
1361
1362    @recipients.setter
1363    def recipients(self, recipients):
1364        """
1365        Sets the recipients of this EnvelopeTemplateResult.
1366
1367        :param recipients: The recipients of this EnvelopeTemplateResult.
1368        :type: Recipients
1369        """
1370
1371        self._recipients = recipients
1372
1373    @property
1374    def recipients_lock(self):
1375        """
1376        Gets the recipients_lock of this EnvelopeTemplateResult.
1377        When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
1378
1379        :return: The recipients_lock of this EnvelopeTemplateResult.
1380        :rtype: str
1381        """
1382        return self._recipients_lock
1383
1384    @recipients_lock.setter
1385    def recipients_lock(self, recipients_lock):
1386        """
1387        Sets the recipients_lock of this EnvelopeTemplateResult.
1388        When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
1389
1390        :param recipients_lock: The recipients_lock of this EnvelopeTemplateResult.
1391        :type: str
1392        """
1393
1394        self._recipients_lock = recipients_lock
1395
1396    @property
1397    def recipients_uri(self):
1398        """
1399        Gets the recipients_uri of this EnvelopeTemplateResult.
1400        Contains a URI for an endpoint that you can use to retrieve the recipients.
1401
1402        :return: The recipients_uri of this EnvelopeTemplateResult.
1403        :rtype: str
1404        """
1405        return self._recipients_uri
1406
1407    @recipients_uri.setter
1408    def recipients_uri(self, recipients_uri):
1409        """
1410        Sets the recipients_uri of this EnvelopeTemplateResult.
1411        Contains a URI for an endpoint that you can use to retrieve the recipients.
1412
1413        :param recipients_uri: The recipients_uri of this EnvelopeTemplateResult.
1414        :type: str
1415        """
1416
1417        self._recipients_uri = recipients_uri
1418
1419    @property
1420    def sent_date_time(self):
1421        """
1422        Gets the sent_date_time of this EnvelopeTemplateResult.
1423        The date and time the envelope was sent.
1424
1425        :return: The sent_date_time of this EnvelopeTemplateResult.
1426        :rtype: str
1427        """
1428        return self._sent_date_time
1429
1430    @sent_date_time.setter
1431    def sent_date_time(self, sent_date_time):
1432        """
1433        Sets the sent_date_time of this EnvelopeTemplateResult.
1434        The date and time the envelope was sent.
1435
1436        :param sent_date_time: The sent_date_time of this EnvelopeTemplateResult.
1437        :type: str
1438        """
1439
1440        self._sent_date_time = sent_date_time
1441
1442    @property
1443    def shared(self):
1444        """
1445        Gets the shared of this EnvelopeTemplateResult.
1446        When set to **true**, this custom tab is shared.
1447
1448        :return: The shared of this EnvelopeTemplateResult.
1449        :rtype: str
1450        """
1451        return self._shared
1452
1453    @shared.setter
1454    def shared(self, shared):
1455        """
1456        Sets the shared of this EnvelopeTemplateResult.
1457        When set to **true**, this custom tab is shared.
1458
1459        :param shared: The shared of this EnvelopeTemplateResult.
1460        :type: str
1461        """
1462
1463        self._shared = shared
1464
1465    @property
1466    def signer_can_sign_on_mobile(self):
1467        """
1468        Gets the signer_can_sign_on_mobile of this EnvelopeTemplateResult.
1469        
1470
1471        :return: The signer_can_sign_on_mobile of this EnvelopeTemplateResult.
1472        :rtype: str
1473        """
1474        return self._signer_can_sign_on_mobile
1475
1476    @signer_can_sign_on_mobile.setter
1477    def signer_can_sign_on_mobile(self, signer_can_sign_on_mobile):
1478        """
1479        Sets the signer_can_sign_on_mobile of this EnvelopeTemplateResult.
1480        
1481
1482        :param signer_can_sign_on_mobile: The signer_can_sign_on_mobile of this EnvelopeTemplateResult.
1483        :type: str
1484        """
1485
1486        self._signer_can_sign_on_mobile = signer_can_sign_on_mobile
1487
1488    @property
1489    def signing_location(self):
1490        """
1491        Gets the signing_location of this EnvelopeTemplateResult.
1492        Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
1493
1494        :return: The signing_location of this EnvelopeTemplateResult.
1495        :rtype: str
1496        """
1497        return self._signing_location
1498
1499    @signing_location.setter
1500    def signing_location(self, signing_location):
1501        """
1502        Sets the signing_location of this EnvelopeTemplateResult.
1503        Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.
1504
1505        :param signing_location: The signing_location of this EnvelopeTemplateResult.
1506        :type: str
1507        """
1508
1509        self._signing_location = signing_location
1510
1511    @property
1512    def status(self):
1513        """
1514        Gets the status of this EnvelopeTemplateResult.
1515        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
1516
1517        :return: The status of this EnvelopeTemplateResult.
1518        :rtype: str
1519        """
1520        return self._status
1521
1522    @status.setter
1523    def status(self, status):
1524        """
1525        Sets the status of this EnvelopeTemplateResult.
1526        Indicates the envelope status. Valid values are:  * sent - The envelope is sent to the recipients.  * created - The envelope is saved as a draft and can be modified and sent later.
1527
1528        :param status: The status of this EnvelopeTemplateResult.
1529        :type: str
1530        """
1531
1532        self._status = status
1533
1534    @property
1535    def status_changed_date_time(self):
1536        """
1537        Gets the status_changed_date_time of this EnvelopeTemplateResult.
1538        The data and time the status changed.
1539
1540        :return: The status_changed_date_time of this EnvelopeTemplateResult.
1541        :rtype: str
1542        """
1543        return self._status_changed_date_time
1544
1545    @status_changed_date_time.setter
1546    def status_changed_date_time(self, status_changed_date_time):
1547        """
1548        Sets the status_changed_date_time of this EnvelopeTemplateResult.
1549        The data and time the status changed.
1550
1551        :param status_changed_date_time: The status_changed_date_time of this EnvelopeTemplateResult.
1552        :type: str
1553        """
1554
1555        self._status_changed_date_time = status_changed_date_time
1556
1557    @property
1558    def template_id(self):
1559        """
1560        Gets the template_id of this EnvelopeTemplateResult.
1561        The unique identifier of the template. If this is not provided, DocuSign will generate a value. 
1562
1563        :return: The template_id of this EnvelopeTemplateResult.
1564        :rtype: str
1565        """
1566        return self._template_id
1567
1568    @template_id.setter
1569    def template_id(self, template_id):
1570        """
1571        Sets the template_id of this EnvelopeTemplateResult.
1572        The unique identifier of the template. If this is not provided, DocuSign will generate a value. 
1573
1574        :param template_id: The template_id of this EnvelopeTemplateResult.
1575        :type: str
1576        """
1577
1578        self._template_id = template_id
1579
1580    @property
1581    def templates_uri(self):
1582        """
1583        Gets the templates_uri of this EnvelopeTemplateResult.
1584        Contains a URI for an endpoint which you can use to retrieve the templates.
1585
1586        :return: The templates_uri of this EnvelopeTemplateResult.
1587        :rtype: str
1588        """
1589        return self._templates_uri
1590
1591    @templates_uri.setter
1592    def templates_uri(self, templates_uri):
1593        """
1594        Sets the templates_uri of this EnvelopeTemplateResult.
1595        Contains a URI for an endpoint which you can use to retrieve the templates.
1596
1597        :param templates_uri: The templates_uri of this EnvelopeTemplateResult.
1598        :type: str
1599        """
1600
1601        self._templates_uri = templates_uri
1602
1603    @property
1604    def transaction_id(self):
1605        """
1606        Gets the transaction_id of this EnvelopeTemplateResult.
1607         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
1608
1609        :return: The transaction_id of this EnvelopeTemplateResult.
1610        :rtype: str
1611        """
1612        return self._transaction_id
1613
1614    @transaction_id.setter
1615    def transaction_id(self, transaction_id):
1616        """
1617        Sets the transaction_id of this EnvelopeTemplateResult.
1618         Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.
1619
1620        :param transaction_id: The transaction_id of this EnvelopeTemplateResult.
1621        :type: str
1622        """
1623
1624        self._transaction_id = transaction_id
1625
1626    @property
1627    def uri(self):
1628        """
1629        Gets the uri of this EnvelopeTemplateResult.
1630        
1631
1632        :return: The uri of this EnvelopeTemplateResult.
1633        :rtype: str
1634        """
1635        return self._uri
1636
1637    @uri.setter
1638    def uri(self, uri):
1639        """
1640        Sets the uri of this EnvelopeTemplateResult.
1641        
1642
1643        :param uri: The uri of this EnvelopeTemplateResult.
1644        :type: str
1645        """
1646
1647        self._uri = uri
1648
1649    @property
1650    def use_disclosure(self):
1651        """
1652        Gets the use_disclosure of this EnvelopeTemplateResult.
1653        When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients.   If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
1654
1655        :return: The use_disclosure of this EnvelopeTemplateResult.
1656        :rtype: str
1657        """
1658        return self._use_disclosure
1659
1660    @use_disclosure.setter
1661    def use_disclosure(self, use_disclosure):
1662        """
1663        Sets the use_disclosure of this EnvelopeTemplateResult.
1664        When set to **true**, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to **false**, the Electronic Record and Signature Disclosure is not shown to any envelope recipients.   If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.
1665
1666        :param use_disclosure: The use_disclosure of this EnvelopeTemplateResult.
1667        :type: str
1668        """
1669
1670        self._use_disclosure = use_disclosure
1671
1672    @property
1673    def voided_date_time(self):
1674        """
1675        Gets the voided_date_time of this EnvelopeTemplateResult.
1676        The date and time the envelope or template was voided.
1677
1678        :return: The voided_date_time of this EnvelopeTemplateResult.
1679        :rtype: str
1680        """
1681        return self._voided_date_time
1682
1683    @voided_date_time.setter
1684    def voided_date_time(self, voided_date_time):
1685        """
1686        Sets the voided_date_time of this EnvelopeTemplateResult.
1687        The date and time the envelope or template was voided.
1688
1689        :param voided_date_time: The voided_date_time of this EnvelopeTemplateResult.
1690        :type: str
1691        """
1692
1693        self._voided_date_time = voided_date_time
1694
1695    @property
1696    def voided_reason(self):
1697        """
1698        Gets the voided_reason of this EnvelopeTemplateResult.
1699        The reason the envelope or template was voided.
1700
1701        :return: The voided_reason of this EnvelopeTemplateResult.
1702        :rtype: str
1703        """
1704        return self._voided_reason
1705
1706    @voided_reason.setter
1707    def voided_reason(self, voided_reason):
1708        """
1709        Sets the voided_reason of this EnvelopeTemplateResult.
1710        The reason the envelope or template was voided.
1711
1712        :param voided_reason: The voided_reason of this EnvelopeTemplateResult.
1713        :type: str
1714        """
1715
1716        self._voided_reason = voided_reason
1717
1718    def to_dict(self):
1719        """
1720        Returns the model properties as a dict
1721        """
1722        result = {}
1723
1724        for attr, _ in iteritems(self.swagger_types):
1725            value = getattr(self, attr)
1726            if isinstance(value, list):
1727                result[attr] = list(map(
1728                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
1729                    value
1730                ))
1731            elif hasattr(value, "to_dict"):
1732                result[attr] = value.to_dict()
1733            elif isinstance(value, dict):
1734                result[attr] = dict(map(
1735                    lambda item: (item[0], item[1].to_dict())
1736                    if hasattr(item[1], "to_dict") else item,
1737                    value.items()
1738                ))
1739            else:
1740                result[attr] = value
1741
1742        return result
1743
1744    def to_str(self):
1745        """
1746        Returns the string representation of the model
1747        """
1748        return pformat(self.to_dict())
1749
1750    def __repr__(self):
1751        """
1752        For `print` and `pprint`
1753        """
1754        return self.to_str()
1755
1756    def __eq__(self, other):
1757        """
1758        Returns true if both objects are equal
1759        """
1760        return self.__dict__ == other.__dict__
1761
1762    def __ne__(self, other):
1763        """
1764        Returns true if both objects are not equal
1765        """
1766        return not self == other