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