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