docusign_esign.models.envelope
DocuSign REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 DocuSign REST API 5 6 The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class Envelope(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 'access_control_list_base64': 'str', 37 'allow_comments': 'str', 38 'allow_markup': 'str', 39 'allow_reassign': 'str', 40 'allow_view_history': 'str', 41 'any_signer': 'str', 42 'asynchronous': 'str', 43 'attachments_uri': 'str', 44 'authoritative_copy': 'str', 45 'authoritative_copy_default': 'str', 46 'auto_navigation': 'str', 47 'brand_id': 'str', 48 'brand_lock': 'str', 49 'burn_default_tab_data': 'str', 50 'certificate_uri': 'str', 51 'completed_date_time': 'str', 52 'copy_recipient_data': 'str', 53 'created_date_time': 'str', 54 'custom_fields': 'CustomFields', 55 'custom_fields_uri': 'str', 56 'declined_date_time': 'str', 57 'deleted_date_time': 'str', 58 'delivered_date_time': 'str', 59 'disable_responsive_document': 'str', 60 'document_base64': 'str', 61 'documents_combined_uri': 'str', 62 'documents_uri': 'str', 63 'email_blurb': 'str', 64 'email_settings': 'EmailSettings', 65 'email_subject': 'str', 66 'enable_wet_sign': 'str', 67 'enforce_signer_visibility': 'str', 68 'envelope_attachments': 'list[Attachment]', 69 'envelope_custom_metadata': 'EnvelopeCustomMetadata', 70 'envelope_documents': 'list[EnvelopeDocument]', 71 'envelope_id': 'str', 72 'envelope_id_stamping': 'str', 73 'envelope_location': 'str', 74 'envelope_metadata': 'EnvelopeMetadata', 75 'envelope_uri': 'str', 76 'expire_after': 'str', 77 'expire_date_time': 'str', 78 'expire_enabled': 'str', 79 'external_envelope_id': 'str', 80 'folders': 'list[Folder]', 81 'has_comments': 'str', 82 'has_form_data_changed': 'str', 83 'has_wav_file': 'str', 84 'holder': 'str', 85 'initial_sent_date_time': 'str', 86 'is21_cfr_part11': 'str', 87 'is_dynamic_envelope': 'str', 88 'is_signature_provider_envelope': 'str', 89 'last_modified_date_time': 'str', 90 'location': 'str', 91 'lock_information': 'LockInformation', 92 'message_lock': 'str', 93 'notification': 'Notification', 94 'notification_uri': 'str', 95 'power_form': 'PowerForm', 96 'purge_completed_date': 'str', 97 'purge_request_date': 'str', 98 'purge_state': 'str', 99 'recipients': 'Recipients', 100 'recipients_lock': 'str', 101 'recipients_uri': 'str', 102 'sender': 'UserInfo', 103 'sent_date_time': 'str', 104 'signer_can_sign_on_mobile': 'str', 105 'signing_location': 'str', 106 'status': 'str', 107 'status_changed_date_time': 'str', 108 'status_date_time': 'str', 109 'templates_uri': 'str', 110 'transaction_id': 'str', 111 'use_disclosure': 'str', 112 'voided_date_time': 'str', 113 'voided_reason': 'str', 114 'workflow': 'Workflow' 115 } 116 117 attribute_map = { 118 'access_control_list_base64': 'accessControlListBase64', 119 'allow_comments': 'allowComments', 120 'allow_markup': 'allowMarkup', 121 'allow_reassign': 'allowReassign', 122 'allow_view_history': 'allowViewHistory', 123 'any_signer': 'anySigner', 124 'asynchronous': 'asynchronous', 125 'attachments_uri': 'attachmentsUri', 126 'authoritative_copy': 'authoritativeCopy', 127 'authoritative_copy_default': 'authoritativeCopyDefault', 128 'auto_navigation': 'autoNavigation', 129 'brand_id': 'brandId', 130 'brand_lock': 'brandLock', 131 'burn_default_tab_data': 'burnDefaultTabData', 132 'certificate_uri': 'certificateUri', 133 'completed_date_time': 'completedDateTime', 134 'copy_recipient_data': 'copyRecipientData', 135 'created_date_time': 'createdDateTime', 136 'custom_fields': 'customFields', 137 'custom_fields_uri': 'customFieldsUri', 138 'declined_date_time': 'declinedDateTime', 139 'deleted_date_time': 'deletedDateTime', 140 'delivered_date_time': 'deliveredDateTime', 141 'disable_responsive_document': 'disableResponsiveDocument', 142 'document_base64': 'documentBase64', 143 'documents_combined_uri': 'documentsCombinedUri', 144 'documents_uri': 'documentsUri', 145 'email_blurb': 'emailBlurb', 146 'email_settings': 'emailSettings', 147 'email_subject': 'emailSubject', 148 'enable_wet_sign': 'enableWetSign', 149 'enforce_signer_visibility': 'enforceSignerVisibility', 150 'envelope_attachments': 'envelopeAttachments', 151 'envelope_custom_metadata': 'envelopeCustomMetadata', 152 'envelope_documents': 'envelopeDocuments', 153 'envelope_id': 'envelopeId', 154 'envelope_id_stamping': 'envelopeIdStamping', 155 'envelope_location': 'envelopeLocation', 156 'envelope_metadata': 'envelopeMetadata', 157 'envelope_uri': 'envelopeUri', 158 'expire_after': 'expireAfter', 159 'expire_date_time': 'expireDateTime', 160 'expire_enabled': 'expireEnabled', 161 'external_envelope_id': 'externalEnvelopeId', 162 'folders': 'folders', 163 'has_comments': 'hasComments', 164 'has_form_data_changed': 'hasFormDataChanged', 165 'has_wav_file': 'hasWavFile', 166 'holder': 'holder', 167 'initial_sent_date_time': 'initialSentDateTime', 168 'is21_cfr_part11': 'is21CFRPart11', 169 'is_dynamic_envelope': 'isDynamicEnvelope', 170 'is_signature_provider_envelope': 'isSignatureProviderEnvelope', 171 'last_modified_date_time': 'lastModifiedDateTime', 172 'location': 'location', 173 'lock_information': 'lockInformation', 174 'message_lock': 'messageLock', 175 'notification': 'notification', 176 'notification_uri': 'notificationUri', 177 'power_form': 'powerForm', 178 'purge_completed_date': 'purgeCompletedDate', 179 'purge_request_date': 'purgeRequestDate', 180 'purge_state': 'purgeState', 181 'recipients': 'recipients', 182 'recipients_lock': 'recipientsLock', 183 'recipients_uri': 'recipientsUri', 184 'sender': 'sender', 185 'sent_date_time': 'sentDateTime', 186 'signer_can_sign_on_mobile': 'signerCanSignOnMobile', 187 'signing_location': 'signingLocation', 188 'status': 'status', 189 'status_changed_date_time': 'statusChangedDateTime', 190 'status_date_time': 'statusDateTime', 191 'templates_uri': 'templatesUri', 192 'transaction_id': 'transactionId', 193 'use_disclosure': 'useDisclosure', 194 'voided_date_time': 'voidedDateTime', 195 'voided_reason': 'voidedReason', 196 'workflow': 'workflow' 197 } 198 199 def __init__(self, _configuration=None, **kwargs): # noqa: E501 200 """Envelope - a model defined in Swagger""" # noqa: E501 201 if _configuration is None: 202 _configuration = Configuration() 203 self._configuration = _configuration 204 205 self._access_control_list_base64 = None 206 self._allow_comments = None 207 self._allow_markup = None 208 self._allow_reassign = None 209 self._allow_view_history = None 210 self._any_signer = None 211 self._asynchronous = None 212 self._attachments_uri = None 213 self._authoritative_copy = None 214 self._authoritative_copy_default = None 215 self._auto_navigation = None 216 self._brand_id = None 217 self._brand_lock = None 218 self._burn_default_tab_data = None 219 self._certificate_uri = None 220 self._completed_date_time = None 221 self._copy_recipient_data = None 222 self._created_date_time = None 223 self._custom_fields = None 224 self._custom_fields_uri = None 225 self._declined_date_time = None 226 self._deleted_date_time = None 227 self._delivered_date_time = None 228 self._disable_responsive_document = None 229 self._document_base64 = None 230 self._documents_combined_uri = None 231 self._documents_uri = None 232 self._email_blurb = None 233 self._email_settings = None 234 self._email_subject = None 235 self._enable_wet_sign = None 236 self._enforce_signer_visibility = None 237 self._envelope_attachments = None 238 self._envelope_custom_metadata = None 239 self._envelope_documents = None 240 self._envelope_id = None 241 self._envelope_id_stamping = None 242 self._envelope_location = None 243 self._envelope_metadata = None 244 self._envelope_uri = None 245 self._expire_after = None 246 self._expire_date_time = None 247 self._expire_enabled = None 248 self._external_envelope_id = None 249 self._folders = None 250 self._has_comments = None 251 self._has_form_data_changed = None 252 self._has_wav_file = None 253 self._holder = None 254 self._initial_sent_date_time = None 255 self._is21_cfr_part11 = None 256 self._is_dynamic_envelope = None 257 self._is_signature_provider_envelope = None 258 self._last_modified_date_time = None 259 self._location = None 260 self._lock_information = None 261 self._message_lock = None 262 self._notification = None 263 self._notification_uri = None 264 self._power_form = None 265 self._purge_completed_date = None 266 self._purge_request_date = None 267 self._purge_state = None 268 self._recipients = None 269 self._recipients_lock = None 270 self._recipients_uri = None 271 self._sender = None 272 self._sent_date_time = None 273 self._signer_can_sign_on_mobile = None 274 self._signing_location = None 275 self._status = None 276 self._status_changed_date_time = None 277 self._status_date_time = None 278 self._templates_uri = None 279 self._transaction_id = None 280 self._use_disclosure = None 281 self._voided_date_time = None 282 self._voided_reason = None 283 self._workflow = None 284 self.discriminator = None 285 286 setattr(self, "_{}".format('access_control_list_base64'), kwargs.get('access_control_list_base64', None)) 287 setattr(self, "_{}".format('allow_comments'), kwargs.get('allow_comments', None)) 288 setattr(self, "_{}".format('allow_markup'), kwargs.get('allow_markup', None)) 289 setattr(self, "_{}".format('allow_reassign'), kwargs.get('allow_reassign', None)) 290 setattr(self, "_{}".format('allow_view_history'), kwargs.get('allow_view_history', None)) 291 setattr(self, "_{}".format('any_signer'), kwargs.get('any_signer', None)) 292 setattr(self, "_{}".format('asynchronous'), kwargs.get('asynchronous', None)) 293 setattr(self, "_{}".format('attachments_uri'), kwargs.get('attachments_uri', None)) 294 setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) 295 setattr(self, "_{}".format('authoritative_copy_default'), kwargs.get('authoritative_copy_default', None)) 296 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 297 setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None)) 298 setattr(self, "_{}".format('brand_lock'), kwargs.get('brand_lock', None)) 299 setattr(self, "_{}".format('burn_default_tab_data'), kwargs.get('burn_default_tab_data', None)) 300 setattr(self, "_{}".format('certificate_uri'), kwargs.get('certificate_uri', None)) 301 setattr(self, "_{}".format('completed_date_time'), kwargs.get('completed_date_time', None)) 302 setattr(self, "_{}".format('copy_recipient_data'), kwargs.get('copy_recipient_data', None)) 303 setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None)) 304 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 305 setattr(self, "_{}".format('custom_fields_uri'), kwargs.get('custom_fields_uri', None)) 306 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 307 setattr(self, "_{}".format('deleted_date_time'), kwargs.get('deleted_date_time', None)) 308 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 309 setattr(self, "_{}".format('disable_responsive_document'), kwargs.get('disable_responsive_document', None)) 310 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 311 setattr(self, "_{}".format('documents_combined_uri'), kwargs.get('documents_combined_uri', None)) 312 setattr(self, "_{}".format('documents_uri'), kwargs.get('documents_uri', None)) 313 setattr(self, "_{}".format('email_blurb'), kwargs.get('email_blurb', None)) 314 setattr(self, "_{}".format('email_settings'), kwargs.get('email_settings', None)) 315 setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None)) 316 setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None)) 317 setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None)) 318 setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None)) 319 setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None)) 320 setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None)) 321 setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None)) 322 setattr(self, "_{}".format('envelope_id_stamping'), kwargs.get('envelope_id_stamping', None)) 323 setattr(self, "_{}".format('envelope_location'), kwargs.get('envelope_location', None)) 324 setattr(self, "_{}".format('envelope_metadata'), kwargs.get('envelope_metadata', None)) 325 setattr(self, "_{}".format('envelope_uri'), kwargs.get('envelope_uri', None)) 326 setattr(self, "_{}".format('expire_after'), kwargs.get('expire_after', None)) 327 setattr(self, "_{}".format('expire_date_time'), kwargs.get('expire_date_time', None)) 328 setattr(self, "_{}".format('expire_enabled'), kwargs.get('expire_enabled', None)) 329 setattr(self, "_{}".format('external_envelope_id'), kwargs.get('external_envelope_id', None)) 330 setattr(self, "_{}".format('folders'), kwargs.get('folders', None)) 331 setattr(self, "_{}".format('has_comments'), kwargs.get('has_comments', None)) 332 setattr(self, "_{}".format('has_form_data_changed'), kwargs.get('has_form_data_changed', None)) 333 setattr(self, "_{}".format('has_wav_file'), kwargs.get('has_wav_file', None)) 334 setattr(self, "_{}".format('holder'), kwargs.get('holder', None)) 335 setattr(self, "_{}".format('initial_sent_date_time'), kwargs.get('initial_sent_date_time', None)) 336 setattr(self, "_{}".format('is21_cfr_part11'), kwargs.get('is21_cfr_part11', None)) 337 setattr(self, "_{}".format('is_dynamic_envelope'), kwargs.get('is_dynamic_envelope', None)) 338 setattr(self, "_{}".format('is_signature_provider_envelope'), kwargs.get('is_signature_provider_envelope', None)) 339 setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None)) 340 setattr(self, "_{}".format('location'), kwargs.get('location', None)) 341 setattr(self, "_{}".format('lock_information'), kwargs.get('lock_information', None)) 342 setattr(self, "_{}".format('message_lock'), kwargs.get('message_lock', None)) 343 setattr(self, "_{}".format('notification'), kwargs.get('notification', None)) 344 setattr(self, "_{}".format('notification_uri'), kwargs.get('notification_uri', None)) 345 setattr(self, "_{}".format('power_form'), kwargs.get('power_form', None)) 346 setattr(self, "_{}".format('purge_completed_date'), kwargs.get('purge_completed_date', None)) 347 setattr(self, "_{}".format('purge_request_date'), kwargs.get('purge_request_date', None)) 348 setattr(self, "_{}".format('purge_state'), kwargs.get('purge_state', None)) 349 setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None)) 350 setattr(self, "_{}".format('recipients_lock'), kwargs.get('recipients_lock', None)) 351 setattr(self, "_{}".format('recipients_uri'), kwargs.get('recipients_uri', None)) 352 setattr(self, "_{}".format('sender'), kwargs.get('sender', None)) 353 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 354 setattr(self, "_{}".format('signer_can_sign_on_mobile'), kwargs.get('signer_can_sign_on_mobile', None)) 355 setattr(self, "_{}".format('signing_location'), kwargs.get('signing_location', None)) 356 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 357 setattr(self, "_{}".format('status_changed_date_time'), kwargs.get('status_changed_date_time', None)) 358 setattr(self, "_{}".format('status_date_time'), kwargs.get('status_date_time', None)) 359 setattr(self, "_{}".format('templates_uri'), kwargs.get('templates_uri', None)) 360 setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None)) 361 setattr(self, "_{}".format('use_disclosure'), kwargs.get('use_disclosure', None)) 362 setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None)) 363 setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None)) 364 setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None)) 365 366 @property 367 def access_control_list_base64(self): 368 """Gets the access_control_list_base64 of this Envelope. # noqa: E501 369 370 # noqa: E501 371 372 :return: The access_control_list_base64 of this Envelope. # noqa: E501 373 :rtype: str 374 """ 375 return self._access_control_list_base64 376 377 @access_control_list_base64.setter 378 def access_control_list_base64(self, access_control_list_base64): 379 """Sets the access_control_list_base64 of this Envelope. 380 381 # noqa: E501 382 383 :param access_control_list_base64: The access_control_list_base64 of this Envelope. # noqa: E501 384 :type: str 385 """ 386 387 self._access_control_list_base64 = access_control_list_base64 388 389 @property 390 def allow_comments(self): 391 """Gets the allow_comments of this Envelope. # noqa: E501 392 393 # noqa: E501 394 395 :return: The allow_comments of this Envelope. # noqa: E501 396 :rtype: str 397 """ 398 return self._allow_comments 399 400 @allow_comments.setter 401 def allow_comments(self, allow_comments): 402 """Sets the allow_comments of this Envelope. 403 404 # noqa: E501 405 406 :param allow_comments: The allow_comments of this Envelope. # noqa: E501 407 :type: str 408 """ 409 410 self._allow_comments = allow_comments 411 412 @property 413 def allow_markup(self): 414 """Gets the allow_markup of this Envelope. # noqa: E501 415 416 When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501 417 418 :return: The allow_markup of this Envelope. # noqa: E501 419 :rtype: str 420 """ 421 return self._allow_markup 422 423 @allow_markup.setter 424 def allow_markup(self, allow_markup): 425 """Sets the allow_markup of this Envelope. 426 427 When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501 428 429 :param allow_markup: The allow_markup of this Envelope. # noqa: E501 430 :type: str 431 """ 432 433 self._allow_markup = allow_markup 434 435 @property 436 def allow_reassign(self): 437 """Gets the allow_reassign of this Envelope. # noqa: E501 438 439 When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501 440 441 :return: The allow_reassign of this Envelope. # noqa: E501 442 :rtype: str 443 """ 444 return self._allow_reassign 445 446 @allow_reassign.setter 447 def allow_reassign(self, allow_reassign): 448 """Sets the allow_reassign of this Envelope. 449 450 When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501 451 452 :param allow_reassign: The allow_reassign of this Envelope. # noqa: E501 453 :type: str 454 """ 455 456 self._allow_reassign = allow_reassign 457 458 @property 459 def allow_view_history(self): 460 """Gets the allow_view_history of this Envelope. # noqa: E501 461 462 # noqa: E501 463 464 :return: The allow_view_history of this Envelope. # noqa: E501 465 :rtype: str 466 """ 467 return self._allow_view_history 468 469 @allow_view_history.setter 470 def allow_view_history(self, allow_view_history): 471 """Sets the allow_view_history of this Envelope. 472 473 # noqa: E501 474 475 :param allow_view_history: The allow_view_history of this Envelope. # noqa: E501 476 :type: str 477 """ 478 479 self._allow_view_history = allow_view_history 480 481 @property 482 def any_signer(self): 483 """Gets the any_signer of this Envelope. # noqa: E501 484 485 # noqa: E501 486 487 :return: The any_signer of this Envelope. # noqa: E501 488 :rtype: str 489 """ 490 return self._any_signer 491 492 @any_signer.setter 493 def any_signer(self, any_signer): 494 """Sets the any_signer of this Envelope. 495 496 # noqa: E501 497 498 :param any_signer: The any_signer of this Envelope. # noqa: E501 499 :type: str 500 """ 501 502 self._any_signer = any_signer 503 504 @property 505 def asynchronous(self): 506 """Gets the asynchronous of this Envelope. # noqa: E501 507 508 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. # noqa: E501 509 510 :return: The asynchronous of this Envelope. # noqa: E501 511 :rtype: str 512 """ 513 return self._asynchronous 514 515 @asynchronous.setter 516 def asynchronous(self, asynchronous): 517 """Sets the asynchronous of this Envelope. 518 519 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. # noqa: E501 520 521 :param asynchronous: The asynchronous of this Envelope. # noqa: E501 522 :type: str 523 """ 524 525 self._asynchronous = asynchronous 526 527 @property 528 def attachments_uri(self): 529 """Gets the attachments_uri of this Envelope. # noqa: E501 530 531 # noqa: E501 532 533 :return: The attachments_uri of this Envelope. # noqa: E501 534 :rtype: str 535 """ 536 return self._attachments_uri 537 538 @attachments_uri.setter 539 def attachments_uri(self, attachments_uri): 540 """Sets the attachments_uri of this Envelope. 541 542 # noqa: E501 543 544 :param attachments_uri: The attachments_uri of this Envelope. # noqa: E501 545 :type: str 546 """ 547 548 self._attachments_uri = attachments_uri 549 550 @property 551 def authoritative_copy(self): 552 """Gets the authoritative_copy of this Envelope. # noqa: E501 553 554 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 555 556 :return: The authoritative_copy of this Envelope. # noqa: E501 557 :rtype: str 558 """ 559 return self._authoritative_copy 560 561 @authoritative_copy.setter 562 def authoritative_copy(self, authoritative_copy): 563 """Sets the authoritative_copy of this Envelope. 564 565 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 566 567 :param authoritative_copy: The authoritative_copy of this Envelope. # noqa: E501 568 :type: str 569 """ 570 571 self._authoritative_copy = authoritative_copy 572 573 @property 574 def authoritative_copy_default(self): 575 """Gets the authoritative_copy_default of this Envelope. # noqa: E501 576 577 # noqa: E501 578 579 :return: The authoritative_copy_default of this Envelope. # noqa: E501 580 :rtype: str 581 """ 582 return self._authoritative_copy_default 583 584 @authoritative_copy_default.setter 585 def authoritative_copy_default(self, authoritative_copy_default): 586 """Sets the authoritative_copy_default of this Envelope. 587 588 # noqa: E501 589 590 :param authoritative_copy_default: The authoritative_copy_default of this Envelope. # noqa: E501 591 :type: str 592 """ 593 594 self._authoritative_copy_default = authoritative_copy_default 595 596 @property 597 def auto_navigation(self): 598 """Gets the auto_navigation of this Envelope. # noqa: E501 599 600 # noqa: E501 601 602 :return: The auto_navigation of this Envelope. # noqa: E501 603 :rtype: str 604 """ 605 return self._auto_navigation 606 607 @auto_navigation.setter 608 def auto_navigation(self, auto_navigation): 609 """Sets the auto_navigation of this Envelope. 610 611 # noqa: E501 612 613 :param auto_navigation: The auto_navigation of this Envelope. # noqa: E501 614 :type: str 615 """ 616 617 self._auto_navigation = auto_navigation 618 619 @property 620 def brand_id(self): 621 """Gets the brand_id of this Envelope. # noqa: E501 622 623 # noqa: E501 624 625 :return: The brand_id of this Envelope. # noqa: E501 626 :rtype: str 627 """ 628 return self._brand_id 629 630 @brand_id.setter 631 def brand_id(self, brand_id): 632 """Sets the brand_id of this Envelope. 633 634 # noqa: E501 635 636 :param brand_id: The brand_id of this Envelope. # noqa: E501 637 :type: str 638 """ 639 640 self._brand_id = brand_id 641 642 @property 643 def brand_lock(self): 644 """Gets the brand_lock of this Envelope. # noqa: E501 645 646 # noqa: E501 647 648 :return: The brand_lock of this Envelope. # noqa: E501 649 :rtype: str 650 """ 651 return self._brand_lock 652 653 @brand_lock.setter 654 def brand_lock(self, brand_lock): 655 """Sets the brand_lock of this Envelope. 656 657 # noqa: E501 658 659 :param brand_lock: The brand_lock of this Envelope. # noqa: E501 660 :type: str 661 """ 662 663 self._brand_lock = brand_lock 664 665 @property 666 def burn_default_tab_data(self): 667 """Gets the burn_default_tab_data of this Envelope. # noqa: E501 668 669 # noqa: E501 670 671 :return: The burn_default_tab_data of this Envelope. # noqa: E501 672 :rtype: str 673 """ 674 return self._burn_default_tab_data 675 676 @burn_default_tab_data.setter 677 def burn_default_tab_data(self, burn_default_tab_data): 678 """Sets the burn_default_tab_data of this Envelope. 679 680 # noqa: E501 681 682 :param burn_default_tab_data: The burn_default_tab_data of this Envelope. # noqa: E501 683 :type: str 684 """ 685 686 self._burn_default_tab_data = burn_default_tab_data 687 688 @property 689 def certificate_uri(self): 690 """Gets the certificate_uri of this Envelope. # noqa: E501 691 692 Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501 693 694 :return: The certificate_uri of this Envelope. # noqa: E501 695 :rtype: str 696 """ 697 return self._certificate_uri 698 699 @certificate_uri.setter 700 def certificate_uri(self, certificate_uri): 701 """Sets the certificate_uri of this Envelope. 702 703 Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501 704 705 :param certificate_uri: The certificate_uri of this Envelope. # noqa: E501 706 :type: str 707 """ 708 709 self._certificate_uri = certificate_uri 710 711 @property 712 def completed_date_time(self): 713 """Gets the completed_date_time of this Envelope. # noqa: E501 714 715 Specifies the date and time this item was completed. # noqa: E501 716 717 :return: The completed_date_time of this Envelope. # noqa: E501 718 :rtype: str 719 """ 720 return self._completed_date_time 721 722 @completed_date_time.setter 723 def completed_date_time(self, completed_date_time): 724 """Sets the completed_date_time of this Envelope. 725 726 Specifies the date and time this item was completed. # noqa: E501 727 728 :param completed_date_time: The completed_date_time of this Envelope. # noqa: E501 729 :type: str 730 """ 731 732 self._completed_date_time = completed_date_time 733 734 @property 735 def copy_recipient_data(self): 736 """Gets the copy_recipient_data of this Envelope. # noqa: E501 737 738 # noqa: E501 739 740 :return: The copy_recipient_data of this Envelope. # noqa: E501 741 :rtype: str 742 """ 743 return self._copy_recipient_data 744 745 @copy_recipient_data.setter 746 def copy_recipient_data(self, copy_recipient_data): 747 """Sets the copy_recipient_data of this Envelope. 748 749 # noqa: E501 750 751 :param copy_recipient_data: The copy_recipient_data of this Envelope. # noqa: E501 752 :type: str 753 """ 754 755 self._copy_recipient_data = copy_recipient_data 756 757 @property 758 def created_date_time(self): 759 """Gets the created_date_time of this Envelope. # noqa: E501 760 761 Indicates the date and time the item was created. # noqa: E501 762 763 :return: The created_date_time of this Envelope. # noqa: E501 764 :rtype: str 765 """ 766 return self._created_date_time 767 768 @created_date_time.setter 769 def created_date_time(self, created_date_time): 770 """Sets the created_date_time of this Envelope. 771 772 Indicates the date and time the item was created. # noqa: E501 773 774 :param created_date_time: The created_date_time of this Envelope. # noqa: E501 775 :type: str 776 """ 777 778 self._created_date_time = created_date_time 779 780 @property 781 def custom_fields(self): 782 """Gets the custom_fields of this Envelope. # noqa: E501 783 784 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501 785 786 :return: The custom_fields of this Envelope. # noqa: E501 787 :rtype: CustomFields 788 """ 789 return self._custom_fields 790 791 @custom_fields.setter 792 def custom_fields(self, custom_fields): 793 """Sets the custom_fields of this Envelope. 794 795 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501 796 797 :param custom_fields: The custom_fields of this Envelope. # noqa: E501 798 :type: CustomFields 799 """ 800 801 self._custom_fields = custom_fields 802 803 @property 804 def custom_fields_uri(self): 805 """Gets the custom_fields_uri of this Envelope. # noqa: E501 806 807 Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501 808 809 :return: The custom_fields_uri of this Envelope. # noqa: E501 810 :rtype: str 811 """ 812 return self._custom_fields_uri 813 814 @custom_fields_uri.setter 815 def custom_fields_uri(self, custom_fields_uri): 816 """Sets the custom_fields_uri of this Envelope. 817 818 Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501 819 820 :param custom_fields_uri: The custom_fields_uri of this Envelope. # noqa: E501 821 :type: str 822 """ 823 824 self._custom_fields_uri = custom_fields_uri 825 826 @property 827 def declined_date_time(self): 828 """Gets the declined_date_time of this Envelope. # noqa: E501 829 830 The date and time the recipient declined the document. # noqa: E501 831 832 :return: The declined_date_time of this Envelope. # noqa: E501 833 :rtype: str 834 """ 835 return self._declined_date_time 836 837 @declined_date_time.setter 838 def declined_date_time(self, declined_date_time): 839 """Sets the declined_date_time of this Envelope. 840 841 The date and time the recipient declined the document. # noqa: E501 842 843 :param declined_date_time: The declined_date_time of this Envelope. # noqa: E501 844 :type: str 845 """ 846 847 self._declined_date_time = declined_date_time 848 849 @property 850 def deleted_date_time(self): 851 """Gets the deleted_date_time of this Envelope. # noqa: E501 852 853 Specifies the data and time the item was deleted. # noqa: E501 854 855 :return: The deleted_date_time of this Envelope. # noqa: E501 856 :rtype: str 857 """ 858 return self._deleted_date_time 859 860 @deleted_date_time.setter 861 def deleted_date_time(self, deleted_date_time): 862 """Sets the deleted_date_time of this Envelope. 863 864 Specifies the data and time the item was deleted. # noqa: E501 865 866 :param deleted_date_time: The deleted_date_time of this Envelope. # noqa: E501 867 :type: str 868 """ 869 870 self._deleted_date_time = deleted_date_time 871 872 @property 873 def delivered_date_time(self): 874 """Gets the delivered_date_time of this Envelope. # noqa: E501 875 876 Reserved: For DocuSign use only. # noqa: E501 877 878 :return: The delivered_date_time of this Envelope. # noqa: E501 879 :rtype: str 880 """ 881 return self._delivered_date_time 882 883 @delivered_date_time.setter 884 def delivered_date_time(self, delivered_date_time): 885 """Sets the delivered_date_time of this Envelope. 886 887 Reserved: For DocuSign use only. # noqa: E501 888 889 :param delivered_date_time: The delivered_date_time of this Envelope. # noqa: E501 890 :type: str 891 """ 892 893 self._delivered_date_time = delivered_date_time 894 895 @property 896 def disable_responsive_document(self): 897 """Gets the disable_responsive_document of this Envelope. # noqa: E501 898 899 # noqa: E501 900 901 :return: The disable_responsive_document of this Envelope. # noqa: E501 902 :rtype: str 903 """ 904 return self._disable_responsive_document 905 906 @disable_responsive_document.setter 907 def disable_responsive_document(self, disable_responsive_document): 908 """Sets the disable_responsive_document of this Envelope. 909 910 # noqa: E501 911 912 :param disable_responsive_document: The disable_responsive_document of this Envelope. # noqa: E501 913 :type: str 914 """ 915 916 self._disable_responsive_document = disable_responsive_document 917 918 @property 919 def document_base64(self): 920 """Gets the document_base64 of this Envelope. # noqa: E501 921 922 # noqa: E501 923 924 :return: The document_base64 of this Envelope. # noqa: E501 925 :rtype: str 926 """ 927 return self._document_base64 928 929 @document_base64.setter 930 def document_base64(self, document_base64): 931 """Sets the document_base64 of this Envelope. 932 933 # noqa: E501 934 935 :param document_base64: The document_base64 of this Envelope. # noqa: E501 936 :type: str 937 """ 938 939 self._document_base64 = document_base64 940 941 @property 942 def documents_combined_uri(self): 943 """Gets the documents_combined_uri of this Envelope. # noqa: E501 944 945 # noqa: E501 946 947 :return: The documents_combined_uri of this Envelope. # noqa: E501 948 :rtype: str 949 """ 950 return self._documents_combined_uri 951 952 @documents_combined_uri.setter 953 def documents_combined_uri(self, documents_combined_uri): 954 """Sets the documents_combined_uri of this Envelope. 955 956 # noqa: E501 957 958 :param documents_combined_uri: The documents_combined_uri of this Envelope. # noqa: E501 959 :type: str 960 """ 961 962 self._documents_combined_uri = documents_combined_uri 963 964 @property 965 def documents_uri(self): 966 """Gets the documents_uri of this Envelope. # noqa: E501 967 968 Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501 969 970 :return: The documents_uri of this Envelope. # noqa: E501 971 :rtype: str 972 """ 973 return self._documents_uri 974 975 @documents_uri.setter 976 def documents_uri(self, documents_uri): 977 """Sets the documents_uri of this Envelope. 978 979 Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501 980 981 :param documents_uri: The documents_uri of this Envelope. # noqa: E501 982 :type: str 983 """ 984 985 self._documents_uri = documents_uri 986 987 @property 988 def email_blurb(self): 989 """Gets the email_blurb of this Envelope. # noqa: E501 990 991 This is the same as the email body. If specified it is included in email body for all envelope recipients. # noqa: E501 992 993 :return: The email_blurb of this Envelope. # noqa: E501 994 :rtype: str 995 """ 996 return self._email_blurb 997 998 @email_blurb.setter 999 def email_blurb(self, email_blurb): 1000 """Sets the email_blurb of this Envelope. 1001 1002 This is the same as the email body. If specified it is included in email body for all envelope recipients. # noqa: E501 1003 1004 :param email_blurb: The email_blurb of this Envelope. # noqa: E501 1005 :type: str 1006 """ 1007 1008 self._email_blurb = email_blurb 1009 1010 @property 1011 def email_settings(self): 1012 """Gets the email_settings of this Envelope. # noqa: E501 1013 1014 A complex type that contains email settings. # noqa: E501 1015 1016 :return: The email_settings of this Envelope. # noqa: E501 1017 :rtype: EmailSettings 1018 """ 1019 return self._email_settings 1020 1021 @email_settings.setter 1022 def email_settings(self, email_settings): 1023 """Sets the email_settings of this Envelope. 1024 1025 A complex type that contains email settings. # noqa: E501 1026 1027 :param email_settings: The email_settings of this Envelope. # noqa: E501 1028 :type: EmailSettings 1029 """ 1030 1031 self._email_settings = email_settings 1032 1033 @property 1034 def email_subject(self): 1035 """Gets the email_subject of this Envelope. # noqa: E501 1036 1037 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. # noqa: E501 1038 1039 :return: The email_subject of this Envelope. # noqa: E501 1040 :rtype: str 1041 """ 1042 return self._email_subject 1043 1044 @email_subject.setter 1045 def email_subject(self, email_subject): 1046 """Sets the email_subject of this Envelope. 1047 1048 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. # noqa: E501 1049 1050 :param email_subject: The email_subject of this Envelope. # noqa: E501 1051 :type: str 1052 """ 1053 1054 self._email_subject = email_subject 1055 1056 @property 1057 def enable_wet_sign(self): 1058 """Gets the enable_wet_sign of this Envelope. # noqa: E501 1059 1060 When set to **true**, the signer is allowed to print the document and sign it on paper. # noqa: E501 1061 1062 :return: The enable_wet_sign of this Envelope. # noqa: E501 1063 :rtype: str 1064 """ 1065 return self._enable_wet_sign 1066 1067 @enable_wet_sign.setter 1068 def enable_wet_sign(self, enable_wet_sign): 1069 """Sets the enable_wet_sign of this Envelope. 1070 1071 When set to **true**, the signer is allowed to print the document and sign it on paper. # noqa: E501 1072 1073 :param enable_wet_sign: The enable_wet_sign of this Envelope. # noqa: E501 1074 :type: str 1075 """ 1076 1077 self._enable_wet_sign = enable_wet_sign 1078 1079 @property 1080 def enforce_signer_visibility(self): 1081 """Gets the enforce_signer_visibility of this Envelope. # noqa: E501 1082 1083 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. # noqa: E501 1084 1085 :return: The enforce_signer_visibility of this Envelope. # noqa: E501 1086 :rtype: str 1087 """ 1088 return self._enforce_signer_visibility 1089 1090 @enforce_signer_visibility.setter 1091 def enforce_signer_visibility(self, enforce_signer_visibility): 1092 """Sets the enforce_signer_visibility of this Envelope. 1093 1094 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. # noqa: E501 1095 1096 :param enforce_signer_visibility: The enforce_signer_visibility of this Envelope. # noqa: E501 1097 :type: str 1098 """ 1099 1100 self._enforce_signer_visibility = enforce_signer_visibility 1101 1102 @property 1103 def envelope_attachments(self): 1104 """Gets the envelope_attachments of this Envelope. # noqa: E501 1105 1106 # noqa: E501 1107 1108 :return: The envelope_attachments of this Envelope. # noqa: E501 1109 :rtype: list[Attachment] 1110 """ 1111 return self._envelope_attachments 1112 1113 @envelope_attachments.setter 1114 def envelope_attachments(self, envelope_attachments): 1115 """Sets the envelope_attachments of this Envelope. 1116 1117 # noqa: E501 1118 1119 :param envelope_attachments: The envelope_attachments of this Envelope. # noqa: E501 1120 :type: list[Attachment] 1121 """ 1122 1123 self._envelope_attachments = envelope_attachments 1124 1125 @property 1126 def envelope_custom_metadata(self): 1127 """Gets the envelope_custom_metadata of this Envelope. # noqa: E501 1128 1129 # noqa: E501 1130 1131 :return: The envelope_custom_metadata of this Envelope. # noqa: E501 1132 :rtype: EnvelopeCustomMetadata 1133 """ 1134 return self._envelope_custom_metadata 1135 1136 @envelope_custom_metadata.setter 1137 def envelope_custom_metadata(self, envelope_custom_metadata): 1138 """Sets the envelope_custom_metadata of this Envelope. 1139 1140 # noqa: E501 1141 1142 :param envelope_custom_metadata: The envelope_custom_metadata of this Envelope. # noqa: E501 1143 :type: EnvelopeCustomMetadata 1144 """ 1145 1146 self._envelope_custom_metadata = envelope_custom_metadata 1147 1148 @property 1149 def envelope_documents(self): 1150 """Gets the envelope_documents of this Envelope. # noqa: E501 1151 1152 # noqa: E501 1153 1154 :return: The envelope_documents of this Envelope. # noqa: E501 1155 :rtype: list[EnvelopeDocument] 1156 """ 1157 return self._envelope_documents 1158 1159 @envelope_documents.setter 1160 def envelope_documents(self, envelope_documents): 1161 """Sets the envelope_documents of this Envelope. 1162 1163 # noqa: E501 1164 1165 :param envelope_documents: The envelope_documents of this Envelope. # noqa: E501 1166 :type: list[EnvelopeDocument] 1167 """ 1168 1169 self._envelope_documents = envelope_documents 1170 1171 @property 1172 def envelope_id(self): 1173 """Gets the envelope_id of this Envelope. # noqa: E501 1174 1175 The envelope ID of the envelope status that failed to post. # noqa: E501 1176 1177 :return: The envelope_id of this Envelope. # noqa: E501 1178 :rtype: str 1179 """ 1180 return self._envelope_id 1181 1182 @envelope_id.setter 1183 def envelope_id(self, envelope_id): 1184 """Sets the envelope_id of this Envelope. 1185 1186 The envelope ID of the envelope status that failed to post. # noqa: E501 1187 1188 :param envelope_id: The envelope_id of this Envelope. # noqa: E501 1189 :type: str 1190 """ 1191 1192 self._envelope_id = envelope_id 1193 1194 @property 1195 def envelope_id_stamping(self): 1196 """Gets the envelope_id_stamping of this Envelope. # noqa: E501 1197 1198 When set to **true**, Envelope ID Stamping is enabled. # noqa: E501 1199 1200 :return: The envelope_id_stamping of this Envelope. # noqa: E501 1201 :rtype: str 1202 """ 1203 return self._envelope_id_stamping 1204 1205 @envelope_id_stamping.setter 1206 def envelope_id_stamping(self, envelope_id_stamping): 1207 """Sets the envelope_id_stamping of this Envelope. 1208 1209 When set to **true**, Envelope ID Stamping is enabled. # noqa: E501 1210 1211 :param envelope_id_stamping: The envelope_id_stamping of this Envelope. # noqa: E501 1212 :type: str 1213 """ 1214 1215 self._envelope_id_stamping = envelope_id_stamping 1216 1217 @property 1218 def envelope_location(self): 1219 """Gets the envelope_location of this Envelope. # noqa: E501 1220 1221 # noqa: E501 1222 1223 :return: The envelope_location of this Envelope. # noqa: E501 1224 :rtype: str 1225 """ 1226 return self._envelope_location 1227 1228 @envelope_location.setter 1229 def envelope_location(self, envelope_location): 1230 """Sets the envelope_location of this Envelope. 1231 1232 # noqa: E501 1233 1234 :param envelope_location: The envelope_location of this Envelope. # noqa: E501 1235 :type: str 1236 """ 1237 1238 self._envelope_location = envelope_location 1239 1240 @property 1241 def envelope_metadata(self): 1242 """Gets the envelope_metadata of this Envelope. # noqa: E501 1243 1244 Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. # noqa: E501 1245 1246 :return: The envelope_metadata of this Envelope. # noqa: E501 1247 :rtype: EnvelopeMetadata 1248 """ 1249 return self._envelope_metadata 1250 1251 @envelope_metadata.setter 1252 def envelope_metadata(self, envelope_metadata): 1253 """Sets the envelope_metadata of this Envelope. 1254 1255 Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. # noqa: E501 1256 1257 :param envelope_metadata: The envelope_metadata of this Envelope. # noqa: E501 1258 :type: EnvelopeMetadata 1259 """ 1260 1261 self._envelope_metadata = envelope_metadata 1262 1263 @property 1264 def envelope_uri(self): 1265 """Gets the envelope_uri of this Envelope. # noqa: E501 1266 1267 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501 1268 1269 :return: The envelope_uri of this Envelope. # noqa: E501 1270 :rtype: str 1271 """ 1272 return self._envelope_uri 1273 1274 @envelope_uri.setter 1275 def envelope_uri(self, envelope_uri): 1276 """Sets the envelope_uri of this Envelope. 1277 1278 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501 1279 1280 :param envelope_uri: The envelope_uri of this Envelope. # noqa: E501 1281 :type: str 1282 """ 1283 1284 self._envelope_uri = envelope_uri 1285 1286 @property 1287 def expire_after(self): 1288 """Gets the expire_after of this Envelope. # noqa: E501 1289 1290 # noqa: E501 1291 1292 :return: The expire_after of this Envelope. # noqa: E501 1293 :rtype: str 1294 """ 1295 return self._expire_after 1296 1297 @expire_after.setter 1298 def expire_after(self, expire_after): 1299 """Sets the expire_after of this Envelope. 1300 1301 # noqa: E501 1302 1303 :param expire_after: The expire_after of this Envelope. # noqa: E501 1304 :type: str 1305 """ 1306 1307 self._expire_after = expire_after 1308 1309 @property 1310 def expire_date_time(self): 1311 """Gets the expire_date_time of this Envelope. # noqa: E501 1312 1313 # noqa: E501 1314 1315 :return: The expire_date_time of this Envelope. # noqa: E501 1316 :rtype: str 1317 """ 1318 return self._expire_date_time 1319 1320 @expire_date_time.setter 1321 def expire_date_time(self, expire_date_time): 1322 """Sets the expire_date_time of this Envelope. 1323 1324 # noqa: E501 1325 1326 :param expire_date_time: The expire_date_time of this Envelope. # noqa: E501 1327 :type: str 1328 """ 1329 1330 self._expire_date_time = expire_date_time 1331 1332 @property 1333 def expire_enabled(self): 1334 """Gets the expire_enabled of this Envelope. # noqa: E501 1335 1336 # noqa: E501 1337 1338 :return: The expire_enabled of this Envelope. # noqa: E501 1339 :rtype: str 1340 """ 1341 return self._expire_enabled 1342 1343 @expire_enabled.setter 1344 def expire_enabled(self, expire_enabled): 1345 """Sets the expire_enabled of this Envelope. 1346 1347 # noqa: E501 1348 1349 :param expire_enabled: The expire_enabled of this Envelope. # noqa: E501 1350 :type: str 1351 """ 1352 1353 self._expire_enabled = expire_enabled 1354 1355 @property 1356 def external_envelope_id(self): 1357 """Gets the external_envelope_id of this Envelope. # noqa: E501 1358 1359 # noqa: E501 1360 1361 :return: The external_envelope_id of this Envelope. # noqa: E501 1362 :rtype: str 1363 """ 1364 return self._external_envelope_id 1365 1366 @external_envelope_id.setter 1367 def external_envelope_id(self, external_envelope_id): 1368 """Sets the external_envelope_id of this Envelope. 1369 1370 # noqa: E501 1371 1372 :param external_envelope_id: The external_envelope_id of this Envelope. # noqa: E501 1373 :type: str 1374 """ 1375 1376 self._external_envelope_id = external_envelope_id 1377 1378 @property 1379 def folders(self): 1380 """Gets the folders of this Envelope. # noqa: E501 1381 1382 # noqa: E501 1383 1384 :return: The folders of this Envelope. # noqa: E501 1385 :rtype: list[Folder] 1386 """ 1387 return self._folders 1388 1389 @folders.setter 1390 def folders(self, folders): 1391 """Sets the folders of this Envelope. 1392 1393 # noqa: E501 1394 1395 :param folders: The folders of this Envelope. # noqa: E501 1396 :type: list[Folder] 1397 """ 1398 1399 self._folders = folders 1400 1401 @property 1402 def has_comments(self): 1403 """Gets the has_comments of this Envelope. # noqa: E501 1404 1405 # noqa: E501 1406 1407 :return: The has_comments of this Envelope. # noqa: E501 1408 :rtype: str 1409 """ 1410 return self._has_comments 1411 1412 @has_comments.setter 1413 def has_comments(self, has_comments): 1414 """Sets the has_comments of this Envelope. 1415 1416 # noqa: E501 1417 1418 :param has_comments: The has_comments of this Envelope. # noqa: E501 1419 :type: str 1420 """ 1421 1422 self._has_comments = has_comments 1423 1424 @property 1425 def has_form_data_changed(self): 1426 """Gets the has_form_data_changed of this Envelope. # noqa: E501 1427 1428 # noqa: E501 1429 1430 :return: The has_form_data_changed of this Envelope. # noqa: E501 1431 :rtype: str 1432 """ 1433 return self._has_form_data_changed 1434 1435 @has_form_data_changed.setter 1436 def has_form_data_changed(self, has_form_data_changed): 1437 """Sets the has_form_data_changed of this Envelope. 1438 1439 # noqa: E501 1440 1441 :param has_form_data_changed: The has_form_data_changed of this Envelope. # noqa: E501 1442 :type: str 1443 """ 1444 1445 self._has_form_data_changed = has_form_data_changed 1446 1447 @property 1448 def has_wav_file(self): 1449 """Gets the has_wav_file of this Envelope. # noqa: E501 1450 1451 # noqa: E501 1452 1453 :return: The has_wav_file of this Envelope. # noqa: E501 1454 :rtype: str 1455 """ 1456 return self._has_wav_file 1457 1458 @has_wav_file.setter 1459 def has_wav_file(self, has_wav_file): 1460 """Sets the has_wav_file of this Envelope. 1461 1462 # noqa: E501 1463 1464 :param has_wav_file: The has_wav_file of this Envelope. # noqa: E501 1465 :type: str 1466 """ 1467 1468 self._has_wav_file = has_wav_file 1469 1470 @property 1471 def holder(self): 1472 """Gets the holder of this Envelope. # noqa: E501 1473 1474 # noqa: E501 1475 1476 :return: The holder of this Envelope. # noqa: E501 1477 :rtype: str 1478 """ 1479 return self._holder 1480 1481 @holder.setter 1482 def holder(self, holder): 1483 """Sets the holder of this Envelope. 1484 1485 # noqa: E501 1486 1487 :param holder: The holder of this Envelope. # noqa: E501 1488 :type: str 1489 """ 1490 1491 self._holder = holder 1492 1493 @property 1494 def initial_sent_date_time(self): 1495 """Gets the initial_sent_date_time of this Envelope. # noqa: E501 1496 1497 # noqa: E501 1498 1499 :return: The initial_sent_date_time of this Envelope. # noqa: E501 1500 :rtype: str 1501 """ 1502 return self._initial_sent_date_time 1503 1504 @initial_sent_date_time.setter 1505 def initial_sent_date_time(self, initial_sent_date_time): 1506 """Sets the initial_sent_date_time of this Envelope. 1507 1508 # noqa: E501 1509 1510 :param initial_sent_date_time: The initial_sent_date_time of this Envelope. # noqa: E501 1511 :type: str 1512 """ 1513 1514 self._initial_sent_date_time = initial_sent_date_time 1515 1516 @property 1517 def is21_cfr_part11(self): 1518 """Gets the is21_cfr_part11 of this Envelope. # noqa: E501 1519 1520 When set to **true**, indicates that this module is enabled on the account. # noqa: E501 1521 1522 :return: The is21_cfr_part11 of this Envelope. # noqa: E501 1523 :rtype: str 1524 """ 1525 return self._is21_cfr_part11 1526 1527 @is21_cfr_part11.setter 1528 def is21_cfr_part11(self, is21_cfr_part11): 1529 """Sets the is21_cfr_part11 of this Envelope. 1530 1531 When set to **true**, indicates that this module is enabled on the account. # noqa: E501 1532 1533 :param is21_cfr_part11: The is21_cfr_part11 of this Envelope. # noqa: E501 1534 :type: str 1535 """ 1536 1537 self._is21_cfr_part11 = is21_cfr_part11 1538 1539 @property 1540 def is_dynamic_envelope(self): 1541 """Gets the is_dynamic_envelope of this Envelope. # noqa: E501 1542 1543 # noqa: E501 1544 1545 :return: The is_dynamic_envelope of this Envelope. # noqa: E501 1546 :rtype: str 1547 """ 1548 return self._is_dynamic_envelope 1549 1550 @is_dynamic_envelope.setter 1551 def is_dynamic_envelope(self, is_dynamic_envelope): 1552 """Sets the is_dynamic_envelope of this Envelope. 1553 1554 # noqa: E501 1555 1556 :param is_dynamic_envelope: The is_dynamic_envelope of this Envelope. # noqa: E501 1557 :type: str 1558 """ 1559 1560 self._is_dynamic_envelope = is_dynamic_envelope 1561 1562 @property 1563 def is_signature_provider_envelope(self): 1564 """Gets the is_signature_provider_envelope of this Envelope. # noqa: E501 1565 1566 # noqa: E501 1567 1568 :return: The is_signature_provider_envelope of this Envelope. # noqa: E501 1569 :rtype: str 1570 """ 1571 return self._is_signature_provider_envelope 1572 1573 @is_signature_provider_envelope.setter 1574 def is_signature_provider_envelope(self, is_signature_provider_envelope): 1575 """Sets the is_signature_provider_envelope of this Envelope. 1576 1577 # noqa: E501 1578 1579 :param is_signature_provider_envelope: The is_signature_provider_envelope of this Envelope. # noqa: E501 1580 :type: str 1581 """ 1582 1583 self._is_signature_provider_envelope = is_signature_provider_envelope 1584 1585 @property 1586 def last_modified_date_time(self): 1587 """Gets the last_modified_date_time of this Envelope. # noqa: E501 1588 1589 The date and time the item was last modified. # noqa: E501 1590 1591 :return: The last_modified_date_time of this Envelope. # noqa: E501 1592 :rtype: str 1593 """ 1594 return self._last_modified_date_time 1595 1596 @last_modified_date_time.setter 1597 def last_modified_date_time(self, last_modified_date_time): 1598 """Sets the last_modified_date_time of this Envelope. 1599 1600 The date and time the item was last modified. # noqa: E501 1601 1602 :param last_modified_date_time: The last_modified_date_time of this Envelope. # noqa: E501 1603 :type: str 1604 """ 1605 1606 self._last_modified_date_time = last_modified_date_time 1607 1608 @property 1609 def location(self): 1610 """Gets the location of this Envelope. # noqa: E501 1611 1612 # noqa: E501 1613 1614 :return: The location of this Envelope. # noqa: E501 1615 :rtype: str 1616 """ 1617 return self._location 1618 1619 @location.setter 1620 def location(self, location): 1621 """Sets the location of this Envelope. 1622 1623 # noqa: E501 1624 1625 :param location: The location of this Envelope. # noqa: E501 1626 :type: str 1627 """ 1628 1629 self._location = location 1630 1631 @property 1632 def lock_information(self): 1633 """Gets the lock_information of this Envelope. # noqa: E501 1634 1635 Provides lock information about an envelope that a user has locked. # noqa: E501 1636 1637 :return: The lock_information of this Envelope. # noqa: E501 1638 :rtype: LockInformation 1639 """ 1640 return self._lock_information 1641 1642 @lock_information.setter 1643 def lock_information(self, lock_information): 1644 """Sets the lock_information of this Envelope. 1645 1646 Provides lock information about an envelope that a user has locked. # noqa: E501 1647 1648 :param lock_information: The lock_information of this Envelope. # noqa: E501 1649 :type: LockInformation 1650 """ 1651 1652 self._lock_information = lock_information 1653 1654 @property 1655 def message_lock(self): 1656 """Gets the message_lock of this Envelope. # noqa: E501 1657 1658 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. # noqa: E501 1659 1660 :return: The message_lock of this Envelope. # noqa: E501 1661 :rtype: str 1662 """ 1663 return self._message_lock 1664 1665 @message_lock.setter 1666 def message_lock(self, message_lock): 1667 """Sets the message_lock of this Envelope. 1668 1669 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. # noqa: E501 1670 1671 :param message_lock: The message_lock of this Envelope. # noqa: E501 1672 :type: str 1673 """ 1674 1675 self._message_lock = message_lock 1676 1677 @property 1678 def notification(self): 1679 """Gets the notification of this Envelope. # noqa: E501 1680 1681 # noqa: E501 1682 1683 :return: The notification of this Envelope. # noqa: E501 1684 :rtype: Notification 1685 """ 1686 return self._notification 1687 1688 @notification.setter 1689 def notification(self, notification): 1690 """Sets the notification of this Envelope. 1691 1692 # noqa: E501 1693 1694 :param notification: The notification of this Envelope. # noqa: E501 1695 :type: Notification 1696 """ 1697 1698 self._notification = notification 1699 1700 @property 1701 def notification_uri(self): 1702 """Gets the notification_uri of this Envelope. # noqa: E501 1703 1704 Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501 1705 1706 :return: The notification_uri of this Envelope. # noqa: E501 1707 :rtype: str 1708 """ 1709 return self._notification_uri 1710 1711 @notification_uri.setter 1712 def notification_uri(self, notification_uri): 1713 """Sets the notification_uri of this Envelope. 1714 1715 Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501 1716 1717 :param notification_uri: The notification_uri of this Envelope. # noqa: E501 1718 :type: str 1719 """ 1720 1721 self._notification_uri = notification_uri 1722 1723 @property 1724 def power_form(self): 1725 """Gets the power_form of this Envelope. # noqa: E501 1726 1727 Information about any PowerForms that are included in the envelope. # noqa: E501 1728 1729 :return: The power_form of this Envelope. # noqa: E501 1730 :rtype: PowerForm 1731 """ 1732 return self._power_form 1733 1734 @power_form.setter 1735 def power_form(self, power_form): 1736 """Sets the power_form of this Envelope. 1737 1738 Information about any PowerForms that are included in the envelope. # noqa: E501 1739 1740 :param power_form: The power_form of this Envelope. # noqa: E501 1741 :type: PowerForm 1742 """ 1743 1744 self._power_form = power_form 1745 1746 @property 1747 def purge_completed_date(self): 1748 """Gets the purge_completed_date of this Envelope. # noqa: E501 1749 1750 # noqa: E501 1751 1752 :return: The purge_completed_date of this Envelope. # noqa: E501 1753 :rtype: str 1754 """ 1755 return self._purge_completed_date 1756 1757 @purge_completed_date.setter 1758 def purge_completed_date(self, purge_completed_date): 1759 """Sets the purge_completed_date of this Envelope. 1760 1761 # noqa: E501 1762 1763 :param purge_completed_date: The purge_completed_date of this Envelope. # noqa: E501 1764 :type: str 1765 """ 1766 1767 self._purge_completed_date = purge_completed_date 1768 1769 @property 1770 def purge_request_date(self): 1771 """Gets the purge_request_date of this Envelope. # noqa: E501 1772 1773 # noqa: E501 1774 1775 :return: The purge_request_date of this Envelope. # noqa: E501 1776 :rtype: str 1777 """ 1778 return self._purge_request_date 1779 1780 @purge_request_date.setter 1781 def purge_request_date(self, purge_request_date): 1782 """Sets the purge_request_date of this Envelope. 1783 1784 # noqa: E501 1785 1786 :param purge_request_date: The purge_request_date of this Envelope. # noqa: E501 1787 :type: str 1788 """ 1789 1790 self._purge_request_date = purge_request_date 1791 1792 @property 1793 def purge_state(self): 1794 """Gets the purge_state of this Envelope. # noqa: E501 1795 1796 # noqa: E501 1797 1798 :return: The purge_state of this Envelope. # noqa: E501 1799 :rtype: str 1800 """ 1801 return self._purge_state 1802 1803 @purge_state.setter 1804 def purge_state(self, purge_state): 1805 """Sets the purge_state of this Envelope. 1806 1807 # noqa: E501 1808 1809 :param purge_state: The purge_state of this Envelope. # noqa: E501 1810 :type: str 1811 """ 1812 1813 self._purge_state = purge_state 1814 1815 @property 1816 def recipients(self): 1817 """Gets the recipients of this Envelope. # noqa: E501 1818 1819 An array of powerform recipients. # noqa: E501 1820 1821 :return: The recipients of this Envelope. # noqa: E501 1822 :rtype: Recipients 1823 """ 1824 return self._recipients 1825 1826 @recipients.setter 1827 def recipients(self, recipients): 1828 """Sets the recipients of this Envelope. 1829 1830 An array of powerform recipients. # noqa: E501 1831 1832 :param recipients: The recipients of this Envelope. # noqa: E501 1833 :type: Recipients 1834 """ 1835 1836 self._recipients = recipients 1837 1838 @property 1839 def recipients_lock(self): 1840 """Gets the recipients_lock of this Envelope. # noqa: E501 1841 1842 When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501 1843 1844 :return: The recipients_lock of this Envelope. # noqa: E501 1845 :rtype: str 1846 """ 1847 return self._recipients_lock 1848 1849 @recipients_lock.setter 1850 def recipients_lock(self, recipients_lock): 1851 """Sets the recipients_lock of this Envelope. 1852 1853 When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501 1854 1855 :param recipients_lock: The recipients_lock of this Envelope. # noqa: E501 1856 :type: str 1857 """ 1858 1859 self._recipients_lock = recipients_lock 1860 1861 @property 1862 def recipients_uri(self): 1863 """Gets the recipients_uri of this Envelope. # noqa: E501 1864 1865 Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501 1866 1867 :return: The recipients_uri of this Envelope. # noqa: E501 1868 :rtype: str 1869 """ 1870 return self._recipients_uri 1871 1872 @recipients_uri.setter 1873 def recipients_uri(self, recipients_uri): 1874 """Sets the recipients_uri of this Envelope. 1875 1876 Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501 1877 1878 :param recipients_uri: The recipients_uri of this Envelope. # noqa: E501 1879 :type: str 1880 """ 1881 1882 self._recipients_uri = recipients_uri 1883 1884 @property 1885 def sender(self): 1886 """Gets the sender of this Envelope. # noqa: E501 1887 1888 Information about the sender of the envelope. # noqa: E501 1889 1890 :return: The sender of this Envelope. # noqa: E501 1891 :rtype: UserInfo 1892 """ 1893 return self._sender 1894 1895 @sender.setter 1896 def sender(self, sender): 1897 """Sets the sender of this Envelope. 1898 1899 Information about the sender of the envelope. # noqa: E501 1900 1901 :param sender: The sender of this Envelope. # noqa: E501 1902 :type: UserInfo 1903 """ 1904 1905 self._sender = sender 1906 1907 @property 1908 def sent_date_time(self): 1909 """Gets the sent_date_time of this Envelope. # noqa: E501 1910 1911 The date and time the envelope was sent. # noqa: E501 1912 1913 :return: The sent_date_time of this Envelope. # noqa: E501 1914 :rtype: str 1915 """ 1916 return self._sent_date_time 1917 1918 @sent_date_time.setter 1919 def sent_date_time(self, sent_date_time): 1920 """Sets the sent_date_time of this Envelope. 1921 1922 The date and time the envelope was sent. # noqa: E501 1923 1924 :param sent_date_time: The sent_date_time of this Envelope. # noqa: E501 1925 :type: str 1926 """ 1927 1928 self._sent_date_time = sent_date_time 1929 1930 @property 1931 def signer_can_sign_on_mobile(self): 1932 """Gets the signer_can_sign_on_mobile of this Envelope. # noqa: E501 1933 1934 # noqa: E501 1935 1936 :return: The signer_can_sign_on_mobile of this Envelope. # noqa: E501 1937 :rtype: str 1938 """ 1939 return self._signer_can_sign_on_mobile 1940 1941 @signer_can_sign_on_mobile.setter 1942 def signer_can_sign_on_mobile(self, signer_can_sign_on_mobile): 1943 """Sets the signer_can_sign_on_mobile of this Envelope. 1944 1945 # noqa: E501 1946 1947 :param signer_can_sign_on_mobile: The signer_can_sign_on_mobile of this Envelope. # noqa: E501 1948 :type: str 1949 """ 1950 1951 self._signer_can_sign_on_mobile = signer_can_sign_on_mobile 1952 1953 @property 1954 def signing_location(self): 1955 """Gets the signing_location of this Envelope. # noqa: E501 1956 1957 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 1958 1959 :return: The signing_location of this Envelope. # noqa: E501 1960 :rtype: str 1961 """ 1962 return self._signing_location 1963 1964 @signing_location.setter 1965 def signing_location(self, signing_location): 1966 """Sets the signing_location of this Envelope. 1967 1968 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 1969 1970 :param signing_location: The signing_location of this Envelope. # noqa: E501 1971 :type: str 1972 """ 1973 1974 self._signing_location = signing_location 1975 1976 @property 1977 def status(self): 1978 """Gets the status of this Envelope. # noqa: E501 1979 1980 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. # noqa: E501 1981 1982 :return: The status of this Envelope. # noqa: E501 1983 :rtype: str 1984 """ 1985 return self._status 1986 1987 @status.setter 1988 def status(self, status): 1989 """Sets the status of this Envelope. 1990 1991 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. # noqa: E501 1992 1993 :param status: The status of this Envelope. # noqa: E501 1994 :type: str 1995 """ 1996 1997 self._status = status 1998 1999 @property 2000 def status_changed_date_time(self): 2001 """Gets the status_changed_date_time of this Envelope. # noqa: E501 2002 2003 The data and time the status changed. # noqa: E501 2004 2005 :return: The status_changed_date_time of this Envelope. # noqa: E501 2006 :rtype: str 2007 """ 2008 return self._status_changed_date_time 2009 2010 @status_changed_date_time.setter 2011 def status_changed_date_time(self, status_changed_date_time): 2012 """Sets the status_changed_date_time of this Envelope. 2013 2014 The data and time the status changed. # noqa: E501 2015 2016 :param status_changed_date_time: The status_changed_date_time of this Envelope. # noqa: E501 2017 :type: str 2018 """ 2019 2020 self._status_changed_date_time = status_changed_date_time 2021 2022 @property 2023 def status_date_time(self): 2024 """Gets the status_date_time of this Envelope. # noqa: E501 2025 2026 # noqa: E501 2027 2028 :return: The status_date_time of this Envelope. # noqa: E501 2029 :rtype: str 2030 """ 2031 return self._status_date_time 2032 2033 @status_date_time.setter 2034 def status_date_time(self, status_date_time): 2035 """Sets the status_date_time of this Envelope. 2036 2037 # noqa: E501 2038 2039 :param status_date_time: The status_date_time of this Envelope. # noqa: E501 2040 :type: str 2041 """ 2042 2043 self._status_date_time = status_date_time 2044 2045 @property 2046 def templates_uri(self): 2047 """Gets the templates_uri of this Envelope. # noqa: E501 2048 2049 Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501 2050 2051 :return: The templates_uri of this Envelope. # noqa: E501 2052 :rtype: str 2053 """ 2054 return self._templates_uri 2055 2056 @templates_uri.setter 2057 def templates_uri(self, templates_uri): 2058 """Sets the templates_uri of this Envelope. 2059 2060 Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501 2061 2062 :param templates_uri: The templates_uri of this Envelope. # noqa: E501 2063 :type: str 2064 """ 2065 2066 self._templates_uri = templates_uri 2067 2068 @property 2069 def transaction_id(self): 2070 """Gets the transaction_id of this Envelope. # noqa: E501 2071 2072 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. # noqa: E501 2073 2074 :return: The transaction_id of this Envelope. # noqa: E501 2075 :rtype: str 2076 """ 2077 return self._transaction_id 2078 2079 @transaction_id.setter 2080 def transaction_id(self, transaction_id): 2081 """Sets the transaction_id of this Envelope. 2082 2083 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. # noqa: E501 2084 2085 :param transaction_id: The transaction_id of this Envelope. # noqa: E501 2086 :type: str 2087 """ 2088 2089 self._transaction_id = transaction_id 2090 2091 @property 2092 def use_disclosure(self): 2093 """Gets the use_disclosure of this Envelope. # noqa: E501 2094 2095 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. # noqa: E501 2096 2097 :return: The use_disclosure of this Envelope. # noqa: E501 2098 :rtype: str 2099 """ 2100 return self._use_disclosure 2101 2102 @use_disclosure.setter 2103 def use_disclosure(self, use_disclosure): 2104 """Sets the use_disclosure of this Envelope. 2105 2106 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. # noqa: E501 2107 2108 :param use_disclosure: The use_disclosure of this Envelope. # noqa: E501 2109 :type: str 2110 """ 2111 2112 self._use_disclosure = use_disclosure 2113 2114 @property 2115 def voided_date_time(self): 2116 """Gets the voided_date_time of this Envelope. # noqa: E501 2117 2118 The date and time the envelope or template was voided. # noqa: E501 2119 2120 :return: The voided_date_time of this Envelope. # noqa: E501 2121 :rtype: str 2122 """ 2123 return self._voided_date_time 2124 2125 @voided_date_time.setter 2126 def voided_date_time(self, voided_date_time): 2127 """Sets the voided_date_time of this Envelope. 2128 2129 The date and time the envelope or template was voided. # noqa: E501 2130 2131 :param voided_date_time: The voided_date_time of this Envelope. # noqa: E501 2132 :type: str 2133 """ 2134 2135 self._voided_date_time = voided_date_time 2136 2137 @property 2138 def voided_reason(self): 2139 """Gets the voided_reason of this Envelope. # noqa: E501 2140 2141 The reason the envelope or template was voided. # noqa: E501 2142 2143 :return: The voided_reason of this Envelope. # noqa: E501 2144 :rtype: str 2145 """ 2146 return self._voided_reason 2147 2148 @voided_reason.setter 2149 def voided_reason(self, voided_reason): 2150 """Sets the voided_reason of this Envelope. 2151 2152 The reason the envelope or template was voided. # noqa: E501 2153 2154 :param voided_reason: The voided_reason of this Envelope. # noqa: E501 2155 :type: str 2156 """ 2157 2158 self._voided_reason = voided_reason 2159 2160 @property 2161 def workflow(self): 2162 """Gets the workflow of this Envelope. # noqa: E501 2163 2164 # noqa: E501 2165 2166 :return: The workflow of this Envelope. # noqa: E501 2167 :rtype: Workflow 2168 """ 2169 return self._workflow 2170 2171 @workflow.setter 2172 def workflow(self, workflow): 2173 """Sets the workflow of this Envelope. 2174 2175 # noqa: E501 2176 2177 :param workflow: The workflow of this Envelope. # noqa: E501 2178 :type: Workflow 2179 """ 2180 2181 self._workflow = workflow 2182 2183 def to_dict(self): 2184 """Returns the model properties as a dict""" 2185 result = {} 2186 2187 for attr, _ in six.iteritems(self.swagger_types): 2188 value = getattr(self, attr) 2189 if isinstance(value, list): 2190 result[attr] = list(map( 2191 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2192 value 2193 )) 2194 elif hasattr(value, "to_dict"): 2195 result[attr] = value.to_dict() 2196 elif isinstance(value, dict): 2197 result[attr] = dict(map( 2198 lambda item: (item[0], item[1].to_dict()) 2199 if hasattr(item[1], "to_dict") else item, 2200 value.items() 2201 )) 2202 else: 2203 result[attr] = value 2204 if issubclass(Envelope, dict): 2205 for key, value in self.items(): 2206 result[key] = value 2207 2208 return result 2209 2210 def to_str(self): 2211 """Returns the string representation of the model""" 2212 return pprint.pformat(self.to_dict()) 2213 2214 def __repr__(self): 2215 """For `print` and `pprint`""" 2216 return self.to_str() 2217 2218 def __eq__(self, other): 2219 """Returns true if both objects are equal""" 2220 if not isinstance(other, Envelope): 2221 return False 2222 2223 return self.to_dict() == other.to_dict() 2224 2225 def __ne__(self, other): 2226 """Returns true if both objects are not equal""" 2227 if not isinstance(other, Envelope): 2228 return True 2229 2230 return self.to_dict() != other.to_dict()
class
Envelope:
23class Envelope(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'access_control_list_base64': 'str', 38 'allow_comments': 'str', 39 'allow_markup': 'str', 40 'allow_reassign': 'str', 41 'allow_view_history': 'str', 42 'any_signer': 'str', 43 'asynchronous': 'str', 44 'attachments_uri': 'str', 45 'authoritative_copy': 'str', 46 'authoritative_copy_default': 'str', 47 'auto_navigation': 'str', 48 'brand_id': 'str', 49 'brand_lock': 'str', 50 'burn_default_tab_data': 'str', 51 'certificate_uri': 'str', 52 'completed_date_time': 'str', 53 'copy_recipient_data': 'str', 54 'created_date_time': 'str', 55 'custom_fields': 'CustomFields', 56 'custom_fields_uri': 'str', 57 'declined_date_time': 'str', 58 'deleted_date_time': 'str', 59 'delivered_date_time': 'str', 60 'disable_responsive_document': 'str', 61 'document_base64': 'str', 62 'documents_combined_uri': 'str', 63 'documents_uri': 'str', 64 'email_blurb': 'str', 65 'email_settings': 'EmailSettings', 66 'email_subject': 'str', 67 'enable_wet_sign': 'str', 68 'enforce_signer_visibility': 'str', 69 'envelope_attachments': 'list[Attachment]', 70 'envelope_custom_metadata': 'EnvelopeCustomMetadata', 71 'envelope_documents': 'list[EnvelopeDocument]', 72 'envelope_id': 'str', 73 'envelope_id_stamping': 'str', 74 'envelope_location': 'str', 75 'envelope_metadata': 'EnvelopeMetadata', 76 'envelope_uri': 'str', 77 'expire_after': 'str', 78 'expire_date_time': 'str', 79 'expire_enabled': 'str', 80 'external_envelope_id': 'str', 81 'folders': 'list[Folder]', 82 'has_comments': 'str', 83 'has_form_data_changed': 'str', 84 'has_wav_file': 'str', 85 'holder': 'str', 86 'initial_sent_date_time': 'str', 87 'is21_cfr_part11': 'str', 88 'is_dynamic_envelope': 'str', 89 'is_signature_provider_envelope': 'str', 90 'last_modified_date_time': 'str', 91 'location': 'str', 92 'lock_information': 'LockInformation', 93 'message_lock': 'str', 94 'notification': 'Notification', 95 'notification_uri': 'str', 96 'power_form': 'PowerForm', 97 'purge_completed_date': 'str', 98 'purge_request_date': 'str', 99 'purge_state': 'str', 100 'recipients': 'Recipients', 101 'recipients_lock': 'str', 102 'recipients_uri': 'str', 103 'sender': 'UserInfo', 104 'sent_date_time': 'str', 105 'signer_can_sign_on_mobile': 'str', 106 'signing_location': 'str', 107 'status': 'str', 108 'status_changed_date_time': 'str', 109 'status_date_time': 'str', 110 'templates_uri': 'str', 111 'transaction_id': 'str', 112 'use_disclosure': 'str', 113 'voided_date_time': 'str', 114 'voided_reason': 'str', 115 'workflow': 'Workflow' 116 } 117 118 attribute_map = { 119 'access_control_list_base64': 'accessControlListBase64', 120 'allow_comments': 'allowComments', 121 'allow_markup': 'allowMarkup', 122 'allow_reassign': 'allowReassign', 123 'allow_view_history': 'allowViewHistory', 124 'any_signer': 'anySigner', 125 'asynchronous': 'asynchronous', 126 'attachments_uri': 'attachmentsUri', 127 'authoritative_copy': 'authoritativeCopy', 128 'authoritative_copy_default': 'authoritativeCopyDefault', 129 'auto_navigation': 'autoNavigation', 130 'brand_id': 'brandId', 131 'brand_lock': 'brandLock', 132 'burn_default_tab_data': 'burnDefaultTabData', 133 'certificate_uri': 'certificateUri', 134 'completed_date_time': 'completedDateTime', 135 'copy_recipient_data': 'copyRecipientData', 136 'created_date_time': 'createdDateTime', 137 'custom_fields': 'customFields', 138 'custom_fields_uri': 'customFieldsUri', 139 'declined_date_time': 'declinedDateTime', 140 'deleted_date_time': 'deletedDateTime', 141 'delivered_date_time': 'deliveredDateTime', 142 'disable_responsive_document': 'disableResponsiveDocument', 143 'document_base64': 'documentBase64', 144 'documents_combined_uri': 'documentsCombinedUri', 145 'documents_uri': 'documentsUri', 146 'email_blurb': 'emailBlurb', 147 'email_settings': 'emailSettings', 148 'email_subject': 'emailSubject', 149 'enable_wet_sign': 'enableWetSign', 150 'enforce_signer_visibility': 'enforceSignerVisibility', 151 'envelope_attachments': 'envelopeAttachments', 152 'envelope_custom_metadata': 'envelopeCustomMetadata', 153 'envelope_documents': 'envelopeDocuments', 154 'envelope_id': 'envelopeId', 155 'envelope_id_stamping': 'envelopeIdStamping', 156 'envelope_location': 'envelopeLocation', 157 'envelope_metadata': 'envelopeMetadata', 158 'envelope_uri': 'envelopeUri', 159 'expire_after': 'expireAfter', 160 'expire_date_time': 'expireDateTime', 161 'expire_enabled': 'expireEnabled', 162 'external_envelope_id': 'externalEnvelopeId', 163 'folders': 'folders', 164 'has_comments': 'hasComments', 165 'has_form_data_changed': 'hasFormDataChanged', 166 'has_wav_file': 'hasWavFile', 167 'holder': 'holder', 168 'initial_sent_date_time': 'initialSentDateTime', 169 'is21_cfr_part11': 'is21CFRPart11', 170 'is_dynamic_envelope': 'isDynamicEnvelope', 171 'is_signature_provider_envelope': 'isSignatureProviderEnvelope', 172 'last_modified_date_time': 'lastModifiedDateTime', 173 'location': 'location', 174 'lock_information': 'lockInformation', 175 'message_lock': 'messageLock', 176 'notification': 'notification', 177 'notification_uri': 'notificationUri', 178 'power_form': 'powerForm', 179 'purge_completed_date': 'purgeCompletedDate', 180 'purge_request_date': 'purgeRequestDate', 181 'purge_state': 'purgeState', 182 'recipients': 'recipients', 183 'recipients_lock': 'recipientsLock', 184 'recipients_uri': 'recipientsUri', 185 'sender': 'sender', 186 'sent_date_time': 'sentDateTime', 187 'signer_can_sign_on_mobile': 'signerCanSignOnMobile', 188 'signing_location': 'signingLocation', 189 'status': 'status', 190 'status_changed_date_time': 'statusChangedDateTime', 191 'status_date_time': 'statusDateTime', 192 'templates_uri': 'templatesUri', 193 'transaction_id': 'transactionId', 194 'use_disclosure': 'useDisclosure', 195 'voided_date_time': 'voidedDateTime', 196 'voided_reason': 'voidedReason', 197 'workflow': 'workflow' 198 } 199 200 def __init__(self, _configuration=None, **kwargs): # noqa: E501 201 """Envelope - a model defined in Swagger""" # noqa: E501 202 if _configuration is None: 203 _configuration = Configuration() 204 self._configuration = _configuration 205 206 self._access_control_list_base64 = None 207 self._allow_comments = None 208 self._allow_markup = None 209 self._allow_reassign = None 210 self._allow_view_history = None 211 self._any_signer = None 212 self._asynchronous = None 213 self._attachments_uri = None 214 self._authoritative_copy = None 215 self._authoritative_copy_default = None 216 self._auto_navigation = None 217 self._brand_id = None 218 self._brand_lock = None 219 self._burn_default_tab_data = None 220 self._certificate_uri = None 221 self._completed_date_time = None 222 self._copy_recipient_data = None 223 self._created_date_time = None 224 self._custom_fields = None 225 self._custom_fields_uri = None 226 self._declined_date_time = None 227 self._deleted_date_time = None 228 self._delivered_date_time = None 229 self._disable_responsive_document = None 230 self._document_base64 = None 231 self._documents_combined_uri = None 232 self._documents_uri = None 233 self._email_blurb = None 234 self._email_settings = None 235 self._email_subject = None 236 self._enable_wet_sign = None 237 self._enforce_signer_visibility = None 238 self._envelope_attachments = None 239 self._envelope_custom_metadata = None 240 self._envelope_documents = None 241 self._envelope_id = None 242 self._envelope_id_stamping = None 243 self._envelope_location = None 244 self._envelope_metadata = None 245 self._envelope_uri = None 246 self._expire_after = None 247 self._expire_date_time = None 248 self._expire_enabled = None 249 self._external_envelope_id = None 250 self._folders = None 251 self._has_comments = None 252 self._has_form_data_changed = None 253 self._has_wav_file = None 254 self._holder = None 255 self._initial_sent_date_time = None 256 self._is21_cfr_part11 = None 257 self._is_dynamic_envelope = None 258 self._is_signature_provider_envelope = None 259 self._last_modified_date_time = None 260 self._location = None 261 self._lock_information = None 262 self._message_lock = None 263 self._notification = None 264 self._notification_uri = None 265 self._power_form = None 266 self._purge_completed_date = None 267 self._purge_request_date = None 268 self._purge_state = None 269 self._recipients = None 270 self._recipients_lock = None 271 self._recipients_uri = None 272 self._sender = None 273 self._sent_date_time = None 274 self._signer_can_sign_on_mobile = None 275 self._signing_location = None 276 self._status = None 277 self._status_changed_date_time = None 278 self._status_date_time = None 279 self._templates_uri = None 280 self._transaction_id = None 281 self._use_disclosure = None 282 self._voided_date_time = None 283 self._voided_reason = None 284 self._workflow = None 285 self.discriminator = None 286 287 setattr(self, "_{}".format('access_control_list_base64'), kwargs.get('access_control_list_base64', None)) 288 setattr(self, "_{}".format('allow_comments'), kwargs.get('allow_comments', None)) 289 setattr(self, "_{}".format('allow_markup'), kwargs.get('allow_markup', None)) 290 setattr(self, "_{}".format('allow_reassign'), kwargs.get('allow_reassign', None)) 291 setattr(self, "_{}".format('allow_view_history'), kwargs.get('allow_view_history', None)) 292 setattr(self, "_{}".format('any_signer'), kwargs.get('any_signer', None)) 293 setattr(self, "_{}".format('asynchronous'), kwargs.get('asynchronous', None)) 294 setattr(self, "_{}".format('attachments_uri'), kwargs.get('attachments_uri', None)) 295 setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) 296 setattr(self, "_{}".format('authoritative_copy_default'), kwargs.get('authoritative_copy_default', None)) 297 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 298 setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None)) 299 setattr(self, "_{}".format('brand_lock'), kwargs.get('brand_lock', None)) 300 setattr(self, "_{}".format('burn_default_tab_data'), kwargs.get('burn_default_tab_data', None)) 301 setattr(self, "_{}".format('certificate_uri'), kwargs.get('certificate_uri', None)) 302 setattr(self, "_{}".format('completed_date_time'), kwargs.get('completed_date_time', None)) 303 setattr(self, "_{}".format('copy_recipient_data'), kwargs.get('copy_recipient_data', None)) 304 setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None)) 305 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 306 setattr(self, "_{}".format('custom_fields_uri'), kwargs.get('custom_fields_uri', None)) 307 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 308 setattr(self, "_{}".format('deleted_date_time'), kwargs.get('deleted_date_time', None)) 309 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 310 setattr(self, "_{}".format('disable_responsive_document'), kwargs.get('disable_responsive_document', None)) 311 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 312 setattr(self, "_{}".format('documents_combined_uri'), kwargs.get('documents_combined_uri', None)) 313 setattr(self, "_{}".format('documents_uri'), kwargs.get('documents_uri', None)) 314 setattr(self, "_{}".format('email_blurb'), kwargs.get('email_blurb', None)) 315 setattr(self, "_{}".format('email_settings'), kwargs.get('email_settings', None)) 316 setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None)) 317 setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None)) 318 setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None)) 319 setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None)) 320 setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None)) 321 setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None)) 322 setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None)) 323 setattr(self, "_{}".format('envelope_id_stamping'), kwargs.get('envelope_id_stamping', None)) 324 setattr(self, "_{}".format('envelope_location'), kwargs.get('envelope_location', None)) 325 setattr(self, "_{}".format('envelope_metadata'), kwargs.get('envelope_metadata', None)) 326 setattr(self, "_{}".format('envelope_uri'), kwargs.get('envelope_uri', None)) 327 setattr(self, "_{}".format('expire_after'), kwargs.get('expire_after', None)) 328 setattr(self, "_{}".format('expire_date_time'), kwargs.get('expire_date_time', None)) 329 setattr(self, "_{}".format('expire_enabled'), kwargs.get('expire_enabled', None)) 330 setattr(self, "_{}".format('external_envelope_id'), kwargs.get('external_envelope_id', None)) 331 setattr(self, "_{}".format('folders'), kwargs.get('folders', None)) 332 setattr(self, "_{}".format('has_comments'), kwargs.get('has_comments', None)) 333 setattr(self, "_{}".format('has_form_data_changed'), kwargs.get('has_form_data_changed', None)) 334 setattr(self, "_{}".format('has_wav_file'), kwargs.get('has_wav_file', None)) 335 setattr(self, "_{}".format('holder'), kwargs.get('holder', None)) 336 setattr(self, "_{}".format('initial_sent_date_time'), kwargs.get('initial_sent_date_time', None)) 337 setattr(self, "_{}".format('is21_cfr_part11'), kwargs.get('is21_cfr_part11', None)) 338 setattr(self, "_{}".format('is_dynamic_envelope'), kwargs.get('is_dynamic_envelope', None)) 339 setattr(self, "_{}".format('is_signature_provider_envelope'), kwargs.get('is_signature_provider_envelope', None)) 340 setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None)) 341 setattr(self, "_{}".format('location'), kwargs.get('location', None)) 342 setattr(self, "_{}".format('lock_information'), kwargs.get('lock_information', None)) 343 setattr(self, "_{}".format('message_lock'), kwargs.get('message_lock', None)) 344 setattr(self, "_{}".format('notification'), kwargs.get('notification', None)) 345 setattr(self, "_{}".format('notification_uri'), kwargs.get('notification_uri', None)) 346 setattr(self, "_{}".format('power_form'), kwargs.get('power_form', None)) 347 setattr(self, "_{}".format('purge_completed_date'), kwargs.get('purge_completed_date', None)) 348 setattr(self, "_{}".format('purge_request_date'), kwargs.get('purge_request_date', None)) 349 setattr(self, "_{}".format('purge_state'), kwargs.get('purge_state', None)) 350 setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None)) 351 setattr(self, "_{}".format('recipients_lock'), kwargs.get('recipients_lock', None)) 352 setattr(self, "_{}".format('recipients_uri'), kwargs.get('recipients_uri', None)) 353 setattr(self, "_{}".format('sender'), kwargs.get('sender', None)) 354 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 355 setattr(self, "_{}".format('signer_can_sign_on_mobile'), kwargs.get('signer_can_sign_on_mobile', None)) 356 setattr(self, "_{}".format('signing_location'), kwargs.get('signing_location', None)) 357 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 358 setattr(self, "_{}".format('status_changed_date_time'), kwargs.get('status_changed_date_time', None)) 359 setattr(self, "_{}".format('status_date_time'), kwargs.get('status_date_time', None)) 360 setattr(self, "_{}".format('templates_uri'), kwargs.get('templates_uri', None)) 361 setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None)) 362 setattr(self, "_{}".format('use_disclosure'), kwargs.get('use_disclosure', None)) 363 setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None)) 364 setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None)) 365 setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None)) 366 367 @property 368 def access_control_list_base64(self): 369 """Gets the access_control_list_base64 of this Envelope. # noqa: E501 370 371 # noqa: E501 372 373 :return: The access_control_list_base64 of this Envelope. # noqa: E501 374 :rtype: str 375 """ 376 return self._access_control_list_base64 377 378 @access_control_list_base64.setter 379 def access_control_list_base64(self, access_control_list_base64): 380 """Sets the access_control_list_base64 of this Envelope. 381 382 # noqa: E501 383 384 :param access_control_list_base64: The access_control_list_base64 of this Envelope. # noqa: E501 385 :type: str 386 """ 387 388 self._access_control_list_base64 = access_control_list_base64 389 390 @property 391 def allow_comments(self): 392 """Gets the allow_comments of this Envelope. # noqa: E501 393 394 # noqa: E501 395 396 :return: The allow_comments of this Envelope. # noqa: E501 397 :rtype: str 398 """ 399 return self._allow_comments 400 401 @allow_comments.setter 402 def allow_comments(self, allow_comments): 403 """Sets the allow_comments of this Envelope. 404 405 # noqa: E501 406 407 :param allow_comments: The allow_comments of this Envelope. # noqa: E501 408 :type: str 409 """ 410 411 self._allow_comments = allow_comments 412 413 @property 414 def allow_markup(self): 415 """Gets the allow_markup of this Envelope. # noqa: E501 416 417 When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501 418 419 :return: The allow_markup of this Envelope. # noqa: E501 420 :rtype: str 421 """ 422 return self._allow_markup 423 424 @allow_markup.setter 425 def allow_markup(self, allow_markup): 426 """Sets the allow_markup of this Envelope. 427 428 When set to **true**, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501 429 430 :param allow_markup: The allow_markup of this Envelope. # noqa: E501 431 :type: str 432 """ 433 434 self._allow_markup = allow_markup 435 436 @property 437 def allow_reassign(self): 438 """Gets the allow_reassign of this Envelope. # noqa: E501 439 440 When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501 441 442 :return: The allow_reassign of this Envelope. # noqa: E501 443 :rtype: str 444 """ 445 return self._allow_reassign 446 447 @allow_reassign.setter 448 def allow_reassign(self, allow_reassign): 449 """Sets the allow_reassign of this Envelope. 450 451 When set to **true**, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501 452 453 :param allow_reassign: The allow_reassign of this Envelope. # noqa: E501 454 :type: str 455 """ 456 457 self._allow_reassign = allow_reassign 458 459 @property 460 def allow_view_history(self): 461 """Gets the allow_view_history of this Envelope. # noqa: E501 462 463 # noqa: E501 464 465 :return: The allow_view_history of this Envelope. # noqa: E501 466 :rtype: str 467 """ 468 return self._allow_view_history 469 470 @allow_view_history.setter 471 def allow_view_history(self, allow_view_history): 472 """Sets the allow_view_history of this Envelope. 473 474 # noqa: E501 475 476 :param allow_view_history: The allow_view_history of this Envelope. # noqa: E501 477 :type: str 478 """ 479 480 self._allow_view_history = allow_view_history 481 482 @property 483 def any_signer(self): 484 """Gets the any_signer of this Envelope. # noqa: E501 485 486 # noqa: E501 487 488 :return: The any_signer of this Envelope. # noqa: E501 489 :rtype: str 490 """ 491 return self._any_signer 492 493 @any_signer.setter 494 def any_signer(self, any_signer): 495 """Sets the any_signer of this Envelope. 496 497 # noqa: E501 498 499 :param any_signer: The any_signer of this Envelope. # noqa: E501 500 :type: str 501 """ 502 503 self._any_signer = any_signer 504 505 @property 506 def asynchronous(self): 507 """Gets the asynchronous of this Envelope. # noqa: E501 508 509 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. # noqa: E501 510 511 :return: The asynchronous of this Envelope. # noqa: E501 512 :rtype: str 513 """ 514 return self._asynchronous 515 516 @asynchronous.setter 517 def asynchronous(self, asynchronous): 518 """Sets the asynchronous of this Envelope. 519 520 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. # noqa: E501 521 522 :param asynchronous: The asynchronous of this Envelope. # noqa: E501 523 :type: str 524 """ 525 526 self._asynchronous = asynchronous 527 528 @property 529 def attachments_uri(self): 530 """Gets the attachments_uri of this Envelope. # noqa: E501 531 532 # noqa: E501 533 534 :return: The attachments_uri of this Envelope. # noqa: E501 535 :rtype: str 536 """ 537 return self._attachments_uri 538 539 @attachments_uri.setter 540 def attachments_uri(self, attachments_uri): 541 """Sets the attachments_uri of this Envelope. 542 543 # noqa: E501 544 545 :param attachments_uri: The attachments_uri of this Envelope. # noqa: E501 546 :type: str 547 """ 548 549 self._attachments_uri = attachments_uri 550 551 @property 552 def authoritative_copy(self): 553 """Gets the authoritative_copy of this Envelope. # noqa: E501 554 555 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 556 557 :return: The authoritative_copy of this Envelope. # noqa: E501 558 :rtype: str 559 """ 560 return self._authoritative_copy 561 562 @authoritative_copy.setter 563 def authoritative_copy(self, authoritative_copy): 564 """Sets the authoritative_copy of this Envelope. 565 566 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. # noqa: E501 567 568 :param authoritative_copy: The authoritative_copy of this Envelope. # noqa: E501 569 :type: str 570 """ 571 572 self._authoritative_copy = authoritative_copy 573 574 @property 575 def authoritative_copy_default(self): 576 """Gets the authoritative_copy_default of this Envelope. # noqa: E501 577 578 # noqa: E501 579 580 :return: The authoritative_copy_default of this Envelope. # noqa: E501 581 :rtype: str 582 """ 583 return self._authoritative_copy_default 584 585 @authoritative_copy_default.setter 586 def authoritative_copy_default(self, authoritative_copy_default): 587 """Sets the authoritative_copy_default of this Envelope. 588 589 # noqa: E501 590 591 :param authoritative_copy_default: The authoritative_copy_default of this Envelope. # noqa: E501 592 :type: str 593 """ 594 595 self._authoritative_copy_default = authoritative_copy_default 596 597 @property 598 def auto_navigation(self): 599 """Gets the auto_navigation of this Envelope. # noqa: E501 600 601 # noqa: E501 602 603 :return: The auto_navigation of this Envelope. # noqa: E501 604 :rtype: str 605 """ 606 return self._auto_navigation 607 608 @auto_navigation.setter 609 def auto_navigation(self, auto_navigation): 610 """Sets the auto_navigation of this Envelope. 611 612 # noqa: E501 613 614 :param auto_navigation: The auto_navigation of this Envelope. # noqa: E501 615 :type: str 616 """ 617 618 self._auto_navigation = auto_navigation 619 620 @property 621 def brand_id(self): 622 """Gets the brand_id of this Envelope. # noqa: E501 623 624 # noqa: E501 625 626 :return: The brand_id of this Envelope. # noqa: E501 627 :rtype: str 628 """ 629 return self._brand_id 630 631 @brand_id.setter 632 def brand_id(self, brand_id): 633 """Sets the brand_id of this Envelope. 634 635 # noqa: E501 636 637 :param brand_id: The brand_id of this Envelope. # noqa: E501 638 :type: str 639 """ 640 641 self._brand_id = brand_id 642 643 @property 644 def brand_lock(self): 645 """Gets the brand_lock of this Envelope. # noqa: E501 646 647 # noqa: E501 648 649 :return: The brand_lock of this Envelope. # noqa: E501 650 :rtype: str 651 """ 652 return self._brand_lock 653 654 @brand_lock.setter 655 def brand_lock(self, brand_lock): 656 """Sets the brand_lock of this Envelope. 657 658 # noqa: E501 659 660 :param brand_lock: The brand_lock of this Envelope. # noqa: E501 661 :type: str 662 """ 663 664 self._brand_lock = brand_lock 665 666 @property 667 def burn_default_tab_data(self): 668 """Gets the burn_default_tab_data of this Envelope. # noqa: E501 669 670 # noqa: E501 671 672 :return: The burn_default_tab_data of this Envelope. # noqa: E501 673 :rtype: str 674 """ 675 return self._burn_default_tab_data 676 677 @burn_default_tab_data.setter 678 def burn_default_tab_data(self, burn_default_tab_data): 679 """Sets the burn_default_tab_data of this Envelope. 680 681 # noqa: E501 682 683 :param burn_default_tab_data: The burn_default_tab_data of this Envelope. # noqa: E501 684 :type: str 685 """ 686 687 self._burn_default_tab_data = burn_default_tab_data 688 689 @property 690 def certificate_uri(self): 691 """Gets the certificate_uri of this Envelope. # noqa: E501 692 693 Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501 694 695 :return: The certificate_uri of this Envelope. # noqa: E501 696 :rtype: str 697 """ 698 return self._certificate_uri 699 700 @certificate_uri.setter 701 def certificate_uri(self, certificate_uri): 702 """Sets the certificate_uri of this Envelope. 703 704 Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501 705 706 :param certificate_uri: The certificate_uri of this Envelope. # noqa: E501 707 :type: str 708 """ 709 710 self._certificate_uri = certificate_uri 711 712 @property 713 def completed_date_time(self): 714 """Gets the completed_date_time of this Envelope. # noqa: E501 715 716 Specifies the date and time this item was completed. # noqa: E501 717 718 :return: The completed_date_time of this Envelope. # noqa: E501 719 :rtype: str 720 """ 721 return self._completed_date_time 722 723 @completed_date_time.setter 724 def completed_date_time(self, completed_date_time): 725 """Sets the completed_date_time of this Envelope. 726 727 Specifies the date and time this item was completed. # noqa: E501 728 729 :param completed_date_time: The completed_date_time of this Envelope. # noqa: E501 730 :type: str 731 """ 732 733 self._completed_date_time = completed_date_time 734 735 @property 736 def copy_recipient_data(self): 737 """Gets the copy_recipient_data of this Envelope. # noqa: E501 738 739 # noqa: E501 740 741 :return: The copy_recipient_data of this Envelope. # noqa: E501 742 :rtype: str 743 """ 744 return self._copy_recipient_data 745 746 @copy_recipient_data.setter 747 def copy_recipient_data(self, copy_recipient_data): 748 """Sets the copy_recipient_data of this Envelope. 749 750 # noqa: E501 751 752 :param copy_recipient_data: The copy_recipient_data of this Envelope. # noqa: E501 753 :type: str 754 """ 755 756 self._copy_recipient_data = copy_recipient_data 757 758 @property 759 def created_date_time(self): 760 """Gets the created_date_time of this Envelope. # noqa: E501 761 762 Indicates the date and time the item was created. # noqa: E501 763 764 :return: The created_date_time of this Envelope. # noqa: E501 765 :rtype: str 766 """ 767 return self._created_date_time 768 769 @created_date_time.setter 770 def created_date_time(self, created_date_time): 771 """Sets the created_date_time of this Envelope. 772 773 Indicates the date and time the item was created. # noqa: E501 774 775 :param created_date_time: The created_date_time of this Envelope. # noqa: E501 776 :type: str 777 """ 778 779 self._created_date_time = created_date_time 780 781 @property 782 def custom_fields(self): 783 """Gets the custom_fields of this Envelope. # noqa: E501 784 785 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501 786 787 :return: The custom_fields of this Envelope. # noqa: E501 788 :rtype: CustomFields 789 """ 790 return self._custom_fields 791 792 @custom_fields.setter 793 def custom_fields(self, custom_fields): 794 """Sets the custom_fields of this Envelope. 795 796 An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501 797 798 :param custom_fields: The custom_fields of this Envelope. # noqa: E501 799 :type: CustomFields 800 """ 801 802 self._custom_fields = custom_fields 803 804 @property 805 def custom_fields_uri(self): 806 """Gets the custom_fields_uri of this Envelope. # noqa: E501 807 808 Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501 809 810 :return: The custom_fields_uri of this Envelope. # noqa: E501 811 :rtype: str 812 """ 813 return self._custom_fields_uri 814 815 @custom_fields_uri.setter 816 def custom_fields_uri(self, custom_fields_uri): 817 """Sets the custom_fields_uri of this Envelope. 818 819 Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501 820 821 :param custom_fields_uri: The custom_fields_uri of this Envelope. # noqa: E501 822 :type: str 823 """ 824 825 self._custom_fields_uri = custom_fields_uri 826 827 @property 828 def declined_date_time(self): 829 """Gets the declined_date_time of this Envelope. # noqa: E501 830 831 The date and time the recipient declined the document. # noqa: E501 832 833 :return: The declined_date_time of this Envelope. # noqa: E501 834 :rtype: str 835 """ 836 return self._declined_date_time 837 838 @declined_date_time.setter 839 def declined_date_time(self, declined_date_time): 840 """Sets the declined_date_time of this Envelope. 841 842 The date and time the recipient declined the document. # noqa: E501 843 844 :param declined_date_time: The declined_date_time of this Envelope. # noqa: E501 845 :type: str 846 """ 847 848 self._declined_date_time = declined_date_time 849 850 @property 851 def deleted_date_time(self): 852 """Gets the deleted_date_time of this Envelope. # noqa: E501 853 854 Specifies the data and time the item was deleted. # noqa: E501 855 856 :return: The deleted_date_time of this Envelope. # noqa: E501 857 :rtype: str 858 """ 859 return self._deleted_date_time 860 861 @deleted_date_time.setter 862 def deleted_date_time(self, deleted_date_time): 863 """Sets the deleted_date_time of this Envelope. 864 865 Specifies the data and time the item was deleted. # noqa: E501 866 867 :param deleted_date_time: The deleted_date_time of this Envelope. # noqa: E501 868 :type: str 869 """ 870 871 self._deleted_date_time = deleted_date_time 872 873 @property 874 def delivered_date_time(self): 875 """Gets the delivered_date_time of this Envelope. # noqa: E501 876 877 Reserved: For DocuSign use only. # noqa: E501 878 879 :return: The delivered_date_time of this Envelope. # noqa: E501 880 :rtype: str 881 """ 882 return self._delivered_date_time 883 884 @delivered_date_time.setter 885 def delivered_date_time(self, delivered_date_time): 886 """Sets the delivered_date_time of this Envelope. 887 888 Reserved: For DocuSign use only. # noqa: E501 889 890 :param delivered_date_time: The delivered_date_time of this Envelope. # noqa: E501 891 :type: str 892 """ 893 894 self._delivered_date_time = delivered_date_time 895 896 @property 897 def disable_responsive_document(self): 898 """Gets the disable_responsive_document of this Envelope. # noqa: E501 899 900 # noqa: E501 901 902 :return: The disable_responsive_document of this Envelope. # noqa: E501 903 :rtype: str 904 """ 905 return self._disable_responsive_document 906 907 @disable_responsive_document.setter 908 def disable_responsive_document(self, disable_responsive_document): 909 """Sets the disable_responsive_document of this Envelope. 910 911 # noqa: E501 912 913 :param disable_responsive_document: The disable_responsive_document of this Envelope. # noqa: E501 914 :type: str 915 """ 916 917 self._disable_responsive_document = disable_responsive_document 918 919 @property 920 def document_base64(self): 921 """Gets the document_base64 of this Envelope. # noqa: E501 922 923 # noqa: E501 924 925 :return: The document_base64 of this Envelope. # noqa: E501 926 :rtype: str 927 """ 928 return self._document_base64 929 930 @document_base64.setter 931 def document_base64(self, document_base64): 932 """Sets the document_base64 of this Envelope. 933 934 # noqa: E501 935 936 :param document_base64: The document_base64 of this Envelope. # noqa: E501 937 :type: str 938 """ 939 940 self._document_base64 = document_base64 941 942 @property 943 def documents_combined_uri(self): 944 """Gets the documents_combined_uri of this Envelope. # noqa: E501 945 946 # noqa: E501 947 948 :return: The documents_combined_uri of this Envelope. # noqa: E501 949 :rtype: str 950 """ 951 return self._documents_combined_uri 952 953 @documents_combined_uri.setter 954 def documents_combined_uri(self, documents_combined_uri): 955 """Sets the documents_combined_uri of this Envelope. 956 957 # noqa: E501 958 959 :param documents_combined_uri: The documents_combined_uri of this Envelope. # noqa: E501 960 :type: str 961 """ 962 963 self._documents_combined_uri = documents_combined_uri 964 965 @property 966 def documents_uri(self): 967 """Gets the documents_uri of this Envelope. # noqa: E501 968 969 Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501 970 971 :return: The documents_uri of this Envelope. # noqa: E501 972 :rtype: str 973 """ 974 return self._documents_uri 975 976 @documents_uri.setter 977 def documents_uri(self, documents_uri): 978 """Sets the documents_uri of this Envelope. 979 980 Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501 981 982 :param documents_uri: The documents_uri of this Envelope. # noqa: E501 983 :type: str 984 """ 985 986 self._documents_uri = documents_uri 987 988 @property 989 def email_blurb(self): 990 """Gets the email_blurb of this Envelope. # noqa: E501 991 992 This is the same as the email body. If specified it is included in email body for all envelope recipients. # noqa: E501 993 994 :return: The email_blurb of this Envelope. # noqa: E501 995 :rtype: str 996 """ 997 return self._email_blurb 998 999 @email_blurb.setter 1000 def email_blurb(self, email_blurb): 1001 """Sets the email_blurb of this Envelope. 1002 1003 This is the same as the email body. If specified it is included in email body for all envelope recipients. # noqa: E501 1004 1005 :param email_blurb: The email_blurb of this Envelope. # noqa: E501 1006 :type: str 1007 """ 1008 1009 self._email_blurb = email_blurb 1010 1011 @property 1012 def email_settings(self): 1013 """Gets the email_settings of this Envelope. # noqa: E501 1014 1015 A complex type that contains email settings. # noqa: E501 1016 1017 :return: The email_settings of this Envelope. # noqa: E501 1018 :rtype: EmailSettings 1019 """ 1020 return self._email_settings 1021 1022 @email_settings.setter 1023 def email_settings(self, email_settings): 1024 """Sets the email_settings of this Envelope. 1025 1026 A complex type that contains email settings. # noqa: E501 1027 1028 :param email_settings: The email_settings of this Envelope. # noqa: E501 1029 :type: EmailSettings 1030 """ 1031 1032 self._email_settings = email_settings 1033 1034 @property 1035 def email_subject(self): 1036 """Gets the email_subject of this Envelope. # noqa: E501 1037 1038 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. # noqa: E501 1039 1040 :return: The email_subject of this Envelope. # noqa: E501 1041 :rtype: str 1042 """ 1043 return self._email_subject 1044 1045 @email_subject.setter 1046 def email_subject(self, email_subject): 1047 """Sets the email_subject of this Envelope. 1048 1049 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. # noqa: E501 1050 1051 :param email_subject: The email_subject of this Envelope. # noqa: E501 1052 :type: str 1053 """ 1054 1055 self._email_subject = email_subject 1056 1057 @property 1058 def enable_wet_sign(self): 1059 """Gets the enable_wet_sign of this Envelope. # noqa: E501 1060 1061 When set to **true**, the signer is allowed to print the document and sign it on paper. # noqa: E501 1062 1063 :return: The enable_wet_sign of this Envelope. # noqa: E501 1064 :rtype: str 1065 """ 1066 return self._enable_wet_sign 1067 1068 @enable_wet_sign.setter 1069 def enable_wet_sign(self, enable_wet_sign): 1070 """Sets the enable_wet_sign of this Envelope. 1071 1072 When set to **true**, the signer is allowed to print the document and sign it on paper. # noqa: E501 1073 1074 :param enable_wet_sign: The enable_wet_sign of this Envelope. # noqa: E501 1075 :type: str 1076 """ 1077 1078 self._enable_wet_sign = enable_wet_sign 1079 1080 @property 1081 def enforce_signer_visibility(self): 1082 """Gets the enforce_signer_visibility of this Envelope. # noqa: E501 1083 1084 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. # noqa: E501 1085 1086 :return: The enforce_signer_visibility of this Envelope. # noqa: E501 1087 :rtype: str 1088 """ 1089 return self._enforce_signer_visibility 1090 1091 @enforce_signer_visibility.setter 1092 def enforce_signer_visibility(self, enforce_signer_visibility): 1093 """Sets the enforce_signer_visibility of this Envelope. 1094 1095 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. # noqa: E501 1096 1097 :param enforce_signer_visibility: The enforce_signer_visibility of this Envelope. # noqa: E501 1098 :type: str 1099 """ 1100 1101 self._enforce_signer_visibility = enforce_signer_visibility 1102 1103 @property 1104 def envelope_attachments(self): 1105 """Gets the envelope_attachments of this Envelope. # noqa: E501 1106 1107 # noqa: E501 1108 1109 :return: The envelope_attachments of this Envelope. # noqa: E501 1110 :rtype: list[Attachment] 1111 """ 1112 return self._envelope_attachments 1113 1114 @envelope_attachments.setter 1115 def envelope_attachments(self, envelope_attachments): 1116 """Sets the envelope_attachments of this Envelope. 1117 1118 # noqa: E501 1119 1120 :param envelope_attachments: The envelope_attachments of this Envelope. # noqa: E501 1121 :type: list[Attachment] 1122 """ 1123 1124 self._envelope_attachments = envelope_attachments 1125 1126 @property 1127 def envelope_custom_metadata(self): 1128 """Gets the envelope_custom_metadata of this Envelope. # noqa: E501 1129 1130 # noqa: E501 1131 1132 :return: The envelope_custom_metadata of this Envelope. # noqa: E501 1133 :rtype: EnvelopeCustomMetadata 1134 """ 1135 return self._envelope_custom_metadata 1136 1137 @envelope_custom_metadata.setter 1138 def envelope_custom_metadata(self, envelope_custom_metadata): 1139 """Sets the envelope_custom_metadata of this Envelope. 1140 1141 # noqa: E501 1142 1143 :param envelope_custom_metadata: The envelope_custom_metadata of this Envelope. # noqa: E501 1144 :type: EnvelopeCustomMetadata 1145 """ 1146 1147 self._envelope_custom_metadata = envelope_custom_metadata 1148 1149 @property 1150 def envelope_documents(self): 1151 """Gets the envelope_documents of this Envelope. # noqa: E501 1152 1153 # noqa: E501 1154 1155 :return: The envelope_documents of this Envelope. # noqa: E501 1156 :rtype: list[EnvelopeDocument] 1157 """ 1158 return self._envelope_documents 1159 1160 @envelope_documents.setter 1161 def envelope_documents(self, envelope_documents): 1162 """Sets the envelope_documents of this Envelope. 1163 1164 # noqa: E501 1165 1166 :param envelope_documents: The envelope_documents of this Envelope. # noqa: E501 1167 :type: list[EnvelopeDocument] 1168 """ 1169 1170 self._envelope_documents = envelope_documents 1171 1172 @property 1173 def envelope_id(self): 1174 """Gets the envelope_id of this Envelope. # noqa: E501 1175 1176 The envelope ID of the envelope status that failed to post. # noqa: E501 1177 1178 :return: The envelope_id of this Envelope. # noqa: E501 1179 :rtype: str 1180 """ 1181 return self._envelope_id 1182 1183 @envelope_id.setter 1184 def envelope_id(self, envelope_id): 1185 """Sets the envelope_id of this Envelope. 1186 1187 The envelope ID of the envelope status that failed to post. # noqa: E501 1188 1189 :param envelope_id: The envelope_id of this Envelope. # noqa: E501 1190 :type: str 1191 """ 1192 1193 self._envelope_id = envelope_id 1194 1195 @property 1196 def envelope_id_stamping(self): 1197 """Gets the envelope_id_stamping of this Envelope. # noqa: E501 1198 1199 When set to **true**, Envelope ID Stamping is enabled. # noqa: E501 1200 1201 :return: The envelope_id_stamping of this Envelope. # noqa: E501 1202 :rtype: str 1203 """ 1204 return self._envelope_id_stamping 1205 1206 @envelope_id_stamping.setter 1207 def envelope_id_stamping(self, envelope_id_stamping): 1208 """Sets the envelope_id_stamping of this Envelope. 1209 1210 When set to **true**, Envelope ID Stamping is enabled. # noqa: E501 1211 1212 :param envelope_id_stamping: The envelope_id_stamping of this Envelope. # noqa: E501 1213 :type: str 1214 """ 1215 1216 self._envelope_id_stamping = envelope_id_stamping 1217 1218 @property 1219 def envelope_location(self): 1220 """Gets the envelope_location of this Envelope. # noqa: E501 1221 1222 # noqa: E501 1223 1224 :return: The envelope_location of this Envelope. # noqa: E501 1225 :rtype: str 1226 """ 1227 return self._envelope_location 1228 1229 @envelope_location.setter 1230 def envelope_location(self, envelope_location): 1231 """Sets the envelope_location of this Envelope. 1232 1233 # noqa: E501 1234 1235 :param envelope_location: The envelope_location of this Envelope. # noqa: E501 1236 :type: str 1237 """ 1238 1239 self._envelope_location = envelope_location 1240 1241 @property 1242 def envelope_metadata(self): 1243 """Gets the envelope_metadata of this Envelope. # noqa: E501 1244 1245 Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. # noqa: E501 1246 1247 :return: The envelope_metadata of this Envelope. # noqa: E501 1248 :rtype: EnvelopeMetadata 1249 """ 1250 return self._envelope_metadata 1251 1252 @envelope_metadata.setter 1253 def envelope_metadata(self, envelope_metadata): 1254 """Sets the envelope_metadata of this Envelope. 1255 1256 Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. # noqa: E501 1257 1258 :param envelope_metadata: The envelope_metadata of this Envelope. # noqa: E501 1259 :type: EnvelopeMetadata 1260 """ 1261 1262 self._envelope_metadata = envelope_metadata 1263 1264 @property 1265 def envelope_uri(self): 1266 """Gets the envelope_uri of this Envelope. # noqa: E501 1267 1268 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501 1269 1270 :return: The envelope_uri of this Envelope. # noqa: E501 1271 :rtype: str 1272 """ 1273 return self._envelope_uri 1274 1275 @envelope_uri.setter 1276 def envelope_uri(self, envelope_uri): 1277 """Sets the envelope_uri of this Envelope. 1278 1279 Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501 1280 1281 :param envelope_uri: The envelope_uri of this Envelope. # noqa: E501 1282 :type: str 1283 """ 1284 1285 self._envelope_uri = envelope_uri 1286 1287 @property 1288 def expire_after(self): 1289 """Gets the expire_after of this Envelope. # noqa: E501 1290 1291 # noqa: E501 1292 1293 :return: The expire_after of this Envelope. # noqa: E501 1294 :rtype: str 1295 """ 1296 return self._expire_after 1297 1298 @expire_after.setter 1299 def expire_after(self, expire_after): 1300 """Sets the expire_after of this Envelope. 1301 1302 # noqa: E501 1303 1304 :param expire_after: The expire_after of this Envelope. # noqa: E501 1305 :type: str 1306 """ 1307 1308 self._expire_after = expire_after 1309 1310 @property 1311 def expire_date_time(self): 1312 """Gets the expire_date_time of this Envelope. # noqa: E501 1313 1314 # noqa: E501 1315 1316 :return: The expire_date_time of this Envelope. # noqa: E501 1317 :rtype: str 1318 """ 1319 return self._expire_date_time 1320 1321 @expire_date_time.setter 1322 def expire_date_time(self, expire_date_time): 1323 """Sets the expire_date_time of this Envelope. 1324 1325 # noqa: E501 1326 1327 :param expire_date_time: The expire_date_time of this Envelope. # noqa: E501 1328 :type: str 1329 """ 1330 1331 self._expire_date_time = expire_date_time 1332 1333 @property 1334 def expire_enabled(self): 1335 """Gets the expire_enabled of this Envelope. # noqa: E501 1336 1337 # noqa: E501 1338 1339 :return: The expire_enabled of this Envelope. # noqa: E501 1340 :rtype: str 1341 """ 1342 return self._expire_enabled 1343 1344 @expire_enabled.setter 1345 def expire_enabled(self, expire_enabled): 1346 """Sets the expire_enabled of this Envelope. 1347 1348 # noqa: E501 1349 1350 :param expire_enabled: The expire_enabled of this Envelope. # noqa: E501 1351 :type: str 1352 """ 1353 1354 self._expire_enabled = expire_enabled 1355 1356 @property 1357 def external_envelope_id(self): 1358 """Gets the external_envelope_id of this Envelope. # noqa: E501 1359 1360 # noqa: E501 1361 1362 :return: The external_envelope_id of this Envelope. # noqa: E501 1363 :rtype: str 1364 """ 1365 return self._external_envelope_id 1366 1367 @external_envelope_id.setter 1368 def external_envelope_id(self, external_envelope_id): 1369 """Sets the external_envelope_id of this Envelope. 1370 1371 # noqa: E501 1372 1373 :param external_envelope_id: The external_envelope_id of this Envelope. # noqa: E501 1374 :type: str 1375 """ 1376 1377 self._external_envelope_id = external_envelope_id 1378 1379 @property 1380 def folders(self): 1381 """Gets the folders of this Envelope. # noqa: E501 1382 1383 # noqa: E501 1384 1385 :return: The folders of this Envelope. # noqa: E501 1386 :rtype: list[Folder] 1387 """ 1388 return self._folders 1389 1390 @folders.setter 1391 def folders(self, folders): 1392 """Sets the folders of this Envelope. 1393 1394 # noqa: E501 1395 1396 :param folders: The folders of this Envelope. # noqa: E501 1397 :type: list[Folder] 1398 """ 1399 1400 self._folders = folders 1401 1402 @property 1403 def has_comments(self): 1404 """Gets the has_comments of this Envelope. # noqa: E501 1405 1406 # noqa: E501 1407 1408 :return: The has_comments of this Envelope. # noqa: E501 1409 :rtype: str 1410 """ 1411 return self._has_comments 1412 1413 @has_comments.setter 1414 def has_comments(self, has_comments): 1415 """Sets the has_comments of this Envelope. 1416 1417 # noqa: E501 1418 1419 :param has_comments: The has_comments of this Envelope. # noqa: E501 1420 :type: str 1421 """ 1422 1423 self._has_comments = has_comments 1424 1425 @property 1426 def has_form_data_changed(self): 1427 """Gets the has_form_data_changed of this Envelope. # noqa: E501 1428 1429 # noqa: E501 1430 1431 :return: The has_form_data_changed of this Envelope. # noqa: E501 1432 :rtype: str 1433 """ 1434 return self._has_form_data_changed 1435 1436 @has_form_data_changed.setter 1437 def has_form_data_changed(self, has_form_data_changed): 1438 """Sets the has_form_data_changed of this Envelope. 1439 1440 # noqa: E501 1441 1442 :param has_form_data_changed: The has_form_data_changed of this Envelope. # noqa: E501 1443 :type: str 1444 """ 1445 1446 self._has_form_data_changed = has_form_data_changed 1447 1448 @property 1449 def has_wav_file(self): 1450 """Gets the has_wav_file of this Envelope. # noqa: E501 1451 1452 # noqa: E501 1453 1454 :return: The has_wav_file of this Envelope. # noqa: E501 1455 :rtype: str 1456 """ 1457 return self._has_wav_file 1458 1459 @has_wav_file.setter 1460 def has_wav_file(self, has_wav_file): 1461 """Sets the has_wav_file of this Envelope. 1462 1463 # noqa: E501 1464 1465 :param has_wav_file: The has_wav_file of this Envelope. # noqa: E501 1466 :type: str 1467 """ 1468 1469 self._has_wav_file = has_wav_file 1470 1471 @property 1472 def holder(self): 1473 """Gets the holder of this Envelope. # noqa: E501 1474 1475 # noqa: E501 1476 1477 :return: The holder of this Envelope. # noqa: E501 1478 :rtype: str 1479 """ 1480 return self._holder 1481 1482 @holder.setter 1483 def holder(self, holder): 1484 """Sets the holder of this Envelope. 1485 1486 # noqa: E501 1487 1488 :param holder: The holder of this Envelope. # noqa: E501 1489 :type: str 1490 """ 1491 1492 self._holder = holder 1493 1494 @property 1495 def initial_sent_date_time(self): 1496 """Gets the initial_sent_date_time of this Envelope. # noqa: E501 1497 1498 # noqa: E501 1499 1500 :return: The initial_sent_date_time of this Envelope. # noqa: E501 1501 :rtype: str 1502 """ 1503 return self._initial_sent_date_time 1504 1505 @initial_sent_date_time.setter 1506 def initial_sent_date_time(self, initial_sent_date_time): 1507 """Sets the initial_sent_date_time of this Envelope. 1508 1509 # noqa: E501 1510 1511 :param initial_sent_date_time: The initial_sent_date_time of this Envelope. # noqa: E501 1512 :type: str 1513 """ 1514 1515 self._initial_sent_date_time = initial_sent_date_time 1516 1517 @property 1518 def is21_cfr_part11(self): 1519 """Gets the is21_cfr_part11 of this Envelope. # noqa: E501 1520 1521 When set to **true**, indicates that this module is enabled on the account. # noqa: E501 1522 1523 :return: The is21_cfr_part11 of this Envelope. # noqa: E501 1524 :rtype: str 1525 """ 1526 return self._is21_cfr_part11 1527 1528 @is21_cfr_part11.setter 1529 def is21_cfr_part11(self, is21_cfr_part11): 1530 """Sets the is21_cfr_part11 of this Envelope. 1531 1532 When set to **true**, indicates that this module is enabled on the account. # noqa: E501 1533 1534 :param is21_cfr_part11: The is21_cfr_part11 of this Envelope. # noqa: E501 1535 :type: str 1536 """ 1537 1538 self._is21_cfr_part11 = is21_cfr_part11 1539 1540 @property 1541 def is_dynamic_envelope(self): 1542 """Gets the is_dynamic_envelope of this Envelope. # noqa: E501 1543 1544 # noqa: E501 1545 1546 :return: The is_dynamic_envelope of this Envelope. # noqa: E501 1547 :rtype: str 1548 """ 1549 return self._is_dynamic_envelope 1550 1551 @is_dynamic_envelope.setter 1552 def is_dynamic_envelope(self, is_dynamic_envelope): 1553 """Sets the is_dynamic_envelope of this Envelope. 1554 1555 # noqa: E501 1556 1557 :param is_dynamic_envelope: The is_dynamic_envelope of this Envelope. # noqa: E501 1558 :type: str 1559 """ 1560 1561 self._is_dynamic_envelope = is_dynamic_envelope 1562 1563 @property 1564 def is_signature_provider_envelope(self): 1565 """Gets the is_signature_provider_envelope of this Envelope. # noqa: E501 1566 1567 # noqa: E501 1568 1569 :return: The is_signature_provider_envelope of this Envelope. # noqa: E501 1570 :rtype: str 1571 """ 1572 return self._is_signature_provider_envelope 1573 1574 @is_signature_provider_envelope.setter 1575 def is_signature_provider_envelope(self, is_signature_provider_envelope): 1576 """Sets the is_signature_provider_envelope of this Envelope. 1577 1578 # noqa: E501 1579 1580 :param is_signature_provider_envelope: The is_signature_provider_envelope of this Envelope. # noqa: E501 1581 :type: str 1582 """ 1583 1584 self._is_signature_provider_envelope = is_signature_provider_envelope 1585 1586 @property 1587 def last_modified_date_time(self): 1588 """Gets the last_modified_date_time of this Envelope. # noqa: E501 1589 1590 The date and time the item was last modified. # noqa: E501 1591 1592 :return: The last_modified_date_time of this Envelope. # noqa: E501 1593 :rtype: str 1594 """ 1595 return self._last_modified_date_time 1596 1597 @last_modified_date_time.setter 1598 def last_modified_date_time(self, last_modified_date_time): 1599 """Sets the last_modified_date_time of this Envelope. 1600 1601 The date and time the item was last modified. # noqa: E501 1602 1603 :param last_modified_date_time: The last_modified_date_time of this Envelope. # noqa: E501 1604 :type: str 1605 """ 1606 1607 self._last_modified_date_time = last_modified_date_time 1608 1609 @property 1610 def location(self): 1611 """Gets the location of this Envelope. # noqa: E501 1612 1613 # noqa: E501 1614 1615 :return: The location of this Envelope. # noqa: E501 1616 :rtype: str 1617 """ 1618 return self._location 1619 1620 @location.setter 1621 def location(self, location): 1622 """Sets the location of this Envelope. 1623 1624 # noqa: E501 1625 1626 :param location: The location of this Envelope. # noqa: E501 1627 :type: str 1628 """ 1629 1630 self._location = location 1631 1632 @property 1633 def lock_information(self): 1634 """Gets the lock_information of this Envelope. # noqa: E501 1635 1636 Provides lock information about an envelope that a user has locked. # noqa: E501 1637 1638 :return: The lock_information of this Envelope. # noqa: E501 1639 :rtype: LockInformation 1640 """ 1641 return self._lock_information 1642 1643 @lock_information.setter 1644 def lock_information(self, lock_information): 1645 """Sets the lock_information of this Envelope. 1646 1647 Provides lock information about an envelope that a user has locked. # noqa: E501 1648 1649 :param lock_information: The lock_information of this Envelope. # noqa: E501 1650 :type: LockInformation 1651 """ 1652 1653 self._lock_information = lock_information 1654 1655 @property 1656 def message_lock(self): 1657 """Gets the message_lock of this Envelope. # noqa: E501 1658 1659 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. # noqa: E501 1660 1661 :return: The message_lock of this Envelope. # noqa: E501 1662 :rtype: str 1663 """ 1664 return self._message_lock 1665 1666 @message_lock.setter 1667 def message_lock(self, message_lock): 1668 """Sets the message_lock of this Envelope. 1669 1670 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. # noqa: E501 1671 1672 :param message_lock: The message_lock of this Envelope. # noqa: E501 1673 :type: str 1674 """ 1675 1676 self._message_lock = message_lock 1677 1678 @property 1679 def notification(self): 1680 """Gets the notification of this Envelope. # noqa: E501 1681 1682 # noqa: E501 1683 1684 :return: The notification of this Envelope. # noqa: E501 1685 :rtype: Notification 1686 """ 1687 return self._notification 1688 1689 @notification.setter 1690 def notification(self, notification): 1691 """Sets the notification of this Envelope. 1692 1693 # noqa: E501 1694 1695 :param notification: The notification of this Envelope. # noqa: E501 1696 :type: Notification 1697 """ 1698 1699 self._notification = notification 1700 1701 @property 1702 def notification_uri(self): 1703 """Gets the notification_uri of this Envelope. # noqa: E501 1704 1705 Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501 1706 1707 :return: The notification_uri of this Envelope. # noqa: E501 1708 :rtype: str 1709 """ 1710 return self._notification_uri 1711 1712 @notification_uri.setter 1713 def notification_uri(self, notification_uri): 1714 """Sets the notification_uri of this Envelope. 1715 1716 Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501 1717 1718 :param notification_uri: The notification_uri of this Envelope. # noqa: E501 1719 :type: str 1720 """ 1721 1722 self._notification_uri = notification_uri 1723 1724 @property 1725 def power_form(self): 1726 """Gets the power_form of this Envelope. # noqa: E501 1727 1728 Information about any PowerForms that are included in the envelope. # noqa: E501 1729 1730 :return: The power_form of this Envelope. # noqa: E501 1731 :rtype: PowerForm 1732 """ 1733 return self._power_form 1734 1735 @power_form.setter 1736 def power_form(self, power_form): 1737 """Sets the power_form of this Envelope. 1738 1739 Information about any PowerForms that are included in the envelope. # noqa: E501 1740 1741 :param power_form: The power_form of this Envelope. # noqa: E501 1742 :type: PowerForm 1743 """ 1744 1745 self._power_form = power_form 1746 1747 @property 1748 def purge_completed_date(self): 1749 """Gets the purge_completed_date of this Envelope. # noqa: E501 1750 1751 # noqa: E501 1752 1753 :return: The purge_completed_date of this Envelope. # noqa: E501 1754 :rtype: str 1755 """ 1756 return self._purge_completed_date 1757 1758 @purge_completed_date.setter 1759 def purge_completed_date(self, purge_completed_date): 1760 """Sets the purge_completed_date of this Envelope. 1761 1762 # noqa: E501 1763 1764 :param purge_completed_date: The purge_completed_date of this Envelope. # noqa: E501 1765 :type: str 1766 """ 1767 1768 self._purge_completed_date = purge_completed_date 1769 1770 @property 1771 def purge_request_date(self): 1772 """Gets the purge_request_date of this Envelope. # noqa: E501 1773 1774 # noqa: E501 1775 1776 :return: The purge_request_date of this Envelope. # noqa: E501 1777 :rtype: str 1778 """ 1779 return self._purge_request_date 1780 1781 @purge_request_date.setter 1782 def purge_request_date(self, purge_request_date): 1783 """Sets the purge_request_date of this Envelope. 1784 1785 # noqa: E501 1786 1787 :param purge_request_date: The purge_request_date of this Envelope. # noqa: E501 1788 :type: str 1789 """ 1790 1791 self._purge_request_date = purge_request_date 1792 1793 @property 1794 def purge_state(self): 1795 """Gets the purge_state of this Envelope. # noqa: E501 1796 1797 # noqa: E501 1798 1799 :return: The purge_state of this Envelope. # noqa: E501 1800 :rtype: str 1801 """ 1802 return self._purge_state 1803 1804 @purge_state.setter 1805 def purge_state(self, purge_state): 1806 """Sets the purge_state of this Envelope. 1807 1808 # noqa: E501 1809 1810 :param purge_state: The purge_state of this Envelope. # noqa: E501 1811 :type: str 1812 """ 1813 1814 self._purge_state = purge_state 1815 1816 @property 1817 def recipients(self): 1818 """Gets the recipients of this Envelope. # noqa: E501 1819 1820 An array of powerform recipients. # noqa: E501 1821 1822 :return: The recipients of this Envelope. # noqa: E501 1823 :rtype: Recipients 1824 """ 1825 return self._recipients 1826 1827 @recipients.setter 1828 def recipients(self, recipients): 1829 """Sets the recipients of this Envelope. 1830 1831 An array of powerform recipients. # noqa: E501 1832 1833 :param recipients: The recipients of this Envelope. # noqa: E501 1834 :type: Recipients 1835 """ 1836 1837 self._recipients = recipients 1838 1839 @property 1840 def recipients_lock(self): 1841 """Gets the recipients_lock of this Envelope. # noqa: E501 1842 1843 When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501 1844 1845 :return: The recipients_lock of this Envelope. # noqa: E501 1846 :rtype: str 1847 """ 1848 return self._recipients_lock 1849 1850 @recipients_lock.setter 1851 def recipients_lock(self, recipients_lock): 1852 """Sets the recipients_lock of this Envelope. 1853 1854 When set to **true**, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501 1855 1856 :param recipients_lock: The recipients_lock of this Envelope. # noqa: E501 1857 :type: str 1858 """ 1859 1860 self._recipients_lock = recipients_lock 1861 1862 @property 1863 def recipients_uri(self): 1864 """Gets the recipients_uri of this Envelope. # noqa: E501 1865 1866 Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501 1867 1868 :return: The recipients_uri of this Envelope. # noqa: E501 1869 :rtype: str 1870 """ 1871 return self._recipients_uri 1872 1873 @recipients_uri.setter 1874 def recipients_uri(self, recipients_uri): 1875 """Sets the recipients_uri of this Envelope. 1876 1877 Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501 1878 1879 :param recipients_uri: The recipients_uri of this Envelope. # noqa: E501 1880 :type: str 1881 """ 1882 1883 self._recipients_uri = recipients_uri 1884 1885 @property 1886 def sender(self): 1887 """Gets the sender of this Envelope. # noqa: E501 1888 1889 Information about the sender of the envelope. # noqa: E501 1890 1891 :return: The sender of this Envelope. # noqa: E501 1892 :rtype: UserInfo 1893 """ 1894 return self._sender 1895 1896 @sender.setter 1897 def sender(self, sender): 1898 """Sets the sender of this Envelope. 1899 1900 Information about the sender of the envelope. # noqa: E501 1901 1902 :param sender: The sender of this Envelope. # noqa: E501 1903 :type: UserInfo 1904 """ 1905 1906 self._sender = sender 1907 1908 @property 1909 def sent_date_time(self): 1910 """Gets the sent_date_time of this Envelope. # noqa: E501 1911 1912 The date and time the envelope was sent. # noqa: E501 1913 1914 :return: The sent_date_time of this Envelope. # noqa: E501 1915 :rtype: str 1916 """ 1917 return self._sent_date_time 1918 1919 @sent_date_time.setter 1920 def sent_date_time(self, sent_date_time): 1921 """Sets the sent_date_time of this Envelope. 1922 1923 The date and time the envelope was sent. # noqa: E501 1924 1925 :param sent_date_time: The sent_date_time of this Envelope. # noqa: E501 1926 :type: str 1927 """ 1928 1929 self._sent_date_time = sent_date_time 1930 1931 @property 1932 def signer_can_sign_on_mobile(self): 1933 """Gets the signer_can_sign_on_mobile of this Envelope. # noqa: E501 1934 1935 # noqa: E501 1936 1937 :return: The signer_can_sign_on_mobile of this Envelope. # noqa: E501 1938 :rtype: str 1939 """ 1940 return self._signer_can_sign_on_mobile 1941 1942 @signer_can_sign_on_mobile.setter 1943 def signer_can_sign_on_mobile(self, signer_can_sign_on_mobile): 1944 """Sets the signer_can_sign_on_mobile of this Envelope. 1945 1946 # noqa: E501 1947 1948 :param signer_can_sign_on_mobile: The signer_can_sign_on_mobile of this Envelope. # noqa: E501 1949 :type: str 1950 """ 1951 1952 self._signer_can_sign_on_mobile = signer_can_sign_on_mobile 1953 1954 @property 1955 def signing_location(self): 1956 """Gets the signing_location of this Envelope. # noqa: E501 1957 1958 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 1959 1960 :return: The signing_location of this Envelope. # noqa: E501 1961 :rtype: str 1962 """ 1963 return self._signing_location 1964 1965 @signing_location.setter 1966 def signing_location(self, signing_location): 1967 """Sets the signing_location of this Envelope. 1968 1969 Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501 1970 1971 :param signing_location: The signing_location of this Envelope. # noqa: E501 1972 :type: str 1973 """ 1974 1975 self._signing_location = signing_location 1976 1977 @property 1978 def status(self): 1979 """Gets the status of this Envelope. # noqa: E501 1980 1981 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. # noqa: E501 1982 1983 :return: The status of this Envelope. # noqa: E501 1984 :rtype: str 1985 """ 1986 return self._status 1987 1988 @status.setter 1989 def status(self, status): 1990 """Sets the status of this Envelope. 1991 1992 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. # noqa: E501 1993 1994 :param status: The status of this Envelope. # noqa: E501 1995 :type: str 1996 """ 1997 1998 self._status = status 1999 2000 @property 2001 def status_changed_date_time(self): 2002 """Gets the status_changed_date_time of this Envelope. # noqa: E501 2003 2004 The data and time the status changed. # noqa: E501 2005 2006 :return: The status_changed_date_time of this Envelope. # noqa: E501 2007 :rtype: str 2008 """ 2009 return self._status_changed_date_time 2010 2011 @status_changed_date_time.setter 2012 def status_changed_date_time(self, status_changed_date_time): 2013 """Sets the status_changed_date_time of this Envelope. 2014 2015 The data and time the status changed. # noqa: E501 2016 2017 :param status_changed_date_time: The status_changed_date_time of this Envelope. # noqa: E501 2018 :type: str 2019 """ 2020 2021 self._status_changed_date_time = status_changed_date_time 2022 2023 @property 2024 def status_date_time(self): 2025 """Gets the status_date_time of this Envelope. # noqa: E501 2026 2027 # noqa: E501 2028 2029 :return: The status_date_time of this Envelope. # noqa: E501 2030 :rtype: str 2031 """ 2032 return self._status_date_time 2033 2034 @status_date_time.setter 2035 def status_date_time(self, status_date_time): 2036 """Sets the status_date_time of this Envelope. 2037 2038 # noqa: E501 2039 2040 :param status_date_time: The status_date_time of this Envelope. # noqa: E501 2041 :type: str 2042 """ 2043 2044 self._status_date_time = status_date_time 2045 2046 @property 2047 def templates_uri(self): 2048 """Gets the templates_uri of this Envelope. # noqa: E501 2049 2050 Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501 2051 2052 :return: The templates_uri of this Envelope. # noqa: E501 2053 :rtype: str 2054 """ 2055 return self._templates_uri 2056 2057 @templates_uri.setter 2058 def templates_uri(self, templates_uri): 2059 """Sets the templates_uri of this Envelope. 2060 2061 Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501 2062 2063 :param templates_uri: The templates_uri of this Envelope. # noqa: E501 2064 :type: str 2065 """ 2066 2067 self._templates_uri = templates_uri 2068 2069 @property 2070 def transaction_id(self): 2071 """Gets the transaction_id of this Envelope. # noqa: E501 2072 2073 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. # noqa: E501 2074 2075 :return: The transaction_id of this Envelope. # noqa: E501 2076 :rtype: str 2077 """ 2078 return self._transaction_id 2079 2080 @transaction_id.setter 2081 def transaction_id(self, transaction_id): 2082 """Sets the transaction_id of this Envelope. 2083 2084 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. # noqa: E501 2085 2086 :param transaction_id: The transaction_id of this Envelope. # noqa: E501 2087 :type: str 2088 """ 2089 2090 self._transaction_id = transaction_id 2091 2092 @property 2093 def use_disclosure(self): 2094 """Gets the use_disclosure of this Envelope. # noqa: E501 2095 2096 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. # noqa: E501 2097 2098 :return: The use_disclosure of this Envelope. # noqa: E501 2099 :rtype: str 2100 """ 2101 return self._use_disclosure 2102 2103 @use_disclosure.setter 2104 def use_disclosure(self, use_disclosure): 2105 """Sets the use_disclosure of this Envelope. 2106 2107 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. # noqa: E501 2108 2109 :param use_disclosure: The use_disclosure of this Envelope. # noqa: E501 2110 :type: str 2111 """ 2112 2113 self._use_disclosure = use_disclosure 2114 2115 @property 2116 def voided_date_time(self): 2117 """Gets the voided_date_time of this Envelope. # noqa: E501 2118 2119 The date and time the envelope or template was voided. # noqa: E501 2120 2121 :return: The voided_date_time of this Envelope. # noqa: E501 2122 :rtype: str 2123 """ 2124 return self._voided_date_time 2125 2126 @voided_date_time.setter 2127 def voided_date_time(self, voided_date_time): 2128 """Sets the voided_date_time of this Envelope. 2129 2130 The date and time the envelope or template was voided. # noqa: E501 2131 2132 :param voided_date_time: The voided_date_time of this Envelope. # noqa: E501 2133 :type: str 2134 """ 2135 2136 self._voided_date_time = voided_date_time 2137 2138 @property 2139 def voided_reason(self): 2140 """Gets the voided_reason of this Envelope. # noqa: E501 2141 2142 The reason the envelope or template was voided. # noqa: E501 2143 2144 :return: The voided_reason of this Envelope. # noqa: E501 2145 :rtype: str 2146 """ 2147 return self._voided_reason 2148 2149 @voided_reason.setter 2150 def voided_reason(self, voided_reason): 2151 """Sets the voided_reason of this Envelope. 2152 2153 The reason the envelope or template was voided. # noqa: E501 2154 2155 :param voided_reason: The voided_reason of this Envelope. # noqa: E501 2156 :type: str 2157 """ 2158 2159 self._voided_reason = voided_reason 2160 2161 @property 2162 def workflow(self): 2163 """Gets the workflow of this Envelope. # noqa: E501 2164 2165 # noqa: E501 2166 2167 :return: The workflow of this Envelope. # noqa: E501 2168 :rtype: Workflow 2169 """ 2170 return self._workflow 2171 2172 @workflow.setter 2173 def workflow(self, workflow): 2174 """Sets the workflow of this Envelope. 2175 2176 # noqa: E501 2177 2178 :param workflow: The workflow of this Envelope. # noqa: E501 2179 :type: Workflow 2180 """ 2181 2182 self._workflow = workflow 2183 2184 def to_dict(self): 2185 """Returns the model properties as a dict""" 2186 result = {} 2187 2188 for attr, _ in six.iteritems(self.swagger_types): 2189 value = getattr(self, attr) 2190 if isinstance(value, list): 2191 result[attr] = list(map( 2192 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2193 value 2194 )) 2195 elif hasattr(value, "to_dict"): 2196 result[attr] = value.to_dict() 2197 elif isinstance(value, dict): 2198 result[attr] = dict(map( 2199 lambda item: (item[0], item[1].to_dict()) 2200 if hasattr(item[1], "to_dict") else item, 2201 value.items() 2202 )) 2203 else: 2204 result[attr] = value 2205 if issubclass(Envelope, dict): 2206 for key, value in self.items(): 2207 result[key] = value 2208 2209 return result 2210 2211 def to_str(self): 2212 """Returns the string representation of the model""" 2213 return pprint.pformat(self.to_dict()) 2214 2215 def __repr__(self): 2216 """For `print` and `pprint`""" 2217 return self.to_str() 2218 2219 def __eq__(self, other): 2220 """Returns true if both objects are equal""" 2221 if not isinstance(other, Envelope): 2222 return False 2223 2224 return self.to_dict() == other.to_dict() 2225 2226 def __ne__(self, other): 2227 """Returns true if both objects are not equal""" 2228 if not isinstance(other, Envelope): 2229 return True 2230 2231 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
Envelope(_configuration=None, **kwargs)
200 def __init__(self, _configuration=None, **kwargs): # noqa: E501 201 """Envelope - a model defined in Swagger""" # noqa: E501 202 if _configuration is None: 203 _configuration = Configuration() 204 self._configuration = _configuration 205 206 self._access_control_list_base64 = None 207 self._allow_comments = None 208 self._allow_markup = None 209 self._allow_reassign = None 210 self._allow_view_history = None 211 self._any_signer = None 212 self._asynchronous = None 213 self._attachments_uri = None 214 self._authoritative_copy = None 215 self._authoritative_copy_default = None 216 self._auto_navigation = None 217 self._brand_id = None 218 self._brand_lock = None 219 self._burn_default_tab_data = None 220 self._certificate_uri = None 221 self._completed_date_time = None 222 self._copy_recipient_data = None 223 self._created_date_time = None 224 self._custom_fields = None 225 self._custom_fields_uri = None 226 self._declined_date_time = None 227 self._deleted_date_time = None 228 self._delivered_date_time = None 229 self._disable_responsive_document = None 230 self._document_base64 = None 231 self._documents_combined_uri = None 232 self._documents_uri = None 233 self._email_blurb = None 234 self._email_settings = None 235 self._email_subject = None 236 self._enable_wet_sign = None 237 self._enforce_signer_visibility = None 238 self._envelope_attachments = None 239 self._envelope_custom_metadata = None 240 self._envelope_documents = None 241 self._envelope_id = None 242 self._envelope_id_stamping = None 243 self._envelope_location = None 244 self._envelope_metadata = None 245 self._envelope_uri = None 246 self._expire_after = None 247 self._expire_date_time = None 248 self._expire_enabled = None 249 self._external_envelope_id = None 250 self._folders = None 251 self._has_comments = None 252 self._has_form_data_changed = None 253 self._has_wav_file = None 254 self._holder = None 255 self._initial_sent_date_time = None 256 self._is21_cfr_part11 = None 257 self._is_dynamic_envelope = None 258 self._is_signature_provider_envelope = None 259 self._last_modified_date_time = None 260 self._location = None 261 self._lock_information = None 262 self._message_lock = None 263 self._notification = None 264 self._notification_uri = None 265 self._power_form = None 266 self._purge_completed_date = None 267 self._purge_request_date = None 268 self._purge_state = None 269 self._recipients = None 270 self._recipients_lock = None 271 self._recipients_uri = None 272 self._sender = None 273 self._sent_date_time = None 274 self._signer_can_sign_on_mobile = None 275 self._signing_location = None 276 self._status = None 277 self._status_changed_date_time = None 278 self._status_date_time = None 279 self._templates_uri = None 280 self._transaction_id = None 281 self._use_disclosure = None 282 self._voided_date_time = None 283 self._voided_reason = None 284 self._workflow = None 285 self.discriminator = None 286 287 setattr(self, "_{}".format('access_control_list_base64'), kwargs.get('access_control_list_base64', None)) 288 setattr(self, "_{}".format('allow_comments'), kwargs.get('allow_comments', None)) 289 setattr(self, "_{}".format('allow_markup'), kwargs.get('allow_markup', None)) 290 setattr(self, "_{}".format('allow_reassign'), kwargs.get('allow_reassign', None)) 291 setattr(self, "_{}".format('allow_view_history'), kwargs.get('allow_view_history', None)) 292 setattr(self, "_{}".format('any_signer'), kwargs.get('any_signer', None)) 293 setattr(self, "_{}".format('asynchronous'), kwargs.get('asynchronous', None)) 294 setattr(self, "_{}".format('attachments_uri'), kwargs.get('attachments_uri', None)) 295 setattr(self, "_{}".format('authoritative_copy'), kwargs.get('authoritative_copy', None)) 296 setattr(self, "_{}".format('authoritative_copy_default'), kwargs.get('authoritative_copy_default', None)) 297 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 298 setattr(self, "_{}".format('brand_id'), kwargs.get('brand_id', None)) 299 setattr(self, "_{}".format('brand_lock'), kwargs.get('brand_lock', None)) 300 setattr(self, "_{}".format('burn_default_tab_data'), kwargs.get('burn_default_tab_data', None)) 301 setattr(self, "_{}".format('certificate_uri'), kwargs.get('certificate_uri', None)) 302 setattr(self, "_{}".format('completed_date_time'), kwargs.get('completed_date_time', None)) 303 setattr(self, "_{}".format('copy_recipient_data'), kwargs.get('copy_recipient_data', None)) 304 setattr(self, "_{}".format('created_date_time'), kwargs.get('created_date_time', None)) 305 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 306 setattr(self, "_{}".format('custom_fields_uri'), kwargs.get('custom_fields_uri', None)) 307 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 308 setattr(self, "_{}".format('deleted_date_time'), kwargs.get('deleted_date_time', None)) 309 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 310 setattr(self, "_{}".format('disable_responsive_document'), kwargs.get('disable_responsive_document', None)) 311 setattr(self, "_{}".format('document_base64'), kwargs.get('document_base64', None)) 312 setattr(self, "_{}".format('documents_combined_uri'), kwargs.get('documents_combined_uri', None)) 313 setattr(self, "_{}".format('documents_uri'), kwargs.get('documents_uri', None)) 314 setattr(self, "_{}".format('email_blurb'), kwargs.get('email_blurb', None)) 315 setattr(self, "_{}".format('email_settings'), kwargs.get('email_settings', None)) 316 setattr(self, "_{}".format('email_subject'), kwargs.get('email_subject', None)) 317 setattr(self, "_{}".format('enable_wet_sign'), kwargs.get('enable_wet_sign', None)) 318 setattr(self, "_{}".format('enforce_signer_visibility'), kwargs.get('enforce_signer_visibility', None)) 319 setattr(self, "_{}".format('envelope_attachments'), kwargs.get('envelope_attachments', None)) 320 setattr(self, "_{}".format('envelope_custom_metadata'), kwargs.get('envelope_custom_metadata', None)) 321 setattr(self, "_{}".format('envelope_documents'), kwargs.get('envelope_documents', None)) 322 setattr(self, "_{}".format('envelope_id'), kwargs.get('envelope_id', None)) 323 setattr(self, "_{}".format('envelope_id_stamping'), kwargs.get('envelope_id_stamping', None)) 324 setattr(self, "_{}".format('envelope_location'), kwargs.get('envelope_location', None)) 325 setattr(self, "_{}".format('envelope_metadata'), kwargs.get('envelope_metadata', None)) 326 setattr(self, "_{}".format('envelope_uri'), kwargs.get('envelope_uri', None)) 327 setattr(self, "_{}".format('expire_after'), kwargs.get('expire_after', None)) 328 setattr(self, "_{}".format('expire_date_time'), kwargs.get('expire_date_time', None)) 329 setattr(self, "_{}".format('expire_enabled'), kwargs.get('expire_enabled', None)) 330 setattr(self, "_{}".format('external_envelope_id'), kwargs.get('external_envelope_id', None)) 331 setattr(self, "_{}".format('folders'), kwargs.get('folders', None)) 332 setattr(self, "_{}".format('has_comments'), kwargs.get('has_comments', None)) 333 setattr(self, "_{}".format('has_form_data_changed'), kwargs.get('has_form_data_changed', None)) 334 setattr(self, "_{}".format('has_wav_file'), kwargs.get('has_wav_file', None)) 335 setattr(self, "_{}".format('holder'), kwargs.get('holder', None)) 336 setattr(self, "_{}".format('initial_sent_date_time'), kwargs.get('initial_sent_date_time', None)) 337 setattr(self, "_{}".format('is21_cfr_part11'), kwargs.get('is21_cfr_part11', None)) 338 setattr(self, "_{}".format('is_dynamic_envelope'), kwargs.get('is_dynamic_envelope', None)) 339 setattr(self, "_{}".format('is_signature_provider_envelope'), kwargs.get('is_signature_provider_envelope', None)) 340 setattr(self, "_{}".format('last_modified_date_time'), kwargs.get('last_modified_date_time', None)) 341 setattr(self, "_{}".format('location'), kwargs.get('location', None)) 342 setattr(self, "_{}".format('lock_information'), kwargs.get('lock_information', None)) 343 setattr(self, "_{}".format('message_lock'), kwargs.get('message_lock', None)) 344 setattr(self, "_{}".format('notification'), kwargs.get('notification', None)) 345 setattr(self, "_{}".format('notification_uri'), kwargs.get('notification_uri', None)) 346 setattr(self, "_{}".format('power_form'), kwargs.get('power_form', None)) 347 setattr(self, "_{}".format('purge_completed_date'), kwargs.get('purge_completed_date', None)) 348 setattr(self, "_{}".format('purge_request_date'), kwargs.get('purge_request_date', None)) 349 setattr(self, "_{}".format('purge_state'), kwargs.get('purge_state', None)) 350 setattr(self, "_{}".format('recipients'), kwargs.get('recipients', None)) 351 setattr(self, "_{}".format('recipients_lock'), kwargs.get('recipients_lock', None)) 352 setattr(self, "_{}".format('recipients_uri'), kwargs.get('recipients_uri', None)) 353 setattr(self, "_{}".format('sender'), kwargs.get('sender', None)) 354 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 355 setattr(self, "_{}".format('signer_can_sign_on_mobile'), kwargs.get('signer_can_sign_on_mobile', None)) 356 setattr(self, "_{}".format('signing_location'), kwargs.get('signing_location', None)) 357 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 358 setattr(self, "_{}".format('status_changed_date_time'), kwargs.get('status_changed_date_time', None)) 359 setattr(self, "_{}".format('status_date_time'), kwargs.get('status_date_time', None)) 360 setattr(self, "_{}".format('templates_uri'), kwargs.get('templates_uri', None)) 361 setattr(self, "_{}".format('transaction_id'), kwargs.get('transaction_id', None)) 362 setattr(self, "_{}".format('use_disclosure'), kwargs.get('use_disclosure', None)) 363 setattr(self, "_{}".format('voided_date_time'), kwargs.get('voided_date_time', None)) 364 setattr(self, "_{}".format('voided_reason'), kwargs.get('voided_reason', None)) 365 setattr(self, "_{}".format('workflow'), kwargs.get('workflow', None))
Envelope - a model defined in Swagger
swagger_types = {'access_control_list_base64': 'str', 'allow_comments': 'str', 'allow_markup': 'str', 'allow_reassign': 'str', 'allow_view_history': 'str', 'any_signer': 'str', 'asynchronous': 'str', 'attachments_uri': 'str', 'authoritative_copy': 'str', 'authoritative_copy_default': 'str', 'auto_navigation': 'str', 'brand_id': 'str', 'brand_lock': 'str', 'burn_default_tab_data': 'str', 'certificate_uri': 'str', 'completed_date_time': 'str', 'copy_recipient_data': 'str', 'created_date_time': 'str', 'custom_fields': 'CustomFields', 'custom_fields_uri': 'str', 'declined_date_time': 'str', 'deleted_date_time': 'str', 'delivered_date_time': 'str', 'disable_responsive_document': 'str', 'document_base64': 'str', 'documents_combined_uri': 'str', 'documents_uri': 'str', 'email_blurb': 'str', 'email_settings': 'EmailSettings', 'email_subject': 'str', 'enable_wet_sign': 'str', 'enforce_signer_visibility': 'str', 'envelope_attachments': 'list[Attachment]', 'envelope_custom_metadata': 'EnvelopeCustomMetadata', 'envelope_documents': 'list[EnvelopeDocument]', 'envelope_id': 'str', 'envelope_id_stamping': 'str', 'envelope_location': 'str', 'envelope_metadata': 'EnvelopeMetadata', 'envelope_uri': 'str', 'expire_after': 'str', 'expire_date_time': 'str', 'expire_enabled': 'str', 'external_envelope_id': 'str', 'folders': 'list[Folder]', 'has_comments': 'str', 'has_form_data_changed': 'str', 'has_wav_file': 'str', 'holder': 'str', 'initial_sent_date_time': 'str', 'is21_cfr_part11': 'str', 'is_dynamic_envelope': 'str', 'is_signature_provider_envelope': 'str', 'last_modified_date_time': 'str', 'location': 'str', 'lock_information': 'LockInformation', 'message_lock': 'str', 'notification': 'Notification', 'notification_uri': 'str', 'power_form': 'PowerForm', 'purge_completed_date': 'str', 'purge_request_date': 'str', 'purge_state': 'str', 'recipients': 'Recipients', 'recipients_lock': 'str', 'recipients_uri': 'str', 'sender': 'UserInfo', 'sent_date_time': 'str', 'signer_can_sign_on_mobile': 'str', 'signing_location': 'str', 'status': 'str', 'status_changed_date_time': 'str', 'status_date_time': 'str', 'templates_uri': 'str', 'transaction_id': 'str', 'use_disclosure': 'str', 'voided_date_time': 'str', 'voided_reason': 'str', 'workflow': 'Workflow'}
attribute_map = {'access_control_list_base64': 'accessControlListBase64', 'allow_comments': 'allowComments', 'allow_markup': 'allowMarkup', 'allow_reassign': 'allowReassign', 'allow_view_history': 'allowViewHistory', 'any_signer': 'anySigner', 'asynchronous': 'asynchronous', 'attachments_uri': 'attachmentsUri', 'authoritative_copy': 'authoritativeCopy', 'authoritative_copy_default': 'authoritativeCopyDefault', 'auto_navigation': 'autoNavigation', 'brand_id': 'brandId', 'brand_lock': 'brandLock', 'burn_default_tab_data': 'burnDefaultTabData', 'certificate_uri': 'certificateUri', 'completed_date_time': 'completedDateTime', 'copy_recipient_data': 'copyRecipientData', 'created_date_time': 'createdDateTime', 'custom_fields': 'customFields', 'custom_fields_uri': 'customFieldsUri', 'declined_date_time': 'declinedDateTime', 'deleted_date_time': 'deletedDateTime', 'delivered_date_time': 'deliveredDateTime', 'disable_responsive_document': 'disableResponsiveDocument', 'document_base64': 'documentBase64', 'documents_combined_uri': 'documentsCombinedUri', 'documents_uri': 'documentsUri', 'email_blurb': 'emailBlurb', 'email_settings': 'emailSettings', 'email_subject': 'emailSubject', 'enable_wet_sign': 'enableWetSign', 'enforce_signer_visibility': 'enforceSignerVisibility', 'envelope_attachments': 'envelopeAttachments', 'envelope_custom_metadata': 'envelopeCustomMetadata', 'envelope_documents': 'envelopeDocuments', 'envelope_id': 'envelopeId', 'envelope_id_stamping': 'envelopeIdStamping', 'envelope_location': 'envelopeLocation', 'envelope_metadata': 'envelopeMetadata', 'envelope_uri': 'envelopeUri', 'expire_after': 'expireAfter', 'expire_date_time': 'expireDateTime', 'expire_enabled': 'expireEnabled', 'external_envelope_id': 'externalEnvelopeId', 'folders': 'folders', 'has_comments': 'hasComments', 'has_form_data_changed': 'hasFormDataChanged', 'has_wav_file': 'hasWavFile', 'holder': 'holder', 'initial_sent_date_time': 'initialSentDateTime', 'is21_cfr_part11': 'is21CFRPart11', 'is_dynamic_envelope': 'isDynamicEnvelope', 'is_signature_provider_envelope': 'isSignatureProviderEnvelope', 'last_modified_date_time': 'lastModifiedDateTime', 'location': 'location', 'lock_information': 'lockInformation', 'message_lock': 'messageLock', 'notification': 'notification', 'notification_uri': 'notificationUri', 'power_form': 'powerForm', 'purge_completed_date': 'purgeCompletedDate', 'purge_request_date': 'purgeRequestDate', 'purge_state': 'purgeState', 'recipients': 'recipients', 'recipients_lock': 'recipientsLock', 'recipients_uri': 'recipientsUri', 'sender': 'sender', 'sent_date_time': 'sentDateTime', 'signer_can_sign_on_mobile': 'signerCanSignOnMobile', 'signing_location': 'signingLocation', 'status': 'status', 'status_changed_date_time': 'statusChangedDateTime', 'status_date_time': 'statusDateTime', 'templates_uri': 'templatesUri', 'transaction_id': 'transactionId', 'use_disclosure': 'useDisclosure', 'voided_date_time': 'voidedDateTime', 'voided_reason': 'voidedReason', 'workflow': 'workflow'}
access_control_list_base64
Gets the access_control_list_base64 of this Envelope. # noqa: E501
# noqa: E501
Returns
The access_control_list_base64 of this Envelope. # noqa: E501
allow_comments
Gets the allow_comments of this Envelope. # noqa: E501
# noqa: E501
Returns
The allow_comments of this Envelope. # noqa: E501
allow_markup
Gets the allow_markup of this Envelope. # noqa: E501
When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this # noqa: E501
Returns
The allow_markup of this Envelope. # noqa: E501
allow_reassign
Gets the allow_reassign of this Envelope. # noqa: E501
When set to true, the recipient can redirect an envelope to a more appropriate recipient. # noqa: E501
Returns
The allow_reassign of this Envelope. # noqa: E501
allow_view_history
Gets the allow_view_history of this Envelope. # noqa: E501
# noqa: E501
Returns
The allow_view_history of this Envelope. # noqa: E501
any_signer
Gets the any_signer of this Envelope. # noqa: E501
# noqa: E501
Returns
The any_signer of this Envelope. # noqa: E501
asynchronous
Gets the asynchronous of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The asynchronous of this Envelope. # noqa: E501
attachments_uri
Gets the attachments_uri of this Envelope. # noqa: E501
# noqa: E501
Returns
The attachments_uri of this Envelope. # noqa: E501
brand_id
Gets the brand_id of this Envelope. # noqa: E501
# noqa: E501
Returns
The brand_id of this Envelope. # noqa: E501
brand_lock
Gets the brand_lock of this Envelope. # noqa: E501
# noqa: E501
Returns
The brand_lock of this Envelope. # noqa: E501
burn_default_tab_data
Gets the burn_default_tab_data of this Envelope. # noqa: E501
# noqa: E501
Returns
The burn_default_tab_data of this Envelope. # noqa: E501
certificate_uri
Gets the certificate_uri of this Envelope. # noqa: E501
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information. # noqa: E501
Returns
The certificate_uri of this Envelope. # noqa: E501
completed_date_time
Gets the completed_date_time of this Envelope. # noqa: E501
Specifies the date and time this item was completed. # noqa: E501
Returns
The completed_date_time of this Envelope. # noqa: E501
copy_recipient_data
Gets the copy_recipient_data of this Envelope. # noqa: E501
# noqa: E501
Returns
The copy_recipient_data of this Envelope. # noqa: E501
created_date_time
Gets the created_date_time of this Envelope. # noqa: E501
Indicates the date and time the item was created. # noqa: E501
Returns
The created_date_time of this Envelope. # noqa: E501
custom_fields
Gets the custom_fields of this Envelope. # noqa: E501
An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters. # noqa: E501
Returns
The custom_fields of this Envelope. # noqa: E501
custom_fields_uri
Gets the custom_fields_uri of this Envelope. # noqa: E501
Contains a URI for an endpoint that you can use to retrieve the custom fields. # noqa: E501
Returns
The custom_fields_uri of this Envelope. # noqa: E501
declined_date_time
Gets the declined_date_time of this Envelope. # noqa: E501
The date and time the recipient declined the document. # noqa: E501
Returns
The declined_date_time of this Envelope. # noqa: E501
deleted_date_time
Gets the deleted_date_time of this Envelope. # noqa: E501
Specifies the data and time the item was deleted. # noqa: E501
Returns
The deleted_date_time of this Envelope. # noqa: E501
delivered_date_time
Gets the delivered_date_time of this Envelope. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivered_date_time of this Envelope. # noqa: E501
disable_responsive_document
Gets the disable_responsive_document of this Envelope. # noqa: E501
# noqa: E501
Returns
The disable_responsive_document of this Envelope. # noqa: E501
document_base64
Gets the document_base64 of this Envelope. # noqa: E501
# noqa: E501
Returns
The document_base64 of this Envelope. # noqa: E501
documents_combined_uri
Gets the documents_combined_uri of this Envelope. # noqa: E501
# noqa: E501
Returns
The documents_combined_uri of this Envelope. # noqa: E501
documents_uri
Gets the documents_uri of this Envelope. # noqa: E501
Contains a URI for an endpoint that you can use to retrieve the documents. # noqa: E501
Returns
The documents_uri of this Envelope. # noqa: E501
email_blurb
Gets the email_blurb of this Envelope. # noqa: E501
This is the same as the email body. If specified it is included in email body for all envelope recipients. # noqa: E501
Returns
The email_blurb of this Envelope. # noqa: E501
email_settings
Gets the email_settings of this Envelope. # noqa: E501
A complex type that contains email settings. # noqa: E501
Returns
The email_settings of this Envelope. # noqa: E501
email_subject
Gets the email_subject of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The email_subject of this Envelope. # noqa: E501
enable_wet_sign
Gets the enable_wet_sign of this Envelope. # noqa: E501
When set to true, the signer is allowed to print the document and sign it on paper. # noqa: E501
Returns
The enable_wet_sign of this Envelope. # noqa: E501
enforce_signer_visibility
Gets the enforce_signer_visibility of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The enforce_signer_visibility of this Envelope. # noqa: E501
envelope_attachments
Gets the envelope_attachments of this Envelope. # noqa: E501
# noqa: E501
Returns
The envelope_attachments of this Envelope. # noqa: E501
envelope_custom_metadata
Gets the envelope_custom_metadata of this Envelope. # noqa: E501
# noqa: E501
Returns
The envelope_custom_metadata of this Envelope. # noqa: E501
envelope_documents
Gets the envelope_documents of this Envelope. # noqa: E501
# noqa: E501
Returns
The envelope_documents of this Envelope. # noqa: E501
envelope_id
Gets the envelope_id of this Envelope. # noqa: E501
The envelope ID of the envelope status that failed to post. # noqa: E501
Returns
The envelope_id of this Envelope. # noqa: E501
envelope_id_stamping
Gets the envelope_id_stamping of this Envelope. # noqa: E501
When set to true, Envelope ID Stamping is enabled. # noqa: E501
Returns
The envelope_id_stamping of this Envelope. # noqa: E501
envelope_location
Gets the envelope_location of this Envelope. # noqa: E501
# noqa: E501
Returns
The envelope_location of this Envelope. # noqa: E501
envelope_metadata
Gets the envelope_metadata of this Envelope. # noqa: E501
Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service. # noqa: E501
Returns
The envelope_metadata of this Envelope. # noqa: E501
envelope_uri
Gets the envelope_uri of this Envelope. # noqa: E501
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes. # noqa: E501
Returns
The envelope_uri of this Envelope. # noqa: E501
expire_after
Gets the expire_after of this Envelope. # noqa: E501
# noqa: E501
Returns
The expire_after of this Envelope. # noqa: E501
expire_date_time
Gets the expire_date_time of this Envelope. # noqa: E501
# noqa: E501
Returns
The expire_date_time of this Envelope. # noqa: E501
expire_enabled
Gets the expire_enabled of this Envelope. # noqa: E501
# noqa: E501
Returns
The expire_enabled of this Envelope. # noqa: E501
external_envelope_id
Gets the external_envelope_id of this Envelope. # noqa: E501
# noqa: E501
Returns
The external_envelope_id of this Envelope. # noqa: E501
folders
Gets the folders of this Envelope. # noqa: E501
# noqa: E501
Returns
The folders of this Envelope. # noqa: E501
has_comments
Gets the has_comments of this Envelope. # noqa: E501
# noqa: E501
Returns
The has_comments of this Envelope. # noqa: E501
has_form_data_changed
Gets the has_form_data_changed of this Envelope. # noqa: E501
# noqa: E501
Returns
The has_form_data_changed of this Envelope. # noqa: E501
has_wav_file
Gets the has_wav_file of this Envelope. # noqa: E501
# noqa: E501
Returns
The has_wav_file of this Envelope. # noqa: E501
holder
Gets the holder of this Envelope. # noqa: E501
# noqa: E501
Returns
The holder of this Envelope. # noqa: E501
initial_sent_date_time
Gets the initial_sent_date_time of this Envelope. # noqa: E501
# noqa: E501
Returns
The initial_sent_date_time of this Envelope. # noqa: E501
is21_cfr_part11
Gets the is21_cfr_part11 of this Envelope. # noqa: E501
When set to true, indicates that this module is enabled on the account. # noqa: E501
Returns
The is21_cfr_part11 of this Envelope. # noqa: E501
is_dynamic_envelope
Gets the is_dynamic_envelope of this Envelope. # noqa: E501
# noqa: E501
Returns
The is_dynamic_envelope of this Envelope. # noqa: E501
is_signature_provider_envelope
Gets the is_signature_provider_envelope of this Envelope. # noqa: E501
# noqa: E501
Returns
The is_signature_provider_envelope of this Envelope. # noqa: E501
last_modified_date_time
Gets the last_modified_date_time of this Envelope. # noqa: E501
The date and time the item was last modified. # noqa: E501
Returns
The last_modified_date_time of this Envelope. # noqa: E501
location
Gets the location of this Envelope. # noqa: E501
# noqa: E501
Returns
The location of this Envelope. # noqa: E501
lock_information
Gets the lock_information of this Envelope. # noqa: E501
Provides lock information about an envelope that a user has locked. # noqa: E501
Returns
The lock_information of this Envelope. # noqa: E501
message_lock
Gets the message_lock of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The message_lock of this Envelope. # noqa: E501
notification
Gets the notification of this Envelope. # noqa: E501
# noqa: E501
Returns
The notification of this Envelope. # noqa: E501
notification_uri
Gets the notification_uri of this Envelope. # noqa: E501
Contains a URI for an endpoint that you can use to retrieve the notifications. # noqa: E501
Returns
The notification_uri of this Envelope. # noqa: E501
power_form
Gets the power_form of this Envelope. # noqa: E501
Information about any PowerForms that are included in the envelope. # noqa: E501
Returns
The power_form of this Envelope. # noqa: E501
purge_completed_date
Gets the purge_completed_date of this Envelope. # noqa: E501
# noqa: E501
Returns
The purge_completed_date of this Envelope. # noqa: E501
purge_request_date
Gets the purge_request_date of this Envelope. # noqa: E501
# noqa: E501
Returns
The purge_request_date of this Envelope. # noqa: E501
purge_state
Gets the purge_state of this Envelope. # noqa: E501
# noqa: E501
Returns
The purge_state of this Envelope. # noqa: E501
recipients
Gets the recipients of this Envelope. # noqa: E501
An array of powerform recipients. # noqa: E501
Returns
The recipients of this Envelope. # noqa: E501
recipients_lock
Gets the recipients_lock of this Envelope. # noqa: E501
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. # noqa: E501
Returns
The recipients_lock of this Envelope. # noqa: E501
recipients_uri
Gets the recipients_uri of this Envelope. # noqa: E501
Contains a URI for an endpoint that you can use to retrieve the recipients. # noqa: E501
Returns
The recipients_uri of this Envelope. # noqa: E501
sender
Gets the sender of this Envelope. # noqa: E501
Information about the sender of the envelope. # noqa: E501
Returns
The sender of this Envelope. # noqa: E501
sent_date_time
Gets the sent_date_time of this Envelope. # noqa: E501
The date and time the envelope was sent. # noqa: E501
Returns
The sent_date_time of this Envelope. # noqa: E501
signer_can_sign_on_mobile
Gets the signer_can_sign_on_mobile of this Envelope. # noqa: E501
# noqa: E501
Returns
The signer_can_sign_on_mobile of this Envelope. # noqa: E501
signing_location
Gets the signing_location of this Envelope. # noqa: E501
Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online. # noqa: E501
Returns
The signing_location of this Envelope. # noqa: E501
status
Gets the status of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The status of this Envelope. # noqa: E501
status_changed_date_time
Gets the status_changed_date_time of this Envelope. # noqa: E501
The data and time the status changed. # noqa: E501
Returns
The status_changed_date_time of this Envelope. # noqa: E501
status_date_time
Gets the status_date_time of this Envelope. # noqa: E501
# noqa: E501
Returns
The status_date_time of this Envelope. # noqa: E501
templates_uri
Gets the templates_uri of this Envelope. # noqa: E501
Contains a URI for an endpoint which you can use to retrieve the templates. # noqa: E501
Returns
The templates_uri of this Envelope. # noqa: E501
transaction_id
Gets the transaction_id of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The transaction_id of this Envelope. # noqa: E501
use_disclosure
Gets the use_disclosure of this Envelope. # noqa: E501
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. # noqa: E501
Returns
The use_disclosure of this Envelope. # noqa: E501
voided_date_time
Gets the voided_date_time of this Envelope. # noqa: E501
The date and time the envelope or template was voided. # noqa: E501
Returns
The voided_date_time of this Envelope. # noqa: E501
voided_reason
Gets the voided_reason of this Envelope. # noqa: E501
The reason the envelope or template was voided. # noqa: E501
Returns
The voided_reason of this Envelope. # noqa: E501
workflow
Gets the workflow of this Envelope. # noqa: E501
# noqa: E501
Returns
The workflow of this Envelope. # noqa: E501
def
to_dict(self)
2184 def to_dict(self): 2185 """Returns the model properties as a dict""" 2186 result = {} 2187 2188 for attr, _ in six.iteritems(self.swagger_types): 2189 value = getattr(self, attr) 2190 if isinstance(value, list): 2191 result[attr] = list(map( 2192 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2193 value 2194 )) 2195 elif hasattr(value, "to_dict"): 2196 result[attr] = value.to_dict() 2197 elif isinstance(value, dict): 2198 result[attr] = dict(map( 2199 lambda item: (item[0], item[1].to_dict()) 2200 if hasattr(item[1], "to_dict") else item, 2201 value.items() 2202 )) 2203 else: 2204 result[attr] = value 2205 if issubclass(Envelope, dict): 2206 for key, value in self.items(): 2207 result[key] = value 2208 2209 return result
Returns the model properties as a dict