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