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