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