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