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