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