docusign_esign.models.witness
DocuSign REST API
The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 DocuSign REST API 5 6 The DocuSign REST API provides you with a powerful, convenient, and simple Web services API for interacting with DocuSign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class Witness(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_code': 'str', 37 'access_code_metadata': 'PropertyMetadata', 38 'add_access_code_to_email': 'str', 39 'additional_notifications': 'list[RecipientAdditionalNotification]', 40 'agent_can_edit_email': 'str', 41 'agent_can_edit_name': 'str', 42 'allow_system_override_for_locked_recipient': 'str', 43 'auto_navigation': 'str', 44 'auto_responded_reason': 'str', 45 'bulk_recipients_uri': 'str', 46 'bulk_send_v2_recipient': 'str', 47 'can_sign_offline': 'str', 48 'client_user_id': 'str', 49 'completed_count': 'str', 50 'consent_details_list': 'list[ConsentDetails]', 51 'creation_reason': 'str', 52 'custom_fields': 'list[str]', 53 'declined_date_time': 'str', 54 'declined_reason': 'str', 55 'default_recipient': 'str', 56 'delegated_by': 'DelegationInfo', 57 'delegated_to': 'list[DelegationInfo]', 58 'delivered_date_time': 'str', 59 'delivery_method': 'str', 60 'delivery_method_metadata': 'PropertyMetadata', 61 'designator_id': 'str', 62 'designator_id_guid': 'str', 63 'document_visibility': 'list[DocumentVisibility]', 64 'email': 'str', 65 'email_metadata': 'PropertyMetadata', 66 'email_notification': 'RecipientEmailNotification', 67 'email_recipient_post_signing_url': 'str', 68 'embedded_recipient_start_url': 'str', 69 'error_details': 'ErrorDetails', 70 'excluded_documents': 'list[str]', 71 'fax_number': 'str', 72 'fax_number_metadata': 'PropertyMetadata', 73 'first_name': 'str', 74 'first_name_metadata': 'PropertyMetadata', 75 'full_name': 'str', 76 'full_name_metadata': 'PropertyMetadata', 77 'id_check_configuration_name': 'str', 78 'id_check_configuration_name_metadata': 'PropertyMetadata', 79 'id_check_information_input': 'IdCheckInformationInput', 80 'identity_verification': 'RecipientIdentityVerification', 81 'inherit_email_notification_configuration': 'str', 82 'is_bulk_recipient': 'str', 83 'is_bulk_recipient_metadata': 'PropertyMetadata', 84 'last_name': 'str', 85 'last_name_metadata': 'PropertyMetadata', 86 'locked_recipient_phone_auth_editable': 'str', 87 'locked_recipient_sms_editable': 'str', 88 'name': 'str', 89 'name_metadata': 'PropertyMetadata', 90 'notary_id': 'str', 91 'notary_signer_email_sent': 'str', 92 'note': 'str', 93 'note_metadata': 'PropertyMetadata', 94 'offline_attributes': 'OfflineAttributes', 95 'phone_authentication': 'RecipientPhoneAuthentication', 96 'phone_number': 'RecipientPhoneNumber', 97 'proof_file': 'RecipientProofFile', 98 'recipient_attachments': 'list[RecipientAttachment]', 99 'recipient_authentication_status': 'AuthenticationStatus', 100 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 101 'recipient_id': 'str', 102 'recipient_id_guid': 'str', 103 'recipient_signature_providers': 'list[RecipientSignatureProvider]', 104 'recipient_supplies_tabs': 'str', 105 'recipient_type': 'str', 106 'recipient_type_metadata': 'PropertyMetadata', 107 'require_id_lookup': 'str', 108 'require_id_lookup_metadata': 'PropertyMetadata', 109 'require_signer_certificate': 'str', 110 'require_sign_on_paper': 'str', 111 'require_upload_signature': 'str', 112 'role_name': 'str', 113 'routing_order': 'str', 114 'routing_order_metadata': 'PropertyMetadata', 115 'sent_date_time': 'str', 116 'signature_info': 'RecipientSignatureInformation', 117 'signed_date_time': 'str', 118 'sign_in_each_location': 'str', 119 'sign_in_each_location_metadata': 'PropertyMetadata', 120 'signing_group_id': 'str', 121 'signing_group_id_metadata': 'PropertyMetadata', 122 'signing_group_name': 'str', 123 'signing_group_users': 'list[UserInfo]', 124 'sms_authentication': 'RecipientSMSAuthentication', 125 'social_authentications': 'list[SocialAuthentication]', 126 'status': 'str', 127 'status_code': 'str', 128 'suppress_emails': 'str', 129 'tabs': 'Tabs', 130 'template_locked': 'str', 131 'template_required': 'str', 132 'total_tab_count': 'str', 133 'user_id': 'str', 134 'witness_for': 'str', 135 'witness_for_guid': 'str' 136 } 137 138 attribute_map = { 139 'access_code': 'accessCode', 140 'access_code_metadata': 'accessCodeMetadata', 141 'add_access_code_to_email': 'addAccessCodeToEmail', 142 'additional_notifications': 'additionalNotifications', 143 'agent_can_edit_email': 'agentCanEditEmail', 144 'agent_can_edit_name': 'agentCanEditName', 145 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 146 'auto_navigation': 'autoNavigation', 147 'auto_responded_reason': 'autoRespondedReason', 148 'bulk_recipients_uri': 'bulkRecipientsUri', 149 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 150 'can_sign_offline': 'canSignOffline', 151 'client_user_id': 'clientUserId', 152 'completed_count': 'completedCount', 153 'consent_details_list': 'consentDetailsList', 154 'creation_reason': 'creationReason', 155 'custom_fields': 'customFields', 156 'declined_date_time': 'declinedDateTime', 157 'declined_reason': 'declinedReason', 158 'default_recipient': 'defaultRecipient', 159 'delegated_by': 'delegatedBy', 160 'delegated_to': 'delegatedTo', 161 'delivered_date_time': 'deliveredDateTime', 162 'delivery_method': 'deliveryMethod', 163 'delivery_method_metadata': 'deliveryMethodMetadata', 164 'designator_id': 'designatorId', 165 'designator_id_guid': 'designatorIdGuid', 166 'document_visibility': 'documentVisibility', 167 'email': 'email', 168 'email_metadata': 'emailMetadata', 169 'email_notification': 'emailNotification', 170 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 171 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 172 'error_details': 'errorDetails', 173 'excluded_documents': 'excludedDocuments', 174 'fax_number': 'faxNumber', 175 'fax_number_metadata': 'faxNumberMetadata', 176 'first_name': 'firstName', 177 'first_name_metadata': 'firstNameMetadata', 178 'full_name': 'fullName', 179 'full_name_metadata': 'fullNameMetadata', 180 'id_check_configuration_name': 'idCheckConfigurationName', 181 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 182 'id_check_information_input': 'idCheckInformationInput', 183 'identity_verification': 'identityVerification', 184 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 185 'is_bulk_recipient': 'isBulkRecipient', 186 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata', 187 'last_name': 'lastName', 188 'last_name_metadata': 'lastNameMetadata', 189 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 190 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 191 'name': 'name', 192 'name_metadata': 'nameMetadata', 193 'notary_id': 'notaryId', 194 'notary_signer_email_sent': 'notarySignerEmailSent', 195 'note': 'note', 196 'note_metadata': 'noteMetadata', 197 'offline_attributes': 'offlineAttributes', 198 'phone_authentication': 'phoneAuthentication', 199 'phone_number': 'phoneNumber', 200 'proof_file': 'proofFile', 201 'recipient_attachments': 'recipientAttachments', 202 'recipient_authentication_status': 'recipientAuthenticationStatus', 203 'recipient_feature_metadata': 'recipientFeatureMetadata', 204 'recipient_id': 'recipientId', 205 'recipient_id_guid': 'recipientIdGuid', 206 'recipient_signature_providers': 'recipientSignatureProviders', 207 'recipient_supplies_tabs': 'recipientSuppliesTabs', 208 'recipient_type': 'recipientType', 209 'recipient_type_metadata': 'recipientTypeMetadata', 210 'require_id_lookup': 'requireIdLookup', 211 'require_id_lookup_metadata': 'requireIdLookupMetadata', 212 'require_signer_certificate': 'requireSignerCertificate', 213 'require_sign_on_paper': 'requireSignOnPaper', 214 'require_upload_signature': 'requireUploadSignature', 215 'role_name': 'roleName', 216 'routing_order': 'routingOrder', 217 'routing_order_metadata': 'routingOrderMetadata', 218 'sent_date_time': 'sentDateTime', 219 'signature_info': 'signatureInfo', 220 'signed_date_time': 'signedDateTime', 221 'sign_in_each_location': 'signInEachLocation', 222 'sign_in_each_location_metadata': 'signInEachLocationMetadata', 223 'signing_group_id': 'signingGroupId', 224 'signing_group_id_metadata': 'signingGroupIdMetadata', 225 'signing_group_name': 'signingGroupName', 226 'signing_group_users': 'signingGroupUsers', 227 'sms_authentication': 'smsAuthentication', 228 'social_authentications': 'socialAuthentications', 229 'status': 'status', 230 'status_code': 'statusCode', 231 'suppress_emails': 'suppressEmails', 232 'tabs': 'tabs', 233 'template_locked': 'templateLocked', 234 'template_required': 'templateRequired', 235 'total_tab_count': 'totalTabCount', 236 'user_id': 'userId', 237 'witness_for': 'witnessFor', 238 'witness_for_guid': 'witnessForGuid' 239 } 240 241 def __init__(self, _configuration=None, **kwargs): # noqa: E501 242 """Witness - a model defined in Swagger""" # noqa: E501 243 if _configuration is None: 244 _configuration = Configuration() 245 self._configuration = _configuration 246 247 self._access_code = None 248 self._access_code_metadata = None 249 self._add_access_code_to_email = None 250 self._additional_notifications = None 251 self._agent_can_edit_email = None 252 self._agent_can_edit_name = None 253 self._allow_system_override_for_locked_recipient = None 254 self._auto_navigation = None 255 self._auto_responded_reason = None 256 self._bulk_recipients_uri = None 257 self._bulk_send_v2_recipient = None 258 self._can_sign_offline = None 259 self._client_user_id = None 260 self._completed_count = None 261 self._consent_details_list = None 262 self._creation_reason = None 263 self._custom_fields = None 264 self._declined_date_time = None 265 self._declined_reason = None 266 self._default_recipient = None 267 self._delegated_by = None 268 self._delegated_to = None 269 self._delivered_date_time = None 270 self._delivery_method = None 271 self._delivery_method_metadata = None 272 self._designator_id = None 273 self._designator_id_guid = None 274 self._document_visibility = None 275 self._email = None 276 self._email_metadata = None 277 self._email_notification = None 278 self._email_recipient_post_signing_url = None 279 self._embedded_recipient_start_url = None 280 self._error_details = None 281 self._excluded_documents = None 282 self._fax_number = None 283 self._fax_number_metadata = None 284 self._first_name = None 285 self._first_name_metadata = None 286 self._full_name = None 287 self._full_name_metadata = None 288 self._id_check_configuration_name = None 289 self._id_check_configuration_name_metadata = None 290 self._id_check_information_input = None 291 self._identity_verification = None 292 self._inherit_email_notification_configuration = None 293 self._is_bulk_recipient = None 294 self._is_bulk_recipient_metadata = None 295 self._last_name = None 296 self._last_name_metadata = None 297 self._locked_recipient_phone_auth_editable = None 298 self._locked_recipient_sms_editable = None 299 self._name = None 300 self._name_metadata = None 301 self._notary_id = None 302 self._notary_signer_email_sent = None 303 self._note = None 304 self._note_metadata = None 305 self._offline_attributes = None 306 self._phone_authentication = None 307 self._phone_number = None 308 self._proof_file = None 309 self._recipient_attachments = None 310 self._recipient_authentication_status = None 311 self._recipient_feature_metadata = None 312 self._recipient_id = None 313 self._recipient_id_guid = None 314 self._recipient_signature_providers = None 315 self._recipient_supplies_tabs = None 316 self._recipient_type = None 317 self._recipient_type_metadata = None 318 self._require_id_lookup = None 319 self._require_id_lookup_metadata = None 320 self._require_signer_certificate = None 321 self._require_sign_on_paper = None 322 self._require_upload_signature = None 323 self._role_name = None 324 self._routing_order = None 325 self._routing_order_metadata = None 326 self._sent_date_time = None 327 self._signature_info = None 328 self._signed_date_time = None 329 self._sign_in_each_location = None 330 self._sign_in_each_location_metadata = None 331 self._signing_group_id = None 332 self._signing_group_id_metadata = None 333 self._signing_group_name = None 334 self._signing_group_users = None 335 self._sms_authentication = None 336 self._social_authentications = None 337 self._status = None 338 self._status_code = None 339 self._suppress_emails = None 340 self._tabs = None 341 self._template_locked = None 342 self._template_required = None 343 self._total_tab_count = None 344 self._user_id = None 345 self._witness_for = None 346 self._witness_for_guid = None 347 self.discriminator = None 348 349 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 350 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 351 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 352 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 353 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 354 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 355 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 356 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 357 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 358 setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None)) 359 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 360 setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None)) 361 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 362 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 363 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 364 setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None)) 365 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 366 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 367 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 368 setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None)) 369 setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None)) 370 setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None)) 371 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 372 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 373 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 374 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 375 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 376 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 377 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 378 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 379 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 380 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 381 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 382 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 383 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 384 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 385 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 386 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 387 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 388 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 389 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 390 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 391 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 392 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 393 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 394 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 395 setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None)) 396 setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None)) 397 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 398 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 399 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 400 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 401 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 402 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 403 setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None)) 404 setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None)) 405 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 406 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 407 setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None)) 408 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 409 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 410 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 411 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 412 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 413 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 414 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 415 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 416 setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None)) 417 setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None)) 418 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 419 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 420 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 421 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 422 setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None)) 423 setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None)) 424 setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None)) 425 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 426 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 427 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 428 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 429 setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None)) 430 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 431 setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None)) 432 setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None)) 433 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 434 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 435 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 436 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 437 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 438 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 439 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 440 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 441 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 442 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 443 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 444 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 445 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 446 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 447 setattr(self, "_{}".format('witness_for'), kwargs.get('witness_for', None)) 448 setattr(self, "_{}".format('witness_for_guid'), kwargs.get('witness_for_guid', None)) 449 450 @property 451 def access_code(self): 452 """Gets the access_code of this Witness. # noqa: E501 453 454 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 455 456 :return: The access_code of this Witness. # noqa: E501 457 :rtype: str 458 """ 459 return self._access_code 460 461 @access_code.setter 462 def access_code(self, access_code): 463 """Sets the access_code of this Witness. 464 465 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 466 467 :param access_code: The access_code of this Witness. # noqa: E501 468 :type: str 469 """ 470 471 self._access_code = access_code 472 473 @property 474 def access_code_metadata(self): 475 """Gets the access_code_metadata of this Witness. # noqa: E501 476 477 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 478 479 :return: The access_code_metadata of this Witness. # noqa: E501 480 :rtype: PropertyMetadata 481 """ 482 return self._access_code_metadata 483 484 @access_code_metadata.setter 485 def access_code_metadata(self, access_code_metadata): 486 """Sets the access_code_metadata of this Witness. 487 488 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 489 490 :param access_code_metadata: The access_code_metadata of this Witness. # noqa: E501 491 :type: PropertyMetadata 492 """ 493 494 self._access_code_metadata = access_code_metadata 495 496 @property 497 def add_access_code_to_email(self): 498 """Gets the add_access_code_to_email of this Witness. # noqa: E501 499 500 This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501 501 502 :return: The add_access_code_to_email of this Witness. # noqa: E501 503 :rtype: str 504 """ 505 return self._add_access_code_to_email 506 507 @add_access_code_to_email.setter 508 def add_access_code_to_email(self, add_access_code_to_email): 509 """Sets the add_access_code_to_email of this Witness. 510 511 This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501 512 513 :param add_access_code_to_email: The add_access_code_to_email of this Witness. # noqa: E501 514 :type: str 515 """ 516 517 self._add_access_code_to_email = add_access_code_to_email 518 519 @property 520 def additional_notifications(self): 521 """Gets the additional_notifications of this Witness. # noqa: E501 522 523 # noqa: E501 524 525 :return: The additional_notifications of this Witness. # noqa: E501 526 :rtype: list[RecipientAdditionalNotification] 527 """ 528 return self._additional_notifications 529 530 @additional_notifications.setter 531 def additional_notifications(self, additional_notifications): 532 """Sets the additional_notifications of this Witness. 533 534 # noqa: E501 535 536 :param additional_notifications: The additional_notifications of this Witness. # noqa: E501 537 :type: list[RecipientAdditionalNotification] 538 """ 539 540 self._additional_notifications = additional_notifications 541 542 @property 543 def agent_can_edit_email(self): 544 """Gets the agent_can_edit_email of this Witness. # noqa: E501 545 546 # noqa: E501 547 548 :return: The agent_can_edit_email of this Witness. # noqa: E501 549 :rtype: str 550 """ 551 return self._agent_can_edit_email 552 553 @agent_can_edit_email.setter 554 def agent_can_edit_email(self, agent_can_edit_email): 555 """Sets the agent_can_edit_email of this Witness. 556 557 # noqa: E501 558 559 :param agent_can_edit_email: The agent_can_edit_email of this Witness. # noqa: E501 560 :type: str 561 """ 562 563 self._agent_can_edit_email = agent_can_edit_email 564 565 @property 566 def agent_can_edit_name(self): 567 """Gets the agent_can_edit_name of this Witness. # noqa: E501 568 569 # noqa: E501 570 571 :return: The agent_can_edit_name of this Witness. # noqa: E501 572 :rtype: str 573 """ 574 return self._agent_can_edit_name 575 576 @agent_can_edit_name.setter 577 def agent_can_edit_name(self, agent_can_edit_name): 578 """Sets the agent_can_edit_name of this Witness. 579 580 # noqa: E501 581 582 :param agent_can_edit_name: The agent_can_edit_name of this Witness. # noqa: E501 583 :type: str 584 """ 585 586 self._agent_can_edit_name = agent_can_edit_name 587 588 @property 589 def allow_system_override_for_locked_recipient(self): 590 """Gets the allow_system_override_for_locked_recipient of this Witness. # noqa: E501 591 592 # noqa: E501 593 594 :return: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 595 :rtype: str 596 """ 597 return self._allow_system_override_for_locked_recipient 598 599 @allow_system_override_for_locked_recipient.setter 600 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 601 """Sets the allow_system_override_for_locked_recipient of this Witness. 602 603 # noqa: E501 604 605 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 606 :type: str 607 """ 608 609 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 610 611 @property 612 def auto_navigation(self): 613 """Gets the auto_navigation of this Witness. # noqa: E501 614 615 # noqa: E501 616 617 :return: The auto_navigation of this Witness. # noqa: E501 618 :rtype: str 619 """ 620 return self._auto_navigation 621 622 @auto_navigation.setter 623 def auto_navigation(self, auto_navigation): 624 """Sets the auto_navigation of this Witness. 625 626 # noqa: E501 627 628 :param auto_navigation: The auto_navigation of this Witness. # noqa: E501 629 :type: str 630 """ 631 632 self._auto_navigation = auto_navigation 633 634 @property 635 def auto_responded_reason(self): 636 """Gets the auto_responded_reason of this Witness. # noqa: E501 637 638 # noqa: E501 639 640 :return: The auto_responded_reason of this Witness. # noqa: E501 641 :rtype: str 642 """ 643 return self._auto_responded_reason 644 645 @auto_responded_reason.setter 646 def auto_responded_reason(self, auto_responded_reason): 647 """Sets the auto_responded_reason of this Witness. 648 649 # noqa: E501 650 651 :param auto_responded_reason: The auto_responded_reason of this Witness. # noqa: E501 652 :type: str 653 """ 654 655 self._auto_responded_reason = auto_responded_reason 656 657 @property 658 def bulk_recipients_uri(self): 659 """Gets the bulk_recipients_uri of this Witness. # noqa: E501 660 661 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 662 663 :return: The bulk_recipients_uri of this Witness. # noqa: E501 664 :rtype: str 665 """ 666 return self._bulk_recipients_uri 667 668 @bulk_recipients_uri.setter 669 def bulk_recipients_uri(self, bulk_recipients_uri): 670 """Sets the bulk_recipients_uri of this Witness. 671 672 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 673 674 :param bulk_recipients_uri: The bulk_recipients_uri of this Witness. # noqa: E501 675 :type: str 676 """ 677 678 self._bulk_recipients_uri = bulk_recipients_uri 679 680 @property 681 def bulk_send_v2_recipient(self): 682 """Gets the bulk_send_v2_recipient of this Witness. # noqa: E501 683 684 # noqa: E501 685 686 :return: The bulk_send_v2_recipient of this Witness. # noqa: E501 687 :rtype: str 688 """ 689 return self._bulk_send_v2_recipient 690 691 @bulk_send_v2_recipient.setter 692 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 693 """Sets the bulk_send_v2_recipient of this Witness. 694 695 # noqa: E501 696 697 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this Witness. # noqa: E501 698 :type: str 699 """ 700 701 self._bulk_send_v2_recipient = bulk_send_v2_recipient 702 703 @property 704 def can_sign_offline(self): 705 """Gets the can_sign_offline of this Witness. # noqa: E501 706 707 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 708 709 :return: The can_sign_offline of this Witness. # noqa: E501 710 :rtype: str 711 """ 712 return self._can_sign_offline 713 714 @can_sign_offline.setter 715 def can_sign_offline(self, can_sign_offline): 716 """Sets the can_sign_offline of this Witness. 717 718 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 719 720 :param can_sign_offline: The can_sign_offline of this Witness. # noqa: E501 721 :type: str 722 """ 723 724 self._can_sign_offline = can_sign_offline 725 726 @property 727 def client_user_id(self): 728 """Gets the client_user_id of this Witness. # noqa: E501 729 730 Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501 731 732 :return: The client_user_id of this Witness. # noqa: E501 733 :rtype: str 734 """ 735 return self._client_user_id 736 737 @client_user_id.setter 738 def client_user_id(self, client_user_id): 739 """Sets the client_user_id of this Witness. 740 741 Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501 742 743 :param client_user_id: The client_user_id of this Witness. # noqa: E501 744 :type: str 745 """ 746 747 self._client_user_id = client_user_id 748 749 @property 750 def completed_count(self): 751 """Gets the completed_count of this Witness. # noqa: E501 752 753 # noqa: E501 754 755 :return: The completed_count of this Witness. # noqa: E501 756 :rtype: str 757 """ 758 return self._completed_count 759 760 @completed_count.setter 761 def completed_count(self, completed_count): 762 """Sets the completed_count of this Witness. 763 764 # noqa: E501 765 766 :param completed_count: The completed_count of this Witness. # noqa: E501 767 :type: str 768 """ 769 770 self._completed_count = completed_count 771 772 @property 773 def consent_details_list(self): 774 """Gets the consent_details_list of this Witness. # noqa: E501 775 776 # noqa: E501 777 778 :return: The consent_details_list of this Witness. # noqa: E501 779 :rtype: list[ConsentDetails] 780 """ 781 return self._consent_details_list 782 783 @consent_details_list.setter 784 def consent_details_list(self, consent_details_list): 785 """Sets the consent_details_list of this Witness. 786 787 # noqa: E501 788 789 :param consent_details_list: The consent_details_list of this Witness. # noqa: E501 790 :type: list[ConsentDetails] 791 """ 792 793 self._consent_details_list = consent_details_list 794 795 @property 796 def creation_reason(self): 797 """Gets the creation_reason of this Witness. # noqa: E501 798 799 # noqa: E501 800 801 :return: The creation_reason of this Witness. # noqa: E501 802 :rtype: str 803 """ 804 return self._creation_reason 805 806 @creation_reason.setter 807 def creation_reason(self, creation_reason): 808 """Sets the creation_reason of this Witness. 809 810 # noqa: E501 811 812 :param creation_reason: The creation_reason of this Witness. # noqa: E501 813 :type: str 814 """ 815 816 self._creation_reason = creation_reason 817 818 @property 819 def custom_fields(self): 820 """Gets the custom_fields of this Witness. # noqa: E501 821 822 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 823 824 :return: The custom_fields of this Witness. # noqa: E501 825 :rtype: list[str] 826 """ 827 return self._custom_fields 828 829 @custom_fields.setter 830 def custom_fields(self, custom_fields): 831 """Sets the custom_fields of this Witness. 832 833 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 834 835 :param custom_fields: The custom_fields of this Witness. # noqa: E501 836 :type: list[str] 837 """ 838 839 self._custom_fields = custom_fields 840 841 @property 842 def declined_date_time(self): 843 """Gets the declined_date_time of this Witness. # noqa: E501 844 845 The date and time the recipient declined the document. # noqa: E501 846 847 :return: The declined_date_time of this Witness. # noqa: E501 848 :rtype: str 849 """ 850 return self._declined_date_time 851 852 @declined_date_time.setter 853 def declined_date_time(self, declined_date_time): 854 """Sets the declined_date_time of this Witness. 855 856 The date and time the recipient declined the document. # noqa: E501 857 858 :param declined_date_time: The declined_date_time of this Witness. # noqa: E501 859 :type: str 860 """ 861 862 self._declined_date_time = declined_date_time 863 864 @property 865 def declined_reason(self): 866 """Gets the declined_reason of this Witness. # noqa: E501 867 868 The reason the recipient declined the document. # noqa: E501 869 870 :return: The declined_reason of this Witness. # noqa: E501 871 :rtype: str 872 """ 873 return self._declined_reason 874 875 @declined_reason.setter 876 def declined_reason(self, declined_reason): 877 """Sets the declined_reason of this Witness. 878 879 The reason the recipient declined the document. # noqa: E501 880 881 :param declined_reason: The declined_reason of this Witness. # noqa: E501 882 :type: str 883 """ 884 885 self._declined_reason = declined_reason 886 887 @property 888 def default_recipient(self): 889 """Gets the default_recipient of this Witness. # noqa: E501 890 891 # noqa: E501 892 893 :return: The default_recipient of this Witness. # noqa: E501 894 :rtype: str 895 """ 896 return self._default_recipient 897 898 @default_recipient.setter 899 def default_recipient(self, default_recipient): 900 """Sets the default_recipient of this Witness. 901 902 # noqa: E501 903 904 :param default_recipient: The default_recipient of this Witness. # noqa: E501 905 :type: str 906 """ 907 908 self._default_recipient = default_recipient 909 910 @property 911 def delegated_by(self): 912 """Gets the delegated_by of this Witness. # noqa: E501 913 914 # noqa: E501 915 916 :return: The delegated_by of this Witness. # noqa: E501 917 :rtype: DelegationInfo 918 """ 919 return self._delegated_by 920 921 @delegated_by.setter 922 def delegated_by(self, delegated_by): 923 """Sets the delegated_by of this Witness. 924 925 # noqa: E501 926 927 :param delegated_by: The delegated_by of this Witness. # noqa: E501 928 :type: DelegationInfo 929 """ 930 931 self._delegated_by = delegated_by 932 933 @property 934 def delegated_to(self): 935 """Gets the delegated_to of this Witness. # noqa: E501 936 937 # noqa: E501 938 939 :return: The delegated_to of this Witness. # noqa: E501 940 :rtype: list[DelegationInfo] 941 """ 942 return self._delegated_to 943 944 @delegated_to.setter 945 def delegated_to(self, delegated_to): 946 """Sets the delegated_to of this Witness. 947 948 # noqa: E501 949 950 :param delegated_to: The delegated_to of this Witness. # noqa: E501 951 :type: list[DelegationInfo] 952 """ 953 954 self._delegated_to = delegated_to 955 956 @property 957 def delivered_date_time(self): 958 """Gets the delivered_date_time of this Witness. # noqa: E501 959 960 Reserved: For DocuSign use only. # noqa: E501 961 962 :return: The delivered_date_time of this Witness. # noqa: E501 963 :rtype: str 964 """ 965 return self._delivered_date_time 966 967 @delivered_date_time.setter 968 def delivered_date_time(self, delivered_date_time): 969 """Sets the delivered_date_time of this Witness. 970 971 Reserved: For DocuSign use only. # noqa: E501 972 973 :param delivered_date_time: The delivered_date_time of this Witness. # noqa: E501 974 :type: str 975 """ 976 977 self._delivered_date_time = delivered_date_time 978 979 @property 980 def delivery_method(self): 981 """Gets the delivery_method of this Witness. # noqa: E501 982 983 Reserved: For DocuSign use only. # noqa: E501 984 985 :return: The delivery_method of this Witness. # noqa: E501 986 :rtype: str 987 """ 988 return self._delivery_method 989 990 @delivery_method.setter 991 def delivery_method(self, delivery_method): 992 """Sets the delivery_method of this Witness. 993 994 Reserved: For DocuSign use only. # noqa: E501 995 996 :param delivery_method: The delivery_method of this Witness. # noqa: E501 997 :type: str 998 """ 999 1000 self._delivery_method = delivery_method 1001 1002 @property 1003 def delivery_method_metadata(self): 1004 """Gets the delivery_method_metadata of this Witness. # noqa: E501 1005 1006 Reserved for DocuSign. # noqa: E501 1007 1008 :return: The delivery_method_metadata of this Witness. # noqa: E501 1009 :rtype: PropertyMetadata 1010 """ 1011 return self._delivery_method_metadata 1012 1013 @delivery_method_metadata.setter 1014 def delivery_method_metadata(self, delivery_method_metadata): 1015 """Sets the delivery_method_metadata of this Witness. 1016 1017 Reserved for DocuSign. # noqa: E501 1018 1019 :param delivery_method_metadata: The delivery_method_metadata of this Witness. # noqa: E501 1020 :type: PropertyMetadata 1021 """ 1022 1023 self._delivery_method_metadata = delivery_method_metadata 1024 1025 @property 1026 def designator_id(self): 1027 """Gets the designator_id of this Witness. # noqa: E501 1028 1029 # noqa: E501 1030 1031 :return: The designator_id of this Witness. # noqa: E501 1032 :rtype: str 1033 """ 1034 return self._designator_id 1035 1036 @designator_id.setter 1037 def designator_id(self, designator_id): 1038 """Sets the designator_id of this Witness. 1039 1040 # noqa: E501 1041 1042 :param designator_id: The designator_id of this Witness. # noqa: E501 1043 :type: str 1044 """ 1045 1046 self._designator_id = designator_id 1047 1048 @property 1049 def designator_id_guid(self): 1050 """Gets the designator_id_guid of this Witness. # noqa: E501 1051 1052 # noqa: E501 1053 1054 :return: The designator_id_guid of this Witness. # noqa: E501 1055 :rtype: str 1056 """ 1057 return self._designator_id_guid 1058 1059 @designator_id_guid.setter 1060 def designator_id_guid(self, designator_id_guid): 1061 """Sets the designator_id_guid of this Witness. 1062 1063 # noqa: E501 1064 1065 :param designator_id_guid: The designator_id_guid of this Witness. # noqa: E501 1066 :type: str 1067 """ 1068 1069 self._designator_id_guid = designator_id_guid 1070 1071 @property 1072 def document_visibility(self): 1073 """Gets the document_visibility of this Witness. # noqa: E501 1074 1075 # noqa: E501 1076 1077 :return: The document_visibility of this Witness. # noqa: E501 1078 :rtype: list[DocumentVisibility] 1079 """ 1080 return self._document_visibility 1081 1082 @document_visibility.setter 1083 def document_visibility(self, document_visibility): 1084 """Sets the document_visibility of this Witness. 1085 1086 # noqa: E501 1087 1088 :param document_visibility: The document_visibility of this Witness. # noqa: E501 1089 :type: list[DocumentVisibility] 1090 """ 1091 1092 self._document_visibility = document_visibility 1093 1094 @property 1095 def email(self): 1096 """Gets the email of this Witness. # noqa: E501 1097 1098 # noqa: E501 1099 1100 :return: The email of this Witness. # noqa: E501 1101 :rtype: str 1102 """ 1103 return self._email 1104 1105 @email.setter 1106 def email(self, email): 1107 """Sets the email of this Witness. 1108 1109 # noqa: E501 1110 1111 :param email: The email of this Witness. # noqa: E501 1112 :type: str 1113 """ 1114 1115 self._email = email 1116 1117 @property 1118 def email_metadata(self): 1119 """Gets the email_metadata of this Witness. # noqa: E501 1120 1121 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1122 1123 :return: The email_metadata of this Witness. # noqa: E501 1124 :rtype: PropertyMetadata 1125 """ 1126 return self._email_metadata 1127 1128 @email_metadata.setter 1129 def email_metadata(self, email_metadata): 1130 """Sets the email_metadata of this Witness. 1131 1132 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1133 1134 :param email_metadata: The email_metadata of this Witness. # noqa: E501 1135 :type: PropertyMetadata 1136 """ 1137 1138 self._email_metadata = email_metadata 1139 1140 @property 1141 def email_notification(self): 1142 """Gets the email_notification of this Witness. # noqa: E501 1143 1144 A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. # noqa: E501 1145 1146 :return: The email_notification of this Witness. # noqa: E501 1147 :rtype: RecipientEmailNotification 1148 """ 1149 return self._email_notification 1150 1151 @email_notification.setter 1152 def email_notification(self, email_notification): 1153 """Sets the email_notification of this Witness. 1154 1155 A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. # noqa: E501 1156 1157 :param email_notification: The email_notification of this Witness. # noqa: E501 1158 :type: RecipientEmailNotification 1159 """ 1160 1161 self._email_notification = email_notification 1162 1163 @property 1164 def email_recipient_post_signing_url(self): 1165 """Gets the email_recipient_post_signing_url of this Witness. # noqa: E501 1166 1167 # noqa: E501 1168 1169 :return: The email_recipient_post_signing_url of this Witness. # noqa: E501 1170 :rtype: str 1171 """ 1172 return self._email_recipient_post_signing_url 1173 1174 @email_recipient_post_signing_url.setter 1175 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 1176 """Sets the email_recipient_post_signing_url of this Witness. 1177 1178 # noqa: E501 1179 1180 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Witness. # noqa: E501 1181 :type: str 1182 """ 1183 1184 self._email_recipient_post_signing_url = email_recipient_post_signing_url 1185 1186 @property 1187 def embedded_recipient_start_url(self): 1188 """Gets the embedded_recipient_start_url of this Witness. # noqa: E501 1189 1190 Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501 1191 1192 :return: The embedded_recipient_start_url of this Witness. # noqa: E501 1193 :rtype: str 1194 """ 1195 return self._embedded_recipient_start_url 1196 1197 @embedded_recipient_start_url.setter 1198 def embedded_recipient_start_url(self, embedded_recipient_start_url): 1199 """Sets the embedded_recipient_start_url of this Witness. 1200 1201 Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501 1202 1203 :param embedded_recipient_start_url: The embedded_recipient_start_url of this Witness. # noqa: E501 1204 :type: str 1205 """ 1206 1207 self._embedded_recipient_start_url = embedded_recipient_start_url 1208 1209 @property 1210 def error_details(self): 1211 """Gets the error_details of this Witness. # noqa: E501 1212 1213 Array or errors. # noqa: E501 1214 1215 :return: The error_details of this Witness. # noqa: E501 1216 :rtype: ErrorDetails 1217 """ 1218 return self._error_details 1219 1220 @error_details.setter 1221 def error_details(self, error_details): 1222 """Sets the error_details of this Witness. 1223 1224 Array or errors. # noqa: E501 1225 1226 :param error_details: The error_details of this Witness. # noqa: E501 1227 :type: ErrorDetails 1228 """ 1229 1230 self._error_details = error_details 1231 1232 @property 1233 def excluded_documents(self): 1234 """Gets the excluded_documents of this Witness. # noqa: E501 1235 1236 Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, 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. # noqa: E501 1237 1238 :return: The excluded_documents of this Witness. # noqa: E501 1239 :rtype: list[str] 1240 """ 1241 return self._excluded_documents 1242 1243 @excluded_documents.setter 1244 def excluded_documents(self, excluded_documents): 1245 """Sets the excluded_documents of this Witness. 1246 1247 Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, 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. # noqa: E501 1248 1249 :param excluded_documents: The excluded_documents of this Witness. # noqa: E501 1250 :type: list[str] 1251 """ 1252 1253 self._excluded_documents = excluded_documents 1254 1255 @property 1256 def fax_number(self): 1257 """Gets the fax_number of this Witness. # noqa: E501 1258 1259 Reserved: # noqa: E501 1260 1261 :return: The fax_number of this Witness. # noqa: E501 1262 :rtype: str 1263 """ 1264 return self._fax_number 1265 1266 @fax_number.setter 1267 def fax_number(self, fax_number): 1268 """Sets the fax_number of this Witness. 1269 1270 Reserved: # noqa: E501 1271 1272 :param fax_number: The fax_number of this Witness. # noqa: E501 1273 :type: str 1274 """ 1275 1276 self._fax_number = fax_number 1277 1278 @property 1279 def fax_number_metadata(self): 1280 """Gets the fax_number_metadata of this Witness. # noqa: E501 1281 1282 Reserved for DocuSign. # noqa: E501 1283 1284 :return: The fax_number_metadata of this Witness. # noqa: E501 1285 :rtype: PropertyMetadata 1286 """ 1287 return self._fax_number_metadata 1288 1289 @fax_number_metadata.setter 1290 def fax_number_metadata(self, fax_number_metadata): 1291 """Sets the fax_number_metadata of this Witness. 1292 1293 Reserved for DocuSign. # noqa: E501 1294 1295 :param fax_number_metadata: The fax_number_metadata of this Witness. # noqa: E501 1296 :type: PropertyMetadata 1297 """ 1298 1299 self._fax_number_metadata = fax_number_metadata 1300 1301 @property 1302 def first_name(self): 1303 """Gets the first_name of this Witness. # noqa: E501 1304 1305 The user's first name. Maximum Length: 50 characters. # noqa: E501 1306 1307 :return: The first_name of this Witness. # noqa: E501 1308 :rtype: str 1309 """ 1310 return self._first_name 1311 1312 @first_name.setter 1313 def first_name(self, first_name): 1314 """Sets the first_name of this Witness. 1315 1316 The user's first name. Maximum Length: 50 characters. # noqa: E501 1317 1318 :param first_name: The first_name of this Witness. # noqa: E501 1319 :type: str 1320 """ 1321 1322 self._first_name = first_name 1323 1324 @property 1325 def first_name_metadata(self): 1326 """Gets the first_name_metadata of this Witness. # noqa: E501 1327 1328 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1329 1330 :return: The first_name_metadata of this Witness. # noqa: E501 1331 :rtype: PropertyMetadata 1332 """ 1333 return self._first_name_metadata 1334 1335 @first_name_metadata.setter 1336 def first_name_metadata(self, first_name_metadata): 1337 """Sets the first_name_metadata of this Witness. 1338 1339 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1340 1341 :param first_name_metadata: The first_name_metadata of this Witness. # noqa: E501 1342 :type: PropertyMetadata 1343 """ 1344 1345 self._first_name_metadata = first_name_metadata 1346 1347 @property 1348 def full_name(self): 1349 """Gets the full_name of this Witness. # noqa: E501 1350 1351 # noqa: E501 1352 1353 :return: The full_name of this Witness. # noqa: E501 1354 :rtype: str 1355 """ 1356 return self._full_name 1357 1358 @full_name.setter 1359 def full_name(self, full_name): 1360 """Sets the full_name of this Witness. 1361 1362 # noqa: E501 1363 1364 :param full_name: The full_name of this Witness. # noqa: E501 1365 :type: str 1366 """ 1367 1368 self._full_name = full_name 1369 1370 @property 1371 def full_name_metadata(self): 1372 """Gets the full_name_metadata of this Witness. # noqa: E501 1373 1374 Reserved for DocuSign. # noqa: E501 1375 1376 :return: The full_name_metadata of this Witness. # noqa: E501 1377 :rtype: PropertyMetadata 1378 """ 1379 return self._full_name_metadata 1380 1381 @full_name_metadata.setter 1382 def full_name_metadata(self, full_name_metadata): 1383 """Sets the full_name_metadata of this Witness. 1384 1385 Reserved for DocuSign. # noqa: E501 1386 1387 :param full_name_metadata: The full_name_metadata of this Witness. # noqa: E501 1388 :type: PropertyMetadata 1389 """ 1390 1391 self._full_name_metadata = full_name_metadata 1392 1393 @property 1394 def id_check_configuration_name(self): 1395 """Gets the id_check_configuration_name of this Witness. # noqa: E501 1396 1397 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 1398 1399 :return: The id_check_configuration_name of this Witness. # noqa: E501 1400 :rtype: str 1401 """ 1402 return self._id_check_configuration_name 1403 1404 @id_check_configuration_name.setter 1405 def id_check_configuration_name(self, id_check_configuration_name): 1406 """Sets the id_check_configuration_name of this Witness. 1407 1408 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 1409 1410 :param id_check_configuration_name: The id_check_configuration_name of this Witness. # noqa: E501 1411 :type: str 1412 """ 1413 1414 self._id_check_configuration_name = id_check_configuration_name 1415 1416 @property 1417 def id_check_configuration_name_metadata(self): 1418 """Gets the id_check_configuration_name_metadata of this Witness. # noqa: E501 1419 1420 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1421 1422 :return: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1423 :rtype: PropertyMetadata 1424 """ 1425 return self._id_check_configuration_name_metadata 1426 1427 @id_check_configuration_name_metadata.setter 1428 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1429 """Sets the id_check_configuration_name_metadata of this Witness. 1430 1431 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1432 1433 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1434 :type: PropertyMetadata 1435 """ 1436 1437 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1438 1439 @property 1440 def id_check_information_input(self): 1441 """Gets the id_check_information_input of this Witness. # noqa: E501 1442 1443 An object that contains input information related to a recipient ID check. # noqa: E501 1444 1445 :return: The id_check_information_input of this Witness. # noqa: E501 1446 :rtype: IdCheckInformationInput 1447 """ 1448 return self._id_check_information_input 1449 1450 @id_check_information_input.setter 1451 def id_check_information_input(self, id_check_information_input): 1452 """Sets the id_check_information_input of this Witness. 1453 1454 An object that contains input information related to a recipient ID check. # noqa: E501 1455 1456 :param id_check_information_input: The id_check_information_input of this Witness. # noqa: E501 1457 :type: IdCheckInformationInput 1458 """ 1459 1460 self._id_check_information_input = id_check_information_input 1461 1462 @property 1463 def identity_verification(self): 1464 """Gets the identity_verification of this Witness. # noqa: E501 1465 1466 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1467 1468 :return: The identity_verification of this Witness. # noqa: E501 1469 :rtype: RecipientIdentityVerification 1470 """ 1471 return self._identity_verification 1472 1473 @identity_verification.setter 1474 def identity_verification(self, identity_verification): 1475 """Sets the identity_verification of this Witness. 1476 1477 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1478 1479 :param identity_verification: The identity_verification of this Witness. # noqa: E501 1480 :type: RecipientIdentityVerification 1481 """ 1482 1483 self._identity_verification = identity_verification 1484 1485 @property 1486 def inherit_email_notification_configuration(self): 1487 """Gets the inherit_email_notification_configuration of this Witness. # noqa: E501 1488 1489 When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501 1490 1491 :return: The inherit_email_notification_configuration of this Witness. # noqa: E501 1492 :rtype: str 1493 """ 1494 return self._inherit_email_notification_configuration 1495 1496 @inherit_email_notification_configuration.setter 1497 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1498 """Sets the inherit_email_notification_configuration of this Witness. 1499 1500 When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501 1501 1502 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this Witness. # noqa: E501 1503 :type: str 1504 """ 1505 1506 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1507 1508 @property 1509 def is_bulk_recipient(self): 1510 """Gets the is_bulk_recipient of this Witness. # noqa: E501 1511 1512 # noqa: E501 1513 1514 :return: The is_bulk_recipient of this Witness. # noqa: E501 1515 :rtype: str 1516 """ 1517 return self._is_bulk_recipient 1518 1519 @is_bulk_recipient.setter 1520 def is_bulk_recipient(self, is_bulk_recipient): 1521 """Sets the is_bulk_recipient of this Witness. 1522 1523 # noqa: E501 1524 1525 :param is_bulk_recipient: The is_bulk_recipient of this Witness. # noqa: E501 1526 :type: str 1527 """ 1528 1529 self._is_bulk_recipient = is_bulk_recipient 1530 1531 @property 1532 def is_bulk_recipient_metadata(self): 1533 """Gets the is_bulk_recipient_metadata of this Witness. # noqa: E501 1534 1535 Reserved for DocuSign. # noqa: E501 1536 1537 :return: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1538 :rtype: PropertyMetadata 1539 """ 1540 return self._is_bulk_recipient_metadata 1541 1542 @is_bulk_recipient_metadata.setter 1543 def is_bulk_recipient_metadata(self, is_bulk_recipient_metadata): 1544 """Sets the is_bulk_recipient_metadata of this Witness. 1545 1546 Reserved for DocuSign. # noqa: E501 1547 1548 :param is_bulk_recipient_metadata: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1549 :type: PropertyMetadata 1550 """ 1551 1552 self._is_bulk_recipient_metadata = is_bulk_recipient_metadata 1553 1554 @property 1555 def last_name(self): 1556 """Gets the last_name of this Witness. # noqa: E501 1557 1558 # noqa: E501 1559 1560 :return: The last_name of this Witness. # noqa: E501 1561 :rtype: str 1562 """ 1563 return self._last_name 1564 1565 @last_name.setter 1566 def last_name(self, last_name): 1567 """Sets the last_name of this Witness. 1568 1569 # noqa: E501 1570 1571 :param last_name: The last_name of this Witness. # noqa: E501 1572 :type: str 1573 """ 1574 1575 self._last_name = last_name 1576 1577 @property 1578 def last_name_metadata(self): 1579 """Gets the last_name_metadata of this Witness. # noqa: E501 1580 1581 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1582 1583 :return: The last_name_metadata of this Witness. # noqa: E501 1584 :rtype: PropertyMetadata 1585 """ 1586 return self._last_name_metadata 1587 1588 @last_name_metadata.setter 1589 def last_name_metadata(self, last_name_metadata): 1590 """Sets the last_name_metadata of this Witness. 1591 1592 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1593 1594 :param last_name_metadata: The last_name_metadata of this Witness. # noqa: E501 1595 :type: PropertyMetadata 1596 """ 1597 1598 self._last_name_metadata = last_name_metadata 1599 1600 @property 1601 def locked_recipient_phone_auth_editable(self): 1602 """Gets the locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1603 1604 # noqa: E501 1605 1606 :return: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1607 :rtype: str 1608 """ 1609 return self._locked_recipient_phone_auth_editable 1610 1611 @locked_recipient_phone_auth_editable.setter 1612 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1613 """Sets the locked_recipient_phone_auth_editable of this Witness. 1614 1615 # noqa: E501 1616 1617 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1618 :type: str 1619 """ 1620 1621 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1622 1623 @property 1624 def locked_recipient_sms_editable(self): 1625 """Gets the locked_recipient_sms_editable of this Witness. # noqa: E501 1626 1627 # noqa: E501 1628 1629 :return: The locked_recipient_sms_editable of this Witness. # noqa: E501 1630 :rtype: str 1631 """ 1632 return self._locked_recipient_sms_editable 1633 1634 @locked_recipient_sms_editable.setter 1635 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1636 """Sets the locked_recipient_sms_editable of this Witness. 1637 1638 # noqa: E501 1639 1640 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this Witness. # noqa: E501 1641 :type: str 1642 """ 1643 1644 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1645 1646 @property 1647 def name(self): 1648 """Gets the name of this Witness. # noqa: E501 1649 1650 # noqa: E501 1651 1652 :return: The name of this Witness. # noqa: E501 1653 :rtype: str 1654 """ 1655 return self._name 1656 1657 @name.setter 1658 def name(self, name): 1659 """Sets the name of this Witness. 1660 1661 # noqa: E501 1662 1663 :param name: The name of this Witness. # noqa: E501 1664 :type: str 1665 """ 1666 1667 self._name = name 1668 1669 @property 1670 def name_metadata(self): 1671 """Gets the name_metadata of this Witness. # noqa: E501 1672 1673 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1674 1675 :return: The name_metadata of this Witness. # noqa: E501 1676 :rtype: PropertyMetadata 1677 """ 1678 return self._name_metadata 1679 1680 @name_metadata.setter 1681 def name_metadata(self, name_metadata): 1682 """Sets the name_metadata of this Witness. 1683 1684 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1685 1686 :param name_metadata: The name_metadata of this Witness. # noqa: E501 1687 :type: PropertyMetadata 1688 """ 1689 1690 self._name_metadata = name_metadata 1691 1692 @property 1693 def notary_id(self): 1694 """Gets the notary_id of this Witness. # noqa: E501 1695 1696 # noqa: E501 1697 1698 :return: The notary_id of this Witness. # noqa: E501 1699 :rtype: str 1700 """ 1701 return self._notary_id 1702 1703 @notary_id.setter 1704 def notary_id(self, notary_id): 1705 """Sets the notary_id of this Witness. 1706 1707 # noqa: E501 1708 1709 :param notary_id: The notary_id of this Witness. # noqa: E501 1710 :type: str 1711 """ 1712 1713 self._notary_id = notary_id 1714 1715 @property 1716 def notary_signer_email_sent(self): 1717 """Gets the notary_signer_email_sent of this Witness. # noqa: E501 1718 1719 # noqa: E501 1720 1721 :return: The notary_signer_email_sent of this Witness. # noqa: E501 1722 :rtype: str 1723 """ 1724 return self._notary_signer_email_sent 1725 1726 @notary_signer_email_sent.setter 1727 def notary_signer_email_sent(self, notary_signer_email_sent): 1728 """Sets the notary_signer_email_sent of this Witness. 1729 1730 # noqa: E501 1731 1732 :param notary_signer_email_sent: The notary_signer_email_sent of this Witness. # noqa: E501 1733 :type: str 1734 """ 1735 1736 self._notary_signer_email_sent = notary_signer_email_sent 1737 1738 @property 1739 def note(self): 1740 """Gets the note of this Witness. # noqa: E501 1741 1742 Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501 1743 1744 :return: The note of this Witness. # noqa: E501 1745 :rtype: str 1746 """ 1747 return self._note 1748 1749 @note.setter 1750 def note(self, note): 1751 """Sets the note of this Witness. 1752 1753 Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501 1754 1755 :param note: The note of this Witness. # noqa: E501 1756 :type: str 1757 """ 1758 1759 self._note = note 1760 1761 @property 1762 def note_metadata(self): 1763 """Gets the note_metadata of this Witness. # noqa: E501 1764 1765 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1766 1767 :return: The note_metadata of this Witness. # noqa: E501 1768 :rtype: PropertyMetadata 1769 """ 1770 return self._note_metadata 1771 1772 @note_metadata.setter 1773 def note_metadata(self, note_metadata): 1774 """Sets the note_metadata of this Witness. 1775 1776 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1777 1778 :param note_metadata: The note_metadata of this Witness. # noqa: E501 1779 :type: PropertyMetadata 1780 """ 1781 1782 self._note_metadata = note_metadata 1783 1784 @property 1785 def offline_attributes(self): 1786 """Gets the offline_attributes of this Witness. # noqa: E501 1787 1788 Reserved for DocuSign. # noqa: E501 1789 1790 :return: The offline_attributes of this Witness. # noqa: E501 1791 :rtype: OfflineAttributes 1792 """ 1793 return self._offline_attributes 1794 1795 @offline_attributes.setter 1796 def offline_attributes(self, offline_attributes): 1797 """Sets the offline_attributes of this Witness. 1798 1799 Reserved for DocuSign. # noqa: E501 1800 1801 :param offline_attributes: The offline_attributes of this Witness. # noqa: E501 1802 :type: OfflineAttributes 1803 """ 1804 1805 self._offline_attributes = offline_attributes 1806 1807 @property 1808 def phone_authentication(self): 1809 """Gets the phone_authentication of this Witness. # noqa: E501 1810 1811 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1812 1813 :return: The phone_authentication of this Witness. # noqa: E501 1814 :rtype: RecipientPhoneAuthentication 1815 """ 1816 return self._phone_authentication 1817 1818 @phone_authentication.setter 1819 def phone_authentication(self, phone_authentication): 1820 """Sets the phone_authentication of this Witness. 1821 1822 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1823 1824 :param phone_authentication: The phone_authentication of this Witness. # noqa: E501 1825 :type: RecipientPhoneAuthentication 1826 """ 1827 1828 self._phone_authentication = phone_authentication 1829 1830 @property 1831 def phone_number(self): 1832 """Gets the phone_number of this Witness. # noqa: E501 1833 1834 Describes the recipient phone number. # noqa: E501 1835 1836 :return: The phone_number of this Witness. # noqa: E501 1837 :rtype: RecipientPhoneNumber 1838 """ 1839 return self._phone_number 1840 1841 @phone_number.setter 1842 def phone_number(self, phone_number): 1843 """Sets the phone_number of this Witness. 1844 1845 Describes the recipient phone number. # noqa: E501 1846 1847 :param phone_number: The phone_number of this Witness. # noqa: E501 1848 :type: RecipientPhoneNumber 1849 """ 1850 1851 self._phone_number = phone_number 1852 1853 @property 1854 def proof_file(self): 1855 """Gets the proof_file of this Witness. # noqa: E501 1856 1857 The proof file of the recipient. # noqa: E501 1858 1859 :return: The proof_file of this Witness. # noqa: E501 1860 :rtype: RecipientProofFile 1861 """ 1862 return self._proof_file 1863 1864 @proof_file.setter 1865 def proof_file(self, proof_file): 1866 """Sets the proof_file of this Witness. 1867 1868 The proof file of the recipient. # noqa: E501 1869 1870 :param proof_file: The proof_file of this Witness. # noqa: E501 1871 :type: RecipientProofFile 1872 """ 1873 1874 self._proof_file = proof_file 1875 1876 @property 1877 def recipient_attachments(self): 1878 """Gets the recipient_attachments of this Witness. # noqa: E501 1879 1880 Reserved: # noqa: E501 1881 1882 :return: The recipient_attachments of this Witness. # noqa: E501 1883 :rtype: list[RecipientAttachment] 1884 """ 1885 return self._recipient_attachments 1886 1887 @recipient_attachments.setter 1888 def recipient_attachments(self, recipient_attachments): 1889 """Sets the recipient_attachments of this Witness. 1890 1891 Reserved: # noqa: E501 1892 1893 :param recipient_attachments: The recipient_attachments of this Witness. # noqa: E501 1894 :type: list[RecipientAttachment] 1895 """ 1896 1897 self._recipient_attachments = recipient_attachments 1898 1899 @property 1900 def recipient_authentication_status(self): 1901 """Gets the recipient_authentication_status of this Witness. # noqa: E501 1902 1903 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1904 1905 :return: The recipient_authentication_status of this Witness. # noqa: E501 1906 :rtype: AuthenticationStatus 1907 """ 1908 return self._recipient_authentication_status 1909 1910 @recipient_authentication_status.setter 1911 def recipient_authentication_status(self, recipient_authentication_status): 1912 """Sets the recipient_authentication_status of this Witness. 1913 1914 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1915 1916 :param recipient_authentication_status: The recipient_authentication_status of this Witness. # noqa: E501 1917 :type: AuthenticationStatus 1918 """ 1919 1920 self._recipient_authentication_status = recipient_authentication_status 1921 1922 @property 1923 def recipient_feature_metadata(self): 1924 """Gets the recipient_feature_metadata of this Witness. # noqa: E501 1925 1926 # noqa: E501 1927 1928 :return: The recipient_feature_metadata of this Witness. # noqa: E501 1929 :rtype: list[FeatureAvailableMetadata] 1930 """ 1931 return self._recipient_feature_metadata 1932 1933 @recipient_feature_metadata.setter 1934 def recipient_feature_metadata(self, recipient_feature_metadata): 1935 """Sets the recipient_feature_metadata of this Witness. 1936 1937 # noqa: E501 1938 1939 :param recipient_feature_metadata: The recipient_feature_metadata of this Witness. # noqa: E501 1940 :type: list[FeatureAvailableMetadata] 1941 """ 1942 1943 self._recipient_feature_metadata = recipient_feature_metadata 1944 1945 @property 1946 def recipient_id(self): 1947 """Gets the recipient_id of this Witness. # noqa: E501 1948 1949 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1950 1951 :return: The recipient_id of this Witness. # noqa: E501 1952 :rtype: str 1953 """ 1954 return self._recipient_id 1955 1956 @recipient_id.setter 1957 def recipient_id(self, recipient_id): 1958 """Sets the recipient_id of this Witness. 1959 1960 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1961 1962 :param recipient_id: The recipient_id of this Witness. # noqa: E501 1963 :type: str 1964 """ 1965 1966 self._recipient_id = recipient_id 1967 1968 @property 1969 def recipient_id_guid(self): 1970 """Gets the recipient_id_guid of this Witness. # noqa: E501 1971 1972 # noqa: E501 1973 1974 :return: The recipient_id_guid of this Witness. # noqa: E501 1975 :rtype: str 1976 """ 1977 return self._recipient_id_guid 1978 1979 @recipient_id_guid.setter 1980 def recipient_id_guid(self, recipient_id_guid): 1981 """Sets the recipient_id_guid of this Witness. 1982 1983 # noqa: E501 1984 1985 :param recipient_id_guid: The recipient_id_guid of this Witness. # noqa: E501 1986 :type: str 1987 """ 1988 1989 self._recipient_id_guid = recipient_id_guid 1990 1991 @property 1992 def recipient_signature_providers(self): 1993 """Gets the recipient_signature_providers of this Witness. # noqa: E501 1994 1995 # noqa: E501 1996 1997 :return: The recipient_signature_providers of this Witness. # noqa: E501 1998 :rtype: list[RecipientSignatureProvider] 1999 """ 2000 return self._recipient_signature_providers 2001 2002 @recipient_signature_providers.setter 2003 def recipient_signature_providers(self, recipient_signature_providers): 2004 """Sets the recipient_signature_providers of this Witness. 2005 2006 # noqa: E501 2007 2008 :param recipient_signature_providers: The recipient_signature_providers of this Witness. # noqa: E501 2009 :type: list[RecipientSignatureProvider] 2010 """ 2011 2012 self._recipient_signature_providers = recipient_signature_providers 2013 2014 @property 2015 def recipient_supplies_tabs(self): 2016 """Gets the recipient_supplies_tabs of this Witness. # noqa: E501 2017 2018 # noqa: E501 2019 2020 :return: The recipient_supplies_tabs of this Witness. # noqa: E501 2021 :rtype: str 2022 """ 2023 return self._recipient_supplies_tabs 2024 2025 @recipient_supplies_tabs.setter 2026 def recipient_supplies_tabs(self, recipient_supplies_tabs): 2027 """Sets the recipient_supplies_tabs of this Witness. 2028 2029 # noqa: E501 2030 2031 :param recipient_supplies_tabs: The recipient_supplies_tabs of this Witness. # noqa: E501 2032 :type: str 2033 """ 2034 2035 self._recipient_supplies_tabs = recipient_supplies_tabs 2036 2037 @property 2038 def recipient_type(self): 2039 """Gets the recipient_type of this Witness. # noqa: E501 2040 2041 # noqa: E501 2042 2043 :return: The recipient_type of this Witness. # noqa: E501 2044 :rtype: str 2045 """ 2046 return self._recipient_type 2047 2048 @recipient_type.setter 2049 def recipient_type(self, recipient_type): 2050 """Sets the recipient_type of this Witness. 2051 2052 # noqa: E501 2053 2054 :param recipient_type: The recipient_type of this Witness. # noqa: E501 2055 :type: str 2056 """ 2057 2058 self._recipient_type = recipient_type 2059 2060 @property 2061 def recipient_type_metadata(self): 2062 """Gets the recipient_type_metadata of this Witness. # noqa: E501 2063 2064 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2065 2066 :return: The recipient_type_metadata of this Witness. # noqa: E501 2067 :rtype: PropertyMetadata 2068 """ 2069 return self._recipient_type_metadata 2070 2071 @recipient_type_metadata.setter 2072 def recipient_type_metadata(self, recipient_type_metadata): 2073 """Sets the recipient_type_metadata of this Witness. 2074 2075 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2076 2077 :param recipient_type_metadata: The recipient_type_metadata of this Witness. # noqa: E501 2078 :type: PropertyMetadata 2079 """ 2080 2081 self._recipient_type_metadata = recipient_type_metadata 2082 2083 @property 2084 def require_id_lookup(self): 2085 """Gets the require_id_lookup of this Witness. # noqa: E501 2086 2087 When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501 2088 2089 :return: The require_id_lookup of this Witness. # noqa: E501 2090 :rtype: str 2091 """ 2092 return self._require_id_lookup 2093 2094 @require_id_lookup.setter 2095 def require_id_lookup(self, require_id_lookup): 2096 """Sets the require_id_lookup of this Witness. 2097 2098 When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501 2099 2100 :param require_id_lookup: The require_id_lookup of this Witness. # noqa: E501 2101 :type: str 2102 """ 2103 2104 self._require_id_lookup = require_id_lookup 2105 2106 @property 2107 def require_id_lookup_metadata(self): 2108 """Gets the require_id_lookup_metadata of this Witness. # noqa: E501 2109 2110 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2111 2112 :return: The require_id_lookup_metadata of this Witness. # noqa: E501 2113 :rtype: PropertyMetadata 2114 """ 2115 return self._require_id_lookup_metadata 2116 2117 @require_id_lookup_metadata.setter 2118 def require_id_lookup_metadata(self, require_id_lookup_metadata): 2119 """Sets the require_id_lookup_metadata of this Witness. 2120 2121 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2122 2123 :param require_id_lookup_metadata: The require_id_lookup_metadata of this Witness. # noqa: E501 2124 :type: PropertyMetadata 2125 """ 2126 2127 self._require_id_lookup_metadata = require_id_lookup_metadata 2128 2129 @property 2130 def require_signer_certificate(self): 2131 """Gets the require_signer_certificate of this Witness. # noqa: E501 2132 2133 # noqa: E501 2134 2135 :return: The require_signer_certificate of this Witness. # noqa: E501 2136 :rtype: str 2137 """ 2138 return self._require_signer_certificate 2139 2140 @require_signer_certificate.setter 2141 def require_signer_certificate(self, require_signer_certificate): 2142 """Sets the require_signer_certificate of this Witness. 2143 2144 # noqa: E501 2145 2146 :param require_signer_certificate: The require_signer_certificate of this Witness. # noqa: E501 2147 :type: str 2148 """ 2149 2150 self._require_signer_certificate = require_signer_certificate 2151 2152 @property 2153 def require_sign_on_paper(self): 2154 """Gets the require_sign_on_paper of this Witness. # noqa: E501 2155 2156 # noqa: E501 2157 2158 :return: The require_sign_on_paper of this Witness. # noqa: E501 2159 :rtype: str 2160 """ 2161 return self._require_sign_on_paper 2162 2163 @require_sign_on_paper.setter 2164 def require_sign_on_paper(self, require_sign_on_paper): 2165 """Sets the require_sign_on_paper of this Witness. 2166 2167 # noqa: E501 2168 2169 :param require_sign_on_paper: The require_sign_on_paper of this Witness. # noqa: E501 2170 :type: str 2171 """ 2172 2173 self._require_sign_on_paper = require_sign_on_paper 2174 2175 @property 2176 def require_upload_signature(self): 2177 """Gets the require_upload_signature of this Witness. # noqa: E501 2178 2179 # noqa: E501 2180 2181 :return: The require_upload_signature of this Witness. # noqa: E501 2182 :rtype: str 2183 """ 2184 return self._require_upload_signature 2185 2186 @require_upload_signature.setter 2187 def require_upload_signature(self, require_upload_signature): 2188 """Sets the require_upload_signature of this Witness. 2189 2190 # noqa: E501 2191 2192 :param require_upload_signature: The require_upload_signature of this Witness. # noqa: E501 2193 :type: str 2194 """ 2195 2196 self._require_upload_signature = require_upload_signature 2197 2198 @property 2199 def role_name(self): 2200 """Gets the role_name of this Witness. # noqa: E501 2201 2202 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2203 2204 :return: The role_name of this Witness. # noqa: E501 2205 :rtype: str 2206 """ 2207 return self._role_name 2208 2209 @role_name.setter 2210 def role_name(self, role_name): 2211 """Sets the role_name of this Witness. 2212 2213 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2214 2215 :param role_name: The role_name of this Witness. # noqa: E501 2216 :type: str 2217 """ 2218 2219 self._role_name = role_name 2220 2221 @property 2222 def routing_order(self): 2223 """Gets the routing_order of this Witness. # noqa: E501 2224 2225 Specifies the routing order of the recipient in the envelope. # noqa: E501 2226 2227 :return: The routing_order of this Witness. # noqa: E501 2228 :rtype: str 2229 """ 2230 return self._routing_order 2231 2232 @routing_order.setter 2233 def routing_order(self, routing_order): 2234 """Sets the routing_order of this Witness. 2235 2236 Specifies the routing order of the recipient in the envelope. # noqa: E501 2237 2238 :param routing_order: The routing_order of this Witness. # noqa: E501 2239 :type: str 2240 """ 2241 2242 self._routing_order = routing_order 2243 2244 @property 2245 def routing_order_metadata(self): 2246 """Gets the routing_order_metadata of this Witness. # noqa: E501 2247 2248 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2249 2250 :return: The routing_order_metadata of this Witness. # noqa: E501 2251 :rtype: PropertyMetadata 2252 """ 2253 return self._routing_order_metadata 2254 2255 @routing_order_metadata.setter 2256 def routing_order_metadata(self, routing_order_metadata): 2257 """Sets the routing_order_metadata of this Witness. 2258 2259 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2260 2261 :param routing_order_metadata: The routing_order_metadata of this Witness. # noqa: E501 2262 :type: PropertyMetadata 2263 """ 2264 2265 self._routing_order_metadata = routing_order_metadata 2266 2267 @property 2268 def sent_date_time(self): 2269 """Gets the sent_date_time of this Witness. # noqa: E501 2270 2271 The date and time the envelope was sent. # noqa: E501 2272 2273 :return: The sent_date_time of this Witness. # noqa: E501 2274 :rtype: str 2275 """ 2276 return self._sent_date_time 2277 2278 @sent_date_time.setter 2279 def sent_date_time(self, sent_date_time): 2280 """Sets the sent_date_time of this Witness. 2281 2282 The date and time the envelope was sent. # noqa: E501 2283 2284 :param sent_date_time: The sent_date_time of this Witness. # noqa: E501 2285 :type: str 2286 """ 2287 2288 self._sent_date_time = sent_date_time 2289 2290 @property 2291 def signature_info(self): 2292 """Gets the signature_info of this Witness. # noqa: E501 2293 2294 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2295 2296 :return: The signature_info of this Witness. # noqa: E501 2297 :rtype: RecipientSignatureInformation 2298 """ 2299 return self._signature_info 2300 2301 @signature_info.setter 2302 def signature_info(self, signature_info): 2303 """Sets the signature_info of this Witness. 2304 2305 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2306 2307 :param signature_info: The signature_info of this Witness. # noqa: E501 2308 :type: RecipientSignatureInformation 2309 """ 2310 2311 self._signature_info = signature_info 2312 2313 @property 2314 def signed_date_time(self): 2315 """Gets the signed_date_time of this Witness. # noqa: E501 2316 2317 Reserved: For DocuSign use only. # noqa: E501 2318 2319 :return: The signed_date_time of this Witness. # noqa: E501 2320 :rtype: str 2321 """ 2322 return self._signed_date_time 2323 2324 @signed_date_time.setter 2325 def signed_date_time(self, signed_date_time): 2326 """Sets the signed_date_time of this Witness. 2327 2328 Reserved: For DocuSign use only. # noqa: E501 2329 2330 :param signed_date_time: The signed_date_time of this Witness. # noqa: E501 2331 :type: str 2332 """ 2333 2334 self._signed_date_time = signed_date_time 2335 2336 @property 2337 def sign_in_each_location(self): 2338 """Gets the sign_in_each_location of this Witness. # noqa: E501 2339 2340 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2341 2342 :return: The sign_in_each_location of this Witness. # noqa: E501 2343 :rtype: str 2344 """ 2345 return self._sign_in_each_location 2346 2347 @sign_in_each_location.setter 2348 def sign_in_each_location(self, sign_in_each_location): 2349 """Sets the sign_in_each_location of this Witness. 2350 2351 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2352 2353 :param sign_in_each_location: The sign_in_each_location of this Witness. # noqa: E501 2354 :type: str 2355 """ 2356 2357 self._sign_in_each_location = sign_in_each_location 2358 2359 @property 2360 def sign_in_each_location_metadata(self): 2361 """Gets the sign_in_each_location_metadata of this Witness. # noqa: E501 2362 2363 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2364 2365 :return: The sign_in_each_location_metadata of this Witness. # noqa: E501 2366 :rtype: PropertyMetadata 2367 """ 2368 return self._sign_in_each_location_metadata 2369 2370 @sign_in_each_location_metadata.setter 2371 def sign_in_each_location_metadata(self, sign_in_each_location_metadata): 2372 """Sets the sign_in_each_location_metadata of this Witness. 2373 2374 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2375 2376 :param sign_in_each_location_metadata: The sign_in_each_location_metadata of this Witness. # noqa: E501 2377 :type: PropertyMetadata 2378 """ 2379 2380 self._sign_in_each_location_metadata = sign_in_each_location_metadata 2381 2382 @property 2383 def signing_group_id(self): 2384 """Gets the signing_group_id of this Witness. # noqa: E501 2385 2386 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 2387 2388 :return: The signing_group_id of this Witness. # noqa: E501 2389 :rtype: str 2390 """ 2391 return self._signing_group_id 2392 2393 @signing_group_id.setter 2394 def signing_group_id(self, signing_group_id): 2395 """Sets the signing_group_id of this Witness. 2396 2397 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 2398 2399 :param signing_group_id: The signing_group_id of this Witness. # noqa: E501 2400 :type: str 2401 """ 2402 2403 self._signing_group_id = signing_group_id 2404 2405 @property 2406 def signing_group_id_metadata(self): 2407 """Gets the signing_group_id_metadata of this Witness. # noqa: E501 2408 2409 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2410 2411 :return: The signing_group_id_metadata of this Witness. # noqa: E501 2412 :rtype: PropertyMetadata 2413 """ 2414 return self._signing_group_id_metadata 2415 2416 @signing_group_id_metadata.setter 2417 def signing_group_id_metadata(self, signing_group_id_metadata): 2418 """Sets the signing_group_id_metadata of this Witness. 2419 2420 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2421 2422 :param signing_group_id_metadata: The signing_group_id_metadata of this Witness. # noqa: E501 2423 :type: PropertyMetadata 2424 """ 2425 2426 self._signing_group_id_metadata = signing_group_id_metadata 2427 2428 @property 2429 def signing_group_name(self): 2430 """Gets the signing_group_name of this Witness. # noqa: E501 2431 2432 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2433 2434 :return: The signing_group_name of this Witness. # noqa: E501 2435 :rtype: str 2436 """ 2437 return self._signing_group_name 2438 2439 @signing_group_name.setter 2440 def signing_group_name(self, signing_group_name): 2441 """Sets the signing_group_name of this Witness. 2442 2443 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2444 2445 :param signing_group_name: The signing_group_name of this Witness. # noqa: E501 2446 :type: str 2447 """ 2448 2449 self._signing_group_name = signing_group_name 2450 2451 @property 2452 def signing_group_users(self): 2453 """Gets the signing_group_users of this Witness. # noqa: E501 2454 2455 A complex type that contains information about users in the signing group. # noqa: E501 2456 2457 :return: The signing_group_users of this Witness. # noqa: E501 2458 :rtype: list[UserInfo] 2459 """ 2460 return self._signing_group_users 2461 2462 @signing_group_users.setter 2463 def signing_group_users(self, signing_group_users): 2464 """Sets the signing_group_users of this Witness. 2465 2466 A complex type that contains information about users in the signing group. # noqa: E501 2467 2468 :param signing_group_users: The signing_group_users of this Witness. # noqa: E501 2469 :type: list[UserInfo] 2470 """ 2471 2472 self._signing_group_users = signing_group_users 2473 2474 @property 2475 def sms_authentication(self): 2476 """Gets the sms_authentication of this Witness. # noqa: E501 2477 2478 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2479 2480 :return: The sms_authentication of this Witness. # noqa: E501 2481 :rtype: RecipientSMSAuthentication 2482 """ 2483 return self._sms_authentication 2484 2485 @sms_authentication.setter 2486 def sms_authentication(self, sms_authentication): 2487 """Sets the sms_authentication of this Witness. 2488 2489 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2490 2491 :param sms_authentication: The sms_authentication of this Witness. # noqa: E501 2492 :type: RecipientSMSAuthentication 2493 """ 2494 2495 self._sms_authentication = sms_authentication 2496 2497 @property 2498 def social_authentications(self): 2499 """Gets the social_authentications of this Witness. # noqa: E501 2500 2501 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2502 2503 :return: The social_authentications of this Witness. # noqa: E501 2504 :rtype: list[SocialAuthentication] 2505 """ 2506 return self._social_authentications 2507 2508 @social_authentications.setter 2509 def social_authentications(self, social_authentications): 2510 """Sets the social_authentications of this Witness. 2511 2512 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2513 2514 :param social_authentications: The social_authentications of this Witness. # noqa: E501 2515 :type: list[SocialAuthentication] 2516 """ 2517 2518 self._social_authentications = social_authentications 2519 2520 @property 2521 def status(self): 2522 """Gets the status of this Witness. # noqa: E501 2523 2524 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 2525 2526 :return: The status of this Witness. # noqa: E501 2527 :rtype: str 2528 """ 2529 return self._status 2530 2531 @status.setter 2532 def status(self, status): 2533 """Sets the status of this Witness. 2534 2535 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 2536 2537 :param status: The status of this Witness. # noqa: E501 2538 :type: str 2539 """ 2540 2541 self._status = status 2542 2543 @property 2544 def status_code(self): 2545 """Gets the status_code of this Witness. # noqa: E501 2546 2547 # noqa: E501 2548 2549 :return: The status_code of this Witness. # noqa: E501 2550 :rtype: str 2551 """ 2552 return self._status_code 2553 2554 @status_code.setter 2555 def status_code(self, status_code): 2556 """Sets the status_code of this Witness. 2557 2558 # noqa: E501 2559 2560 :param status_code: The status_code of this Witness. # noqa: E501 2561 :type: str 2562 """ 2563 2564 self._status_code = status_code 2565 2566 @property 2567 def suppress_emails(self): 2568 """Gets the suppress_emails of this Witness. # noqa: E501 2569 2570 # noqa: E501 2571 2572 :return: The suppress_emails of this Witness. # noqa: E501 2573 :rtype: str 2574 """ 2575 return self._suppress_emails 2576 2577 @suppress_emails.setter 2578 def suppress_emails(self, suppress_emails): 2579 """Sets the suppress_emails of this Witness. 2580 2581 # noqa: E501 2582 2583 :param suppress_emails: The suppress_emails of this Witness. # noqa: E501 2584 :type: str 2585 """ 2586 2587 self._suppress_emails = suppress_emails 2588 2589 @property 2590 def tabs(self): 2591 """Gets the tabs of this Witness. # noqa: E501 2592 2593 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2594 2595 :return: The tabs of this Witness. # noqa: E501 2596 :rtype: Tabs 2597 """ 2598 return self._tabs 2599 2600 @tabs.setter 2601 def tabs(self, tabs): 2602 """Sets the tabs of this Witness. 2603 2604 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2605 2606 :param tabs: The tabs of this Witness. # noqa: E501 2607 :type: Tabs 2608 """ 2609 2610 self._tabs = tabs 2611 2612 @property 2613 def template_locked(self): 2614 """Gets the template_locked of this Witness. # noqa: E501 2615 2616 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2617 2618 :return: The template_locked of this Witness. # noqa: E501 2619 :rtype: str 2620 """ 2621 return self._template_locked 2622 2623 @template_locked.setter 2624 def template_locked(self, template_locked): 2625 """Sets the template_locked of this Witness. 2626 2627 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2628 2629 :param template_locked: The template_locked of this Witness. # noqa: E501 2630 :type: str 2631 """ 2632 2633 self._template_locked = template_locked 2634 2635 @property 2636 def template_required(self): 2637 """Gets the template_required of this Witness. # noqa: E501 2638 2639 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2640 2641 :return: The template_required of this Witness. # noqa: E501 2642 :rtype: str 2643 """ 2644 return self._template_required 2645 2646 @template_required.setter 2647 def template_required(self, template_required): 2648 """Sets the template_required of this Witness. 2649 2650 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2651 2652 :param template_required: The template_required of this Witness. # noqa: E501 2653 :type: str 2654 """ 2655 2656 self._template_required = template_required 2657 2658 @property 2659 def total_tab_count(self): 2660 """Gets the total_tab_count of this Witness. # noqa: E501 2661 2662 # noqa: E501 2663 2664 :return: The total_tab_count of this Witness. # noqa: E501 2665 :rtype: str 2666 """ 2667 return self._total_tab_count 2668 2669 @total_tab_count.setter 2670 def total_tab_count(self, total_tab_count): 2671 """Sets the total_tab_count of this Witness. 2672 2673 # noqa: E501 2674 2675 :param total_tab_count: The total_tab_count of this Witness. # noqa: E501 2676 :type: str 2677 """ 2678 2679 self._total_tab_count = total_tab_count 2680 2681 @property 2682 def user_id(self): 2683 """Gets the user_id of this Witness. # noqa: E501 2684 2685 # noqa: E501 2686 2687 :return: The user_id of this Witness. # noqa: E501 2688 :rtype: str 2689 """ 2690 return self._user_id 2691 2692 @user_id.setter 2693 def user_id(self, user_id): 2694 """Sets the user_id of this Witness. 2695 2696 # noqa: E501 2697 2698 :param user_id: The user_id of this Witness. # noqa: E501 2699 :type: str 2700 """ 2701 2702 self._user_id = user_id 2703 2704 @property 2705 def witness_for(self): 2706 """Gets the witness_for of this Witness. # noqa: E501 2707 2708 # noqa: E501 2709 2710 :return: The witness_for of this Witness. # noqa: E501 2711 :rtype: str 2712 """ 2713 return self._witness_for 2714 2715 @witness_for.setter 2716 def witness_for(self, witness_for): 2717 """Sets the witness_for of this Witness. 2718 2719 # noqa: E501 2720 2721 :param witness_for: The witness_for of this Witness. # noqa: E501 2722 :type: str 2723 """ 2724 2725 self._witness_for = witness_for 2726 2727 @property 2728 def witness_for_guid(self): 2729 """Gets the witness_for_guid of this Witness. # noqa: E501 2730 2731 # noqa: E501 2732 2733 :return: The witness_for_guid of this Witness. # noqa: E501 2734 :rtype: str 2735 """ 2736 return self._witness_for_guid 2737 2738 @witness_for_guid.setter 2739 def witness_for_guid(self, witness_for_guid): 2740 """Sets the witness_for_guid of this Witness. 2741 2742 # noqa: E501 2743 2744 :param witness_for_guid: The witness_for_guid of this Witness. # noqa: E501 2745 :type: str 2746 """ 2747 2748 self._witness_for_guid = witness_for_guid 2749 2750 def to_dict(self): 2751 """Returns the model properties as a dict""" 2752 result = {} 2753 2754 for attr, _ in six.iteritems(self.swagger_types): 2755 value = getattr(self, attr) 2756 if isinstance(value, list): 2757 result[attr] = list(map( 2758 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2759 value 2760 )) 2761 elif hasattr(value, "to_dict"): 2762 result[attr] = value.to_dict() 2763 elif isinstance(value, dict): 2764 result[attr] = dict(map( 2765 lambda item: (item[0], item[1].to_dict()) 2766 if hasattr(item[1], "to_dict") else item, 2767 value.items() 2768 )) 2769 else: 2770 result[attr] = value 2771 if issubclass(Witness, dict): 2772 for key, value in self.items(): 2773 result[key] = value 2774 2775 return result 2776 2777 def to_str(self): 2778 """Returns the string representation of the model""" 2779 return pprint.pformat(self.to_dict()) 2780 2781 def __repr__(self): 2782 """For `print` and `pprint`""" 2783 return self.to_str() 2784 2785 def __eq__(self, other): 2786 """Returns true if both objects are equal""" 2787 if not isinstance(other, Witness): 2788 return False 2789 2790 return self.to_dict() == other.to_dict() 2791 2792 def __ne__(self, other): 2793 """Returns true if both objects are not equal""" 2794 if not isinstance(other, Witness): 2795 return True 2796 2797 return self.to_dict() != other.to_dict()
class
Witness:
23class Witness(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_code': 'str', 38 'access_code_metadata': 'PropertyMetadata', 39 'add_access_code_to_email': 'str', 40 'additional_notifications': 'list[RecipientAdditionalNotification]', 41 'agent_can_edit_email': 'str', 42 'agent_can_edit_name': 'str', 43 'allow_system_override_for_locked_recipient': 'str', 44 'auto_navigation': 'str', 45 'auto_responded_reason': 'str', 46 'bulk_recipients_uri': 'str', 47 'bulk_send_v2_recipient': 'str', 48 'can_sign_offline': 'str', 49 'client_user_id': 'str', 50 'completed_count': 'str', 51 'consent_details_list': 'list[ConsentDetails]', 52 'creation_reason': 'str', 53 'custom_fields': 'list[str]', 54 'declined_date_time': 'str', 55 'declined_reason': 'str', 56 'default_recipient': 'str', 57 'delegated_by': 'DelegationInfo', 58 'delegated_to': 'list[DelegationInfo]', 59 'delivered_date_time': 'str', 60 'delivery_method': 'str', 61 'delivery_method_metadata': 'PropertyMetadata', 62 'designator_id': 'str', 63 'designator_id_guid': 'str', 64 'document_visibility': 'list[DocumentVisibility]', 65 'email': 'str', 66 'email_metadata': 'PropertyMetadata', 67 'email_notification': 'RecipientEmailNotification', 68 'email_recipient_post_signing_url': 'str', 69 'embedded_recipient_start_url': 'str', 70 'error_details': 'ErrorDetails', 71 'excluded_documents': 'list[str]', 72 'fax_number': 'str', 73 'fax_number_metadata': 'PropertyMetadata', 74 'first_name': 'str', 75 'first_name_metadata': 'PropertyMetadata', 76 'full_name': 'str', 77 'full_name_metadata': 'PropertyMetadata', 78 'id_check_configuration_name': 'str', 79 'id_check_configuration_name_metadata': 'PropertyMetadata', 80 'id_check_information_input': 'IdCheckInformationInput', 81 'identity_verification': 'RecipientIdentityVerification', 82 'inherit_email_notification_configuration': 'str', 83 'is_bulk_recipient': 'str', 84 'is_bulk_recipient_metadata': 'PropertyMetadata', 85 'last_name': 'str', 86 'last_name_metadata': 'PropertyMetadata', 87 'locked_recipient_phone_auth_editable': 'str', 88 'locked_recipient_sms_editable': 'str', 89 'name': 'str', 90 'name_metadata': 'PropertyMetadata', 91 'notary_id': 'str', 92 'notary_signer_email_sent': 'str', 93 'note': 'str', 94 'note_metadata': 'PropertyMetadata', 95 'offline_attributes': 'OfflineAttributes', 96 'phone_authentication': 'RecipientPhoneAuthentication', 97 'phone_number': 'RecipientPhoneNumber', 98 'proof_file': 'RecipientProofFile', 99 'recipient_attachments': 'list[RecipientAttachment]', 100 'recipient_authentication_status': 'AuthenticationStatus', 101 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 102 'recipient_id': 'str', 103 'recipient_id_guid': 'str', 104 'recipient_signature_providers': 'list[RecipientSignatureProvider]', 105 'recipient_supplies_tabs': 'str', 106 'recipient_type': 'str', 107 'recipient_type_metadata': 'PropertyMetadata', 108 'require_id_lookup': 'str', 109 'require_id_lookup_metadata': 'PropertyMetadata', 110 'require_signer_certificate': 'str', 111 'require_sign_on_paper': 'str', 112 'require_upload_signature': 'str', 113 'role_name': 'str', 114 'routing_order': 'str', 115 'routing_order_metadata': 'PropertyMetadata', 116 'sent_date_time': 'str', 117 'signature_info': 'RecipientSignatureInformation', 118 'signed_date_time': 'str', 119 'sign_in_each_location': 'str', 120 'sign_in_each_location_metadata': 'PropertyMetadata', 121 'signing_group_id': 'str', 122 'signing_group_id_metadata': 'PropertyMetadata', 123 'signing_group_name': 'str', 124 'signing_group_users': 'list[UserInfo]', 125 'sms_authentication': 'RecipientSMSAuthentication', 126 'social_authentications': 'list[SocialAuthentication]', 127 'status': 'str', 128 'status_code': 'str', 129 'suppress_emails': 'str', 130 'tabs': 'Tabs', 131 'template_locked': 'str', 132 'template_required': 'str', 133 'total_tab_count': 'str', 134 'user_id': 'str', 135 'witness_for': 'str', 136 'witness_for_guid': 'str' 137 } 138 139 attribute_map = { 140 'access_code': 'accessCode', 141 'access_code_metadata': 'accessCodeMetadata', 142 'add_access_code_to_email': 'addAccessCodeToEmail', 143 'additional_notifications': 'additionalNotifications', 144 'agent_can_edit_email': 'agentCanEditEmail', 145 'agent_can_edit_name': 'agentCanEditName', 146 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 147 'auto_navigation': 'autoNavigation', 148 'auto_responded_reason': 'autoRespondedReason', 149 'bulk_recipients_uri': 'bulkRecipientsUri', 150 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 151 'can_sign_offline': 'canSignOffline', 152 'client_user_id': 'clientUserId', 153 'completed_count': 'completedCount', 154 'consent_details_list': 'consentDetailsList', 155 'creation_reason': 'creationReason', 156 'custom_fields': 'customFields', 157 'declined_date_time': 'declinedDateTime', 158 'declined_reason': 'declinedReason', 159 'default_recipient': 'defaultRecipient', 160 'delegated_by': 'delegatedBy', 161 'delegated_to': 'delegatedTo', 162 'delivered_date_time': 'deliveredDateTime', 163 'delivery_method': 'deliveryMethod', 164 'delivery_method_metadata': 'deliveryMethodMetadata', 165 'designator_id': 'designatorId', 166 'designator_id_guid': 'designatorIdGuid', 167 'document_visibility': 'documentVisibility', 168 'email': 'email', 169 'email_metadata': 'emailMetadata', 170 'email_notification': 'emailNotification', 171 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 172 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 173 'error_details': 'errorDetails', 174 'excluded_documents': 'excludedDocuments', 175 'fax_number': 'faxNumber', 176 'fax_number_metadata': 'faxNumberMetadata', 177 'first_name': 'firstName', 178 'first_name_metadata': 'firstNameMetadata', 179 'full_name': 'fullName', 180 'full_name_metadata': 'fullNameMetadata', 181 'id_check_configuration_name': 'idCheckConfigurationName', 182 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 183 'id_check_information_input': 'idCheckInformationInput', 184 'identity_verification': 'identityVerification', 185 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 186 'is_bulk_recipient': 'isBulkRecipient', 187 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata', 188 'last_name': 'lastName', 189 'last_name_metadata': 'lastNameMetadata', 190 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 191 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 192 'name': 'name', 193 'name_metadata': 'nameMetadata', 194 'notary_id': 'notaryId', 195 'notary_signer_email_sent': 'notarySignerEmailSent', 196 'note': 'note', 197 'note_metadata': 'noteMetadata', 198 'offline_attributes': 'offlineAttributes', 199 'phone_authentication': 'phoneAuthentication', 200 'phone_number': 'phoneNumber', 201 'proof_file': 'proofFile', 202 'recipient_attachments': 'recipientAttachments', 203 'recipient_authentication_status': 'recipientAuthenticationStatus', 204 'recipient_feature_metadata': 'recipientFeatureMetadata', 205 'recipient_id': 'recipientId', 206 'recipient_id_guid': 'recipientIdGuid', 207 'recipient_signature_providers': 'recipientSignatureProviders', 208 'recipient_supplies_tabs': 'recipientSuppliesTabs', 209 'recipient_type': 'recipientType', 210 'recipient_type_metadata': 'recipientTypeMetadata', 211 'require_id_lookup': 'requireIdLookup', 212 'require_id_lookup_metadata': 'requireIdLookupMetadata', 213 'require_signer_certificate': 'requireSignerCertificate', 214 'require_sign_on_paper': 'requireSignOnPaper', 215 'require_upload_signature': 'requireUploadSignature', 216 'role_name': 'roleName', 217 'routing_order': 'routingOrder', 218 'routing_order_metadata': 'routingOrderMetadata', 219 'sent_date_time': 'sentDateTime', 220 'signature_info': 'signatureInfo', 221 'signed_date_time': 'signedDateTime', 222 'sign_in_each_location': 'signInEachLocation', 223 'sign_in_each_location_metadata': 'signInEachLocationMetadata', 224 'signing_group_id': 'signingGroupId', 225 'signing_group_id_metadata': 'signingGroupIdMetadata', 226 'signing_group_name': 'signingGroupName', 227 'signing_group_users': 'signingGroupUsers', 228 'sms_authentication': 'smsAuthentication', 229 'social_authentications': 'socialAuthentications', 230 'status': 'status', 231 'status_code': 'statusCode', 232 'suppress_emails': 'suppressEmails', 233 'tabs': 'tabs', 234 'template_locked': 'templateLocked', 235 'template_required': 'templateRequired', 236 'total_tab_count': 'totalTabCount', 237 'user_id': 'userId', 238 'witness_for': 'witnessFor', 239 'witness_for_guid': 'witnessForGuid' 240 } 241 242 def __init__(self, _configuration=None, **kwargs): # noqa: E501 243 """Witness - a model defined in Swagger""" # noqa: E501 244 if _configuration is None: 245 _configuration = Configuration() 246 self._configuration = _configuration 247 248 self._access_code = None 249 self._access_code_metadata = None 250 self._add_access_code_to_email = None 251 self._additional_notifications = None 252 self._agent_can_edit_email = None 253 self._agent_can_edit_name = None 254 self._allow_system_override_for_locked_recipient = None 255 self._auto_navigation = None 256 self._auto_responded_reason = None 257 self._bulk_recipients_uri = None 258 self._bulk_send_v2_recipient = None 259 self._can_sign_offline = None 260 self._client_user_id = None 261 self._completed_count = None 262 self._consent_details_list = None 263 self._creation_reason = None 264 self._custom_fields = None 265 self._declined_date_time = None 266 self._declined_reason = None 267 self._default_recipient = None 268 self._delegated_by = None 269 self._delegated_to = None 270 self._delivered_date_time = None 271 self._delivery_method = None 272 self._delivery_method_metadata = None 273 self._designator_id = None 274 self._designator_id_guid = None 275 self._document_visibility = None 276 self._email = None 277 self._email_metadata = None 278 self._email_notification = None 279 self._email_recipient_post_signing_url = None 280 self._embedded_recipient_start_url = None 281 self._error_details = None 282 self._excluded_documents = None 283 self._fax_number = None 284 self._fax_number_metadata = None 285 self._first_name = None 286 self._first_name_metadata = None 287 self._full_name = None 288 self._full_name_metadata = None 289 self._id_check_configuration_name = None 290 self._id_check_configuration_name_metadata = None 291 self._id_check_information_input = None 292 self._identity_verification = None 293 self._inherit_email_notification_configuration = None 294 self._is_bulk_recipient = None 295 self._is_bulk_recipient_metadata = None 296 self._last_name = None 297 self._last_name_metadata = None 298 self._locked_recipient_phone_auth_editable = None 299 self._locked_recipient_sms_editable = None 300 self._name = None 301 self._name_metadata = None 302 self._notary_id = None 303 self._notary_signer_email_sent = None 304 self._note = None 305 self._note_metadata = None 306 self._offline_attributes = None 307 self._phone_authentication = None 308 self._phone_number = None 309 self._proof_file = None 310 self._recipient_attachments = None 311 self._recipient_authentication_status = None 312 self._recipient_feature_metadata = None 313 self._recipient_id = None 314 self._recipient_id_guid = None 315 self._recipient_signature_providers = None 316 self._recipient_supplies_tabs = None 317 self._recipient_type = None 318 self._recipient_type_metadata = None 319 self._require_id_lookup = None 320 self._require_id_lookup_metadata = None 321 self._require_signer_certificate = None 322 self._require_sign_on_paper = None 323 self._require_upload_signature = None 324 self._role_name = None 325 self._routing_order = None 326 self._routing_order_metadata = None 327 self._sent_date_time = None 328 self._signature_info = None 329 self._signed_date_time = None 330 self._sign_in_each_location = None 331 self._sign_in_each_location_metadata = None 332 self._signing_group_id = None 333 self._signing_group_id_metadata = None 334 self._signing_group_name = None 335 self._signing_group_users = None 336 self._sms_authentication = None 337 self._social_authentications = None 338 self._status = None 339 self._status_code = None 340 self._suppress_emails = None 341 self._tabs = None 342 self._template_locked = None 343 self._template_required = None 344 self._total_tab_count = None 345 self._user_id = None 346 self._witness_for = None 347 self._witness_for_guid = None 348 self.discriminator = None 349 350 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 351 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 352 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 353 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 354 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 355 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 356 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 357 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 358 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 359 setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None)) 360 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 361 setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None)) 362 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 363 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 364 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 365 setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None)) 366 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 367 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 368 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 369 setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None)) 370 setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None)) 371 setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None)) 372 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 373 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 374 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 375 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 376 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 377 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 378 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 379 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 380 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 381 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 382 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 383 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 384 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 385 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 386 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 387 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 388 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 389 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 390 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 391 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 392 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 393 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 394 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 395 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 396 setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None)) 397 setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None)) 398 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 399 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 400 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 401 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 402 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 403 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 404 setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None)) 405 setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None)) 406 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 407 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 408 setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None)) 409 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 410 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 411 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 412 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 413 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 414 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 415 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 416 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 417 setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None)) 418 setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None)) 419 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 420 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 421 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 422 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 423 setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None)) 424 setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None)) 425 setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None)) 426 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 427 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 428 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 429 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 430 setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None)) 431 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 432 setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None)) 433 setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None)) 434 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 435 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 436 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 437 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 438 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 439 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 440 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 441 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 442 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 443 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 444 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 445 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 446 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 447 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 448 setattr(self, "_{}".format('witness_for'), kwargs.get('witness_for', None)) 449 setattr(self, "_{}".format('witness_for_guid'), kwargs.get('witness_for_guid', None)) 450 451 @property 452 def access_code(self): 453 """Gets the access_code of this Witness. # noqa: E501 454 455 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 456 457 :return: The access_code of this Witness. # noqa: E501 458 :rtype: str 459 """ 460 return self._access_code 461 462 @access_code.setter 463 def access_code(self, access_code): 464 """Sets the access_code of this Witness. 465 466 If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer `accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required. # noqa: E501 467 468 :param access_code: The access_code of this Witness. # noqa: E501 469 :type: str 470 """ 471 472 self._access_code = access_code 473 474 @property 475 def access_code_metadata(self): 476 """Gets the access_code_metadata of this Witness. # noqa: E501 477 478 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 479 480 :return: The access_code_metadata of this Witness. # noqa: E501 481 :rtype: PropertyMetadata 482 """ 483 return self._access_code_metadata 484 485 @access_code_metadata.setter 486 def access_code_metadata(self, access_code_metadata): 487 """Sets the access_code_metadata of this Witness. 488 489 Metadata that indicates whether the `accessCode` property is editable. This property is read-only. # noqa: E501 490 491 :param access_code_metadata: The access_code_metadata of this Witness. # noqa: E501 492 :type: PropertyMetadata 493 """ 494 495 self._access_code_metadata = access_code_metadata 496 497 @property 498 def add_access_code_to_email(self): 499 """Gets the add_access_code_to_email of this Witness. # noqa: E501 500 501 This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501 502 503 :return: The add_access_code_to_email of this Witness. # noqa: E501 504 :rtype: str 505 """ 506 return self._add_access_code_to_email 507 508 @add_access_code_to_email.setter 509 def add_access_code_to_email(self, add_access_code_to_email): 510 """Sets the add_access_code_to_email of this Witness. 511 512 This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501 513 514 :param add_access_code_to_email: The add_access_code_to_email of this Witness. # noqa: E501 515 :type: str 516 """ 517 518 self._add_access_code_to_email = add_access_code_to_email 519 520 @property 521 def additional_notifications(self): 522 """Gets the additional_notifications of this Witness. # noqa: E501 523 524 # noqa: E501 525 526 :return: The additional_notifications of this Witness. # noqa: E501 527 :rtype: list[RecipientAdditionalNotification] 528 """ 529 return self._additional_notifications 530 531 @additional_notifications.setter 532 def additional_notifications(self, additional_notifications): 533 """Sets the additional_notifications of this Witness. 534 535 # noqa: E501 536 537 :param additional_notifications: The additional_notifications of this Witness. # noqa: E501 538 :type: list[RecipientAdditionalNotification] 539 """ 540 541 self._additional_notifications = additional_notifications 542 543 @property 544 def agent_can_edit_email(self): 545 """Gets the agent_can_edit_email of this Witness. # noqa: E501 546 547 # noqa: E501 548 549 :return: The agent_can_edit_email of this Witness. # noqa: E501 550 :rtype: str 551 """ 552 return self._agent_can_edit_email 553 554 @agent_can_edit_email.setter 555 def agent_can_edit_email(self, agent_can_edit_email): 556 """Sets the agent_can_edit_email of this Witness. 557 558 # noqa: E501 559 560 :param agent_can_edit_email: The agent_can_edit_email of this Witness. # noqa: E501 561 :type: str 562 """ 563 564 self._agent_can_edit_email = agent_can_edit_email 565 566 @property 567 def agent_can_edit_name(self): 568 """Gets the agent_can_edit_name of this Witness. # noqa: E501 569 570 # noqa: E501 571 572 :return: The agent_can_edit_name of this Witness. # noqa: E501 573 :rtype: str 574 """ 575 return self._agent_can_edit_name 576 577 @agent_can_edit_name.setter 578 def agent_can_edit_name(self, agent_can_edit_name): 579 """Sets the agent_can_edit_name of this Witness. 580 581 # noqa: E501 582 583 :param agent_can_edit_name: The agent_can_edit_name of this Witness. # noqa: E501 584 :type: str 585 """ 586 587 self._agent_can_edit_name = agent_can_edit_name 588 589 @property 590 def allow_system_override_for_locked_recipient(self): 591 """Gets the allow_system_override_for_locked_recipient of this Witness. # noqa: E501 592 593 # noqa: E501 594 595 :return: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 596 :rtype: str 597 """ 598 return self._allow_system_override_for_locked_recipient 599 600 @allow_system_override_for_locked_recipient.setter 601 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 602 """Sets the allow_system_override_for_locked_recipient of this Witness. 603 604 # noqa: E501 605 606 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this Witness. # noqa: E501 607 :type: str 608 """ 609 610 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 611 612 @property 613 def auto_navigation(self): 614 """Gets the auto_navigation of this Witness. # noqa: E501 615 616 # noqa: E501 617 618 :return: The auto_navigation of this Witness. # noqa: E501 619 :rtype: str 620 """ 621 return self._auto_navigation 622 623 @auto_navigation.setter 624 def auto_navigation(self, auto_navigation): 625 """Sets the auto_navigation of this Witness. 626 627 # noqa: E501 628 629 :param auto_navigation: The auto_navigation of this Witness. # noqa: E501 630 :type: str 631 """ 632 633 self._auto_navigation = auto_navigation 634 635 @property 636 def auto_responded_reason(self): 637 """Gets the auto_responded_reason of this Witness. # noqa: E501 638 639 # noqa: E501 640 641 :return: The auto_responded_reason of this Witness. # noqa: E501 642 :rtype: str 643 """ 644 return self._auto_responded_reason 645 646 @auto_responded_reason.setter 647 def auto_responded_reason(self, auto_responded_reason): 648 """Sets the auto_responded_reason of this Witness. 649 650 # noqa: E501 651 652 :param auto_responded_reason: The auto_responded_reason of this Witness. # noqa: E501 653 :type: str 654 """ 655 656 self._auto_responded_reason = auto_responded_reason 657 658 @property 659 def bulk_recipients_uri(self): 660 """Gets the bulk_recipients_uri of this Witness. # noqa: E501 661 662 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 663 664 :return: The bulk_recipients_uri of this Witness. # noqa: E501 665 :rtype: str 666 """ 667 return self._bulk_recipients_uri 668 669 @bulk_recipients_uri.setter 670 def bulk_recipients_uri(self, bulk_recipients_uri): 671 """Sets the bulk_recipients_uri of this Witness. 672 673 Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501 674 675 :param bulk_recipients_uri: The bulk_recipients_uri of this Witness. # noqa: E501 676 :type: str 677 """ 678 679 self._bulk_recipients_uri = bulk_recipients_uri 680 681 @property 682 def bulk_send_v2_recipient(self): 683 """Gets the bulk_send_v2_recipient of this Witness. # noqa: E501 684 685 # noqa: E501 686 687 :return: The bulk_send_v2_recipient of this Witness. # noqa: E501 688 :rtype: str 689 """ 690 return self._bulk_send_v2_recipient 691 692 @bulk_send_v2_recipient.setter 693 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 694 """Sets the bulk_send_v2_recipient of this Witness. 695 696 # noqa: E501 697 698 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this Witness. # noqa: E501 699 :type: str 700 """ 701 702 self._bulk_send_v2_recipient = bulk_send_v2_recipient 703 704 @property 705 def can_sign_offline(self): 706 """Gets the can_sign_offline of this Witness. # noqa: E501 707 708 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 709 710 :return: The can_sign_offline of this Witness. # noqa: E501 711 :rtype: str 712 """ 713 return self._can_sign_offline 714 715 @can_sign_offline.setter 716 def can_sign_offline(self, can_sign_offline): 717 """Sets the can_sign_offline of this Witness. 718 719 When set to **true**, specifies that the signer can perform the signing ceremony offline. # noqa: E501 720 721 :param can_sign_offline: The can_sign_offline of this Witness. # noqa: E501 722 :type: str 723 """ 724 725 self._can_sign_offline = can_sign_offline 726 727 @property 728 def client_user_id(self): 729 """Gets the client_user_id of this Witness. # noqa: E501 730 731 Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501 732 733 :return: The client_user_id of this Witness. # noqa: E501 734 :rtype: str 735 """ 736 return self._client_user_id 737 738 @client_user_id.setter 739 def client_user_id(self, client_user_id): 740 """Sets the client_user_id of this Witness. 741 742 Specifies whether the recipient is embedded or remote. If the `clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to **true**, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501 743 744 :param client_user_id: The client_user_id of this Witness. # noqa: E501 745 :type: str 746 """ 747 748 self._client_user_id = client_user_id 749 750 @property 751 def completed_count(self): 752 """Gets the completed_count of this Witness. # noqa: E501 753 754 # noqa: E501 755 756 :return: The completed_count of this Witness. # noqa: E501 757 :rtype: str 758 """ 759 return self._completed_count 760 761 @completed_count.setter 762 def completed_count(self, completed_count): 763 """Sets the completed_count of this Witness. 764 765 # noqa: E501 766 767 :param completed_count: The completed_count of this Witness. # noqa: E501 768 :type: str 769 """ 770 771 self._completed_count = completed_count 772 773 @property 774 def consent_details_list(self): 775 """Gets the consent_details_list of this Witness. # noqa: E501 776 777 # noqa: E501 778 779 :return: The consent_details_list of this Witness. # noqa: E501 780 :rtype: list[ConsentDetails] 781 """ 782 return self._consent_details_list 783 784 @consent_details_list.setter 785 def consent_details_list(self, consent_details_list): 786 """Sets the consent_details_list of this Witness. 787 788 # noqa: E501 789 790 :param consent_details_list: The consent_details_list of this Witness. # noqa: E501 791 :type: list[ConsentDetails] 792 """ 793 794 self._consent_details_list = consent_details_list 795 796 @property 797 def creation_reason(self): 798 """Gets the creation_reason of this Witness. # noqa: E501 799 800 # noqa: E501 801 802 :return: The creation_reason of this Witness. # noqa: E501 803 :rtype: str 804 """ 805 return self._creation_reason 806 807 @creation_reason.setter 808 def creation_reason(self, creation_reason): 809 """Sets the creation_reason of this Witness. 810 811 # noqa: E501 812 813 :param creation_reason: The creation_reason of this Witness. # noqa: E501 814 :type: str 815 """ 816 817 self._creation_reason = creation_reason 818 819 @property 820 def custom_fields(self): 821 """Gets the custom_fields of this Witness. # noqa: E501 822 823 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 824 825 :return: The custom_fields of this Witness. # noqa: E501 826 :rtype: list[str] 827 """ 828 return self._custom_fields 829 830 @custom_fields.setter 831 def custom_fields(self, custom_fields): 832 """Sets the custom_fields of this Witness. 833 834 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 835 836 :param custom_fields: The custom_fields of this Witness. # noqa: E501 837 :type: list[str] 838 """ 839 840 self._custom_fields = custom_fields 841 842 @property 843 def declined_date_time(self): 844 """Gets the declined_date_time of this Witness. # noqa: E501 845 846 The date and time the recipient declined the document. # noqa: E501 847 848 :return: The declined_date_time of this Witness. # noqa: E501 849 :rtype: str 850 """ 851 return self._declined_date_time 852 853 @declined_date_time.setter 854 def declined_date_time(self, declined_date_time): 855 """Sets the declined_date_time of this Witness. 856 857 The date and time the recipient declined the document. # noqa: E501 858 859 :param declined_date_time: The declined_date_time of this Witness. # noqa: E501 860 :type: str 861 """ 862 863 self._declined_date_time = declined_date_time 864 865 @property 866 def declined_reason(self): 867 """Gets the declined_reason of this Witness. # noqa: E501 868 869 The reason the recipient declined the document. # noqa: E501 870 871 :return: The declined_reason of this Witness. # noqa: E501 872 :rtype: str 873 """ 874 return self._declined_reason 875 876 @declined_reason.setter 877 def declined_reason(self, declined_reason): 878 """Sets the declined_reason of this Witness. 879 880 The reason the recipient declined the document. # noqa: E501 881 882 :param declined_reason: The declined_reason of this Witness. # noqa: E501 883 :type: str 884 """ 885 886 self._declined_reason = declined_reason 887 888 @property 889 def default_recipient(self): 890 """Gets the default_recipient of this Witness. # noqa: E501 891 892 # noqa: E501 893 894 :return: The default_recipient of this Witness. # noqa: E501 895 :rtype: str 896 """ 897 return self._default_recipient 898 899 @default_recipient.setter 900 def default_recipient(self, default_recipient): 901 """Sets the default_recipient of this Witness. 902 903 # noqa: E501 904 905 :param default_recipient: The default_recipient of this Witness. # noqa: E501 906 :type: str 907 """ 908 909 self._default_recipient = default_recipient 910 911 @property 912 def delegated_by(self): 913 """Gets the delegated_by of this Witness. # noqa: E501 914 915 # noqa: E501 916 917 :return: The delegated_by of this Witness. # noqa: E501 918 :rtype: DelegationInfo 919 """ 920 return self._delegated_by 921 922 @delegated_by.setter 923 def delegated_by(self, delegated_by): 924 """Sets the delegated_by of this Witness. 925 926 # noqa: E501 927 928 :param delegated_by: The delegated_by of this Witness. # noqa: E501 929 :type: DelegationInfo 930 """ 931 932 self._delegated_by = delegated_by 933 934 @property 935 def delegated_to(self): 936 """Gets the delegated_to of this Witness. # noqa: E501 937 938 # noqa: E501 939 940 :return: The delegated_to of this Witness. # noqa: E501 941 :rtype: list[DelegationInfo] 942 """ 943 return self._delegated_to 944 945 @delegated_to.setter 946 def delegated_to(self, delegated_to): 947 """Sets the delegated_to of this Witness. 948 949 # noqa: E501 950 951 :param delegated_to: The delegated_to of this Witness. # noqa: E501 952 :type: list[DelegationInfo] 953 """ 954 955 self._delegated_to = delegated_to 956 957 @property 958 def delivered_date_time(self): 959 """Gets the delivered_date_time of this Witness. # noqa: E501 960 961 Reserved: For DocuSign use only. # noqa: E501 962 963 :return: The delivered_date_time of this Witness. # noqa: E501 964 :rtype: str 965 """ 966 return self._delivered_date_time 967 968 @delivered_date_time.setter 969 def delivered_date_time(self, delivered_date_time): 970 """Sets the delivered_date_time of this Witness. 971 972 Reserved: For DocuSign use only. # noqa: E501 973 974 :param delivered_date_time: The delivered_date_time of this Witness. # noqa: E501 975 :type: str 976 """ 977 978 self._delivered_date_time = delivered_date_time 979 980 @property 981 def delivery_method(self): 982 """Gets the delivery_method of this Witness. # noqa: E501 983 984 Reserved: For DocuSign use only. # noqa: E501 985 986 :return: The delivery_method of this Witness. # noqa: E501 987 :rtype: str 988 """ 989 return self._delivery_method 990 991 @delivery_method.setter 992 def delivery_method(self, delivery_method): 993 """Sets the delivery_method of this Witness. 994 995 Reserved: For DocuSign use only. # noqa: E501 996 997 :param delivery_method: The delivery_method of this Witness. # noqa: E501 998 :type: str 999 """ 1000 1001 self._delivery_method = delivery_method 1002 1003 @property 1004 def delivery_method_metadata(self): 1005 """Gets the delivery_method_metadata of this Witness. # noqa: E501 1006 1007 Reserved for DocuSign. # noqa: E501 1008 1009 :return: The delivery_method_metadata of this Witness. # noqa: E501 1010 :rtype: PropertyMetadata 1011 """ 1012 return self._delivery_method_metadata 1013 1014 @delivery_method_metadata.setter 1015 def delivery_method_metadata(self, delivery_method_metadata): 1016 """Sets the delivery_method_metadata of this Witness. 1017 1018 Reserved for DocuSign. # noqa: E501 1019 1020 :param delivery_method_metadata: The delivery_method_metadata of this Witness. # noqa: E501 1021 :type: PropertyMetadata 1022 """ 1023 1024 self._delivery_method_metadata = delivery_method_metadata 1025 1026 @property 1027 def designator_id(self): 1028 """Gets the designator_id of this Witness. # noqa: E501 1029 1030 # noqa: E501 1031 1032 :return: The designator_id of this Witness. # noqa: E501 1033 :rtype: str 1034 """ 1035 return self._designator_id 1036 1037 @designator_id.setter 1038 def designator_id(self, designator_id): 1039 """Sets the designator_id of this Witness. 1040 1041 # noqa: E501 1042 1043 :param designator_id: The designator_id of this Witness. # noqa: E501 1044 :type: str 1045 """ 1046 1047 self._designator_id = designator_id 1048 1049 @property 1050 def designator_id_guid(self): 1051 """Gets the designator_id_guid of this Witness. # noqa: E501 1052 1053 # noqa: E501 1054 1055 :return: The designator_id_guid of this Witness. # noqa: E501 1056 :rtype: str 1057 """ 1058 return self._designator_id_guid 1059 1060 @designator_id_guid.setter 1061 def designator_id_guid(self, designator_id_guid): 1062 """Sets the designator_id_guid of this Witness. 1063 1064 # noqa: E501 1065 1066 :param designator_id_guid: The designator_id_guid of this Witness. # noqa: E501 1067 :type: str 1068 """ 1069 1070 self._designator_id_guid = designator_id_guid 1071 1072 @property 1073 def document_visibility(self): 1074 """Gets the document_visibility of this Witness. # noqa: E501 1075 1076 # noqa: E501 1077 1078 :return: The document_visibility of this Witness. # noqa: E501 1079 :rtype: list[DocumentVisibility] 1080 """ 1081 return self._document_visibility 1082 1083 @document_visibility.setter 1084 def document_visibility(self, document_visibility): 1085 """Sets the document_visibility of this Witness. 1086 1087 # noqa: E501 1088 1089 :param document_visibility: The document_visibility of this Witness. # noqa: E501 1090 :type: list[DocumentVisibility] 1091 """ 1092 1093 self._document_visibility = document_visibility 1094 1095 @property 1096 def email(self): 1097 """Gets the email of this Witness. # noqa: E501 1098 1099 # noqa: E501 1100 1101 :return: The email of this Witness. # noqa: E501 1102 :rtype: str 1103 """ 1104 return self._email 1105 1106 @email.setter 1107 def email(self, email): 1108 """Sets the email of this Witness. 1109 1110 # noqa: E501 1111 1112 :param email: The email of this Witness. # noqa: E501 1113 :type: str 1114 """ 1115 1116 self._email = email 1117 1118 @property 1119 def email_metadata(self): 1120 """Gets the email_metadata of this Witness. # noqa: E501 1121 1122 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1123 1124 :return: The email_metadata of this Witness. # noqa: E501 1125 :rtype: PropertyMetadata 1126 """ 1127 return self._email_metadata 1128 1129 @email_metadata.setter 1130 def email_metadata(self, email_metadata): 1131 """Sets the email_metadata of this Witness. 1132 1133 Metadata that indicates whether the `email` property is editable. This property is read-only. # noqa: E501 1134 1135 :param email_metadata: The email_metadata of this Witness. # noqa: E501 1136 :type: PropertyMetadata 1137 """ 1138 1139 self._email_metadata = email_metadata 1140 1141 @property 1142 def email_notification(self): 1143 """Gets the email_notification of this Witness. # noqa: E501 1144 1145 A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. # noqa: E501 1146 1147 :return: The email_notification of this Witness. # noqa: E501 1148 :rtype: RecipientEmailNotification 1149 """ 1150 return self._email_notification 1151 1152 @email_notification.setter 1153 def email_notification(self, email_notification): 1154 """Sets the email_notification of this Witness. 1155 1156 A complex type that contains information sets the language of the recipient's email information. **IMPORTANT**: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and `EmailBlurb` property settings. # noqa: E501 1157 1158 :param email_notification: The email_notification of this Witness. # noqa: E501 1159 :type: RecipientEmailNotification 1160 """ 1161 1162 self._email_notification = email_notification 1163 1164 @property 1165 def email_recipient_post_signing_url(self): 1166 """Gets the email_recipient_post_signing_url of this Witness. # noqa: E501 1167 1168 # noqa: E501 1169 1170 :return: The email_recipient_post_signing_url of this Witness. # noqa: E501 1171 :rtype: str 1172 """ 1173 return self._email_recipient_post_signing_url 1174 1175 @email_recipient_post_signing_url.setter 1176 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 1177 """Sets the email_recipient_post_signing_url of this Witness. 1178 1179 # noqa: E501 1180 1181 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Witness. # noqa: E501 1182 :type: str 1183 """ 1184 1185 self._email_recipient_post_signing_url = email_recipient_post_signing_url 1186 1187 @property 1188 def embedded_recipient_start_url(self): 1189 """Gets the embedded_recipient_start_url of this Witness. # noqa: E501 1190 1191 Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501 1192 1193 :return: The embedded_recipient_start_url of this Witness. # noqa: E501 1194 :rtype: str 1195 """ 1196 return self._embedded_recipient_start_url 1197 1198 @embedded_recipient_start_url.setter 1199 def embedded_recipient_start_url(self, embedded_recipient_start_url): 1200 """Sets the embedded_recipient_start_url of this Witness. 1201 1202 Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to `SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets `EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. *Example*: `http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]]` # noqa: E501 1203 1204 :param embedded_recipient_start_url: The embedded_recipient_start_url of this Witness. # noqa: E501 1205 :type: str 1206 """ 1207 1208 self._embedded_recipient_start_url = embedded_recipient_start_url 1209 1210 @property 1211 def error_details(self): 1212 """Gets the error_details of this Witness. # noqa: E501 1213 1214 Array or errors. # noqa: E501 1215 1216 :return: The error_details of this Witness. # noqa: E501 1217 :rtype: ErrorDetails 1218 """ 1219 return self._error_details 1220 1221 @error_details.setter 1222 def error_details(self, error_details): 1223 """Sets the error_details of this Witness. 1224 1225 Array or errors. # noqa: E501 1226 1227 :param error_details: The error_details of this Witness. # noqa: E501 1228 :type: ErrorDetails 1229 """ 1230 1231 self._error_details = error_details 1232 1233 @property 1234 def excluded_documents(self): 1235 """Gets the excluded_documents of this Witness. # noqa: E501 1236 1237 Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, 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. # noqa: E501 1238 1239 :return: The excluded_documents of this Witness. # noqa: E501 1240 :rtype: list[str] 1241 """ 1242 return self._excluded_documents 1243 1244 @excluded_documents.setter 1245 def excluded_documents(self, excluded_documents): 1246 """Sets the excluded_documents of this Witness. 1247 1248 Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the `enforceSignerVisibility` property must be set to **true** for the envelope to use this. When enforce signer visibility is enabled, 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. # noqa: E501 1249 1250 :param excluded_documents: The excluded_documents of this Witness. # noqa: E501 1251 :type: list[str] 1252 """ 1253 1254 self._excluded_documents = excluded_documents 1255 1256 @property 1257 def fax_number(self): 1258 """Gets the fax_number of this Witness. # noqa: E501 1259 1260 Reserved: # noqa: E501 1261 1262 :return: The fax_number of this Witness. # noqa: E501 1263 :rtype: str 1264 """ 1265 return self._fax_number 1266 1267 @fax_number.setter 1268 def fax_number(self, fax_number): 1269 """Sets the fax_number of this Witness. 1270 1271 Reserved: # noqa: E501 1272 1273 :param fax_number: The fax_number of this Witness. # noqa: E501 1274 :type: str 1275 """ 1276 1277 self._fax_number = fax_number 1278 1279 @property 1280 def fax_number_metadata(self): 1281 """Gets the fax_number_metadata of this Witness. # noqa: E501 1282 1283 Reserved for DocuSign. # noqa: E501 1284 1285 :return: The fax_number_metadata of this Witness. # noqa: E501 1286 :rtype: PropertyMetadata 1287 """ 1288 return self._fax_number_metadata 1289 1290 @fax_number_metadata.setter 1291 def fax_number_metadata(self, fax_number_metadata): 1292 """Sets the fax_number_metadata of this Witness. 1293 1294 Reserved for DocuSign. # noqa: E501 1295 1296 :param fax_number_metadata: The fax_number_metadata of this Witness. # noqa: E501 1297 :type: PropertyMetadata 1298 """ 1299 1300 self._fax_number_metadata = fax_number_metadata 1301 1302 @property 1303 def first_name(self): 1304 """Gets the first_name of this Witness. # noqa: E501 1305 1306 The user's first name. Maximum Length: 50 characters. # noqa: E501 1307 1308 :return: The first_name of this Witness. # noqa: E501 1309 :rtype: str 1310 """ 1311 return self._first_name 1312 1313 @first_name.setter 1314 def first_name(self, first_name): 1315 """Sets the first_name of this Witness. 1316 1317 The user's first name. Maximum Length: 50 characters. # noqa: E501 1318 1319 :param first_name: The first_name of this Witness. # noqa: E501 1320 :type: str 1321 """ 1322 1323 self._first_name = first_name 1324 1325 @property 1326 def first_name_metadata(self): 1327 """Gets the first_name_metadata of this Witness. # noqa: E501 1328 1329 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1330 1331 :return: The first_name_metadata of this Witness. # noqa: E501 1332 :rtype: PropertyMetadata 1333 """ 1334 return self._first_name_metadata 1335 1336 @first_name_metadata.setter 1337 def first_name_metadata(self, first_name_metadata): 1338 """Sets the first_name_metadata of this Witness. 1339 1340 Metadata that indicates whether the `firstName` property is editable. This property is read-only. # noqa: E501 1341 1342 :param first_name_metadata: The first_name_metadata of this Witness. # noqa: E501 1343 :type: PropertyMetadata 1344 """ 1345 1346 self._first_name_metadata = first_name_metadata 1347 1348 @property 1349 def full_name(self): 1350 """Gets the full_name of this Witness. # noqa: E501 1351 1352 # noqa: E501 1353 1354 :return: The full_name of this Witness. # noqa: E501 1355 :rtype: str 1356 """ 1357 return self._full_name 1358 1359 @full_name.setter 1360 def full_name(self, full_name): 1361 """Sets the full_name of this Witness. 1362 1363 # noqa: E501 1364 1365 :param full_name: The full_name of this Witness. # noqa: E501 1366 :type: str 1367 """ 1368 1369 self._full_name = full_name 1370 1371 @property 1372 def full_name_metadata(self): 1373 """Gets the full_name_metadata of this Witness. # noqa: E501 1374 1375 Reserved for DocuSign. # noqa: E501 1376 1377 :return: The full_name_metadata of this Witness. # noqa: E501 1378 :rtype: PropertyMetadata 1379 """ 1380 return self._full_name_metadata 1381 1382 @full_name_metadata.setter 1383 def full_name_metadata(self, full_name_metadata): 1384 """Sets the full_name_metadata of this Witness. 1385 1386 Reserved for DocuSign. # noqa: E501 1387 1388 :param full_name_metadata: The full_name_metadata of this Witness. # noqa: E501 1389 :type: PropertyMetadata 1390 """ 1391 1392 self._full_name_metadata = full_name_metadata 1393 1394 @property 1395 def id_check_configuration_name(self): 1396 """Gets the id_check_configuration_name of this Witness. # noqa: E501 1397 1398 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 1399 1400 :return: The id_check_configuration_name of this Witness. # noqa: E501 1401 :rtype: str 1402 """ 1403 return self._id_check_configuration_name 1404 1405 @id_check_configuration_name.setter 1406 def id_check_configuration_name(self, id_check_configuration_name): 1407 """Sets the id_check_configuration_name of this Witness. 1408 1409 Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. *Example*: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the `smsAuthentication` node. # noqa: E501 1410 1411 :param id_check_configuration_name: The id_check_configuration_name of this Witness. # noqa: E501 1412 :type: str 1413 """ 1414 1415 self._id_check_configuration_name = id_check_configuration_name 1416 1417 @property 1418 def id_check_configuration_name_metadata(self): 1419 """Gets the id_check_configuration_name_metadata of this Witness. # noqa: E501 1420 1421 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1422 1423 :return: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1424 :rtype: PropertyMetadata 1425 """ 1426 return self._id_check_configuration_name_metadata 1427 1428 @id_check_configuration_name_metadata.setter 1429 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1430 """Sets the id_check_configuration_name_metadata of this Witness. 1431 1432 Metadata that indicates whether the `idCheckConfigurationName` property is editable. This property is read-only. # noqa: E501 1433 1434 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this Witness. # noqa: E501 1435 :type: PropertyMetadata 1436 """ 1437 1438 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1439 1440 @property 1441 def id_check_information_input(self): 1442 """Gets the id_check_information_input of this Witness. # noqa: E501 1443 1444 An object that contains input information related to a recipient ID check. # noqa: E501 1445 1446 :return: The id_check_information_input of this Witness. # noqa: E501 1447 :rtype: IdCheckInformationInput 1448 """ 1449 return self._id_check_information_input 1450 1451 @id_check_information_input.setter 1452 def id_check_information_input(self, id_check_information_input): 1453 """Sets the id_check_information_input of this Witness. 1454 1455 An object that contains input information related to a recipient ID check. # noqa: E501 1456 1457 :param id_check_information_input: The id_check_information_input of this Witness. # noqa: E501 1458 :type: IdCheckInformationInput 1459 """ 1460 1461 self._id_check_information_input = id_check_information_input 1462 1463 @property 1464 def identity_verification(self): 1465 """Gets the identity_verification of this Witness. # noqa: E501 1466 1467 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1468 1469 :return: The identity_verification of this Witness. # noqa: E501 1470 :rtype: RecipientIdentityVerification 1471 """ 1472 return self._identity_verification 1473 1474 @identity_verification.setter 1475 def identity_verification(self, identity_verification): 1476 """Sets the identity_verification of this Witness. 1477 1478 Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](https://support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501 1479 1480 :param identity_verification: The identity_verification of this Witness. # noqa: E501 1481 :type: RecipientIdentityVerification 1482 """ 1483 1484 self._identity_verification = identity_verification 1485 1486 @property 1487 def inherit_email_notification_configuration(self): 1488 """Gets the inherit_email_notification_configuration of this Witness. # noqa: E501 1489 1490 When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501 1491 1492 :return: The inherit_email_notification_configuration of this Witness. # noqa: E501 1493 :rtype: str 1494 """ 1495 return self._inherit_email_notification_configuration 1496 1497 @inherit_email_notification_configuration.setter 1498 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1499 """Sets the inherit_email_notification_configuration of this Witness. 1500 1501 When set to **true** and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501 1502 1503 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this Witness. # noqa: E501 1504 :type: str 1505 """ 1506 1507 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1508 1509 @property 1510 def is_bulk_recipient(self): 1511 """Gets the is_bulk_recipient of this Witness. # noqa: E501 1512 1513 # noqa: E501 1514 1515 :return: The is_bulk_recipient of this Witness. # noqa: E501 1516 :rtype: str 1517 """ 1518 return self._is_bulk_recipient 1519 1520 @is_bulk_recipient.setter 1521 def is_bulk_recipient(self, is_bulk_recipient): 1522 """Sets the is_bulk_recipient of this Witness. 1523 1524 # noqa: E501 1525 1526 :param is_bulk_recipient: The is_bulk_recipient of this Witness. # noqa: E501 1527 :type: str 1528 """ 1529 1530 self._is_bulk_recipient = is_bulk_recipient 1531 1532 @property 1533 def is_bulk_recipient_metadata(self): 1534 """Gets the is_bulk_recipient_metadata of this Witness. # noqa: E501 1535 1536 Reserved for DocuSign. # noqa: E501 1537 1538 :return: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1539 :rtype: PropertyMetadata 1540 """ 1541 return self._is_bulk_recipient_metadata 1542 1543 @is_bulk_recipient_metadata.setter 1544 def is_bulk_recipient_metadata(self, is_bulk_recipient_metadata): 1545 """Sets the is_bulk_recipient_metadata of this Witness. 1546 1547 Reserved for DocuSign. # noqa: E501 1548 1549 :param is_bulk_recipient_metadata: The is_bulk_recipient_metadata of this Witness. # noqa: E501 1550 :type: PropertyMetadata 1551 """ 1552 1553 self._is_bulk_recipient_metadata = is_bulk_recipient_metadata 1554 1555 @property 1556 def last_name(self): 1557 """Gets the last_name of this Witness. # noqa: E501 1558 1559 # noqa: E501 1560 1561 :return: The last_name of this Witness. # noqa: E501 1562 :rtype: str 1563 """ 1564 return self._last_name 1565 1566 @last_name.setter 1567 def last_name(self, last_name): 1568 """Sets the last_name of this Witness. 1569 1570 # noqa: E501 1571 1572 :param last_name: The last_name of this Witness. # noqa: E501 1573 :type: str 1574 """ 1575 1576 self._last_name = last_name 1577 1578 @property 1579 def last_name_metadata(self): 1580 """Gets the last_name_metadata of this Witness. # noqa: E501 1581 1582 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1583 1584 :return: The last_name_metadata of this Witness. # noqa: E501 1585 :rtype: PropertyMetadata 1586 """ 1587 return self._last_name_metadata 1588 1589 @last_name_metadata.setter 1590 def last_name_metadata(self, last_name_metadata): 1591 """Sets the last_name_metadata of this Witness. 1592 1593 Metadata that indicates whether the `lastName` property is editable. This property is read-only. # noqa: E501 1594 1595 :param last_name_metadata: The last_name_metadata of this Witness. # noqa: E501 1596 :type: PropertyMetadata 1597 """ 1598 1599 self._last_name_metadata = last_name_metadata 1600 1601 @property 1602 def locked_recipient_phone_auth_editable(self): 1603 """Gets the locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1604 1605 # noqa: E501 1606 1607 :return: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1608 :rtype: str 1609 """ 1610 return self._locked_recipient_phone_auth_editable 1611 1612 @locked_recipient_phone_auth_editable.setter 1613 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1614 """Sets the locked_recipient_phone_auth_editable of this Witness. 1615 1616 # noqa: E501 1617 1618 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this Witness. # noqa: E501 1619 :type: str 1620 """ 1621 1622 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1623 1624 @property 1625 def locked_recipient_sms_editable(self): 1626 """Gets the locked_recipient_sms_editable of this Witness. # noqa: E501 1627 1628 # noqa: E501 1629 1630 :return: The locked_recipient_sms_editable of this Witness. # noqa: E501 1631 :rtype: str 1632 """ 1633 return self._locked_recipient_sms_editable 1634 1635 @locked_recipient_sms_editable.setter 1636 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1637 """Sets the locked_recipient_sms_editable of this Witness. 1638 1639 # noqa: E501 1640 1641 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this Witness. # noqa: E501 1642 :type: str 1643 """ 1644 1645 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1646 1647 @property 1648 def name(self): 1649 """Gets the name of this Witness. # noqa: E501 1650 1651 # noqa: E501 1652 1653 :return: The name of this Witness. # noqa: E501 1654 :rtype: str 1655 """ 1656 return self._name 1657 1658 @name.setter 1659 def name(self, name): 1660 """Sets the name of this Witness. 1661 1662 # noqa: E501 1663 1664 :param name: The name of this Witness. # noqa: E501 1665 :type: str 1666 """ 1667 1668 self._name = name 1669 1670 @property 1671 def name_metadata(self): 1672 """Gets the name_metadata of this Witness. # noqa: E501 1673 1674 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1675 1676 :return: The name_metadata of this Witness. # noqa: E501 1677 :rtype: PropertyMetadata 1678 """ 1679 return self._name_metadata 1680 1681 @name_metadata.setter 1682 def name_metadata(self, name_metadata): 1683 """Sets the name_metadata of this Witness. 1684 1685 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1686 1687 :param name_metadata: The name_metadata of this Witness. # noqa: E501 1688 :type: PropertyMetadata 1689 """ 1690 1691 self._name_metadata = name_metadata 1692 1693 @property 1694 def notary_id(self): 1695 """Gets the notary_id of this Witness. # noqa: E501 1696 1697 # noqa: E501 1698 1699 :return: The notary_id of this Witness. # noqa: E501 1700 :rtype: str 1701 """ 1702 return self._notary_id 1703 1704 @notary_id.setter 1705 def notary_id(self, notary_id): 1706 """Sets the notary_id of this Witness. 1707 1708 # noqa: E501 1709 1710 :param notary_id: The notary_id of this Witness. # noqa: E501 1711 :type: str 1712 """ 1713 1714 self._notary_id = notary_id 1715 1716 @property 1717 def notary_signer_email_sent(self): 1718 """Gets the notary_signer_email_sent of this Witness. # noqa: E501 1719 1720 # noqa: E501 1721 1722 :return: The notary_signer_email_sent of this Witness. # noqa: E501 1723 :rtype: str 1724 """ 1725 return self._notary_signer_email_sent 1726 1727 @notary_signer_email_sent.setter 1728 def notary_signer_email_sent(self, notary_signer_email_sent): 1729 """Sets the notary_signer_email_sent of this Witness. 1730 1731 # noqa: E501 1732 1733 :param notary_signer_email_sent: The notary_signer_email_sent of this Witness. # noqa: E501 1734 :type: str 1735 """ 1736 1737 self._notary_signer_email_sent = notary_signer_email_sent 1738 1739 @property 1740 def note(self): 1741 """Gets the note of this Witness. # noqa: E501 1742 1743 Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501 1744 1745 :return: The note of this Witness. # noqa: E501 1746 :rtype: str 1747 """ 1748 return self._note 1749 1750 @note.setter 1751 def note(self, note): 1752 """Sets the note of this Witness. 1753 1754 Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501 1755 1756 :param note: The note of this Witness. # noqa: E501 1757 :type: str 1758 """ 1759 1760 self._note = note 1761 1762 @property 1763 def note_metadata(self): 1764 """Gets the note_metadata of this Witness. # noqa: E501 1765 1766 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1767 1768 :return: The note_metadata of this Witness. # noqa: E501 1769 :rtype: PropertyMetadata 1770 """ 1771 return self._note_metadata 1772 1773 @note_metadata.setter 1774 def note_metadata(self, note_metadata): 1775 """Sets the note_metadata of this Witness. 1776 1777 Metadata that indicates whether the `note` property is editable. This property is read-only. # noqa: E501 1778 1779 :param note_metadata: The note_metadata of this Witness. # noqa: E501 1780 :type: PropertyMetadata 1781 """ 1782 1783 self._note_metadata = note_metadata 1784 1785 @property 1786 def offline_attributes(self): 1787 """Gets the offline_attributes of this Witness. # noqa: E501 1788 1789 Reserved for DocuSign. # noqa: E501 1790 1791 :return: The offline_attributes of this Witness. # noqa: E501 1792 :rtype: OfflineAttributes 1793 """ 1794 return self._offline_attributes 1795 1796 @offline_attributes.setter 1797 def offline_attributes(self, offline_attributes): 1798 """Sets the offline_attributes of this Witness. 1799 1800 Reserved for DocuSign. # noqa: E501 1801 1802 :param offline_attributes: The offline_attributes of this Witness. # noqa: E501 1803 :type: OfflineAttributes 1804 """ 1805 1806 self._offline_attributes = offline_attributes 1807 1808 @property 1809 def phone_authentication(self): 1810 """Gets the phone_authentication of this Witness. # noqa: E501 1811 1812 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1813 1814 :return: The phone_authentication of this Witness. # noqa: E501 1815 :rtype: RecipientPhoneAuthentication 1816 """ 1817 return self._phone_authentication 1818 1819 @phone_authentication.setter 1820 def phone_authentication(self, phone_authentication): 1821 """Sets the phone_authentication of this Witness. 1822 1823 When `idCheckConfigurationName` is set to `Phone Auth $`, you use this complex type to provide the recipient authentication method details. It contains the following elements: * `recipMayProvideNumber`: Boolean. When **true,** the recipient can use whatever phone number they choose. * `senderProvidedNumbers`: ArrayOfStrings. A list of phone numbers the recipient can use. * `recordVoicePrint`: Reserved for DocuSign. * `validateRecipProvidedNumber`: Reserved for DocuSign. # noqa: E501 1824 1825 :param phone_authentication: The phone_authentication of this Witness. # noqa: E501 1826 :type: RecipientPhoneAuthentication 1827 """ 1828 1829 self._phone_authentication = phone_authentication 1830 1831 @property 1832 def phone_number(self): 1833 """Gets the phone_number of this Witness. # noqa: E501 1834 1835 Describes the recipient phone number. # noqa: E501 1836 1837 :return: The phone_number of this Witness. # noqa: E501 1838 :rtype: RecipientPhoneNumber 1839 """ 1840 return self._phone_number 1841 1842 @phone_number.setter 1843 def phone_number(self, phone_number): 1844 """Sets the phone_number of this Witness. 1845 1846 Describes the recipient phone number. # noqa: E501 1847 1848 :param phone_number: The phone_number of this Witness. # noqa: E501 1849 :type: RecipientPhoneNumber 1850 """ 1851 1852 self._phone_number = phone_number 1853 1854 @property 1855 def proof_file(self): 1856 """Gets the proof_file of this Witness. # noqa: E501 1857 1858 The proof file of the recipient. # noqa: E501 1859 1860 :return: The proof_file of this Witness. # noqa: E501 1861 :rtype: RecipientProofFile 1862 """ 1863 return self._proof_file 1864 1865 @proof_file.setter 1866 def proof_file(self, proof_file): 1867 """Sets the proof_file of this Witness. 1868 1869 The proof file of the recipient. # noqa: E501 1870 1871 :param proof_file: The proof_file of this Witness. # noqa: E501 1872 :type: RecipientProofFile 1873 """ 1874 1875 self._proof_file = proof_file 1876 1877 @property 1878 def recipient_attachments(self): 1879 """Gets the recipient_attachments of this Witness. # noqa: E501 1880 1881 Reserved: # noqa: E501 1882 1883 :return: The recipient_attachments of this Witness. # noqa: E501 1884 :rtype: list[RecipientAttachment] 1885 """ 1886 return self._recipient_attachments 1887 1888 @recipient_attachments.setter 1889 def recipient_attachments(self, recipient_attachments): 1890 """Sets the recipient_attachments of this Witness. 1891 1892 Reserved: # noqa: E501 1893 1894 :param recipient_attachments: The recipient_attachments of this Witness. # noqa: E501 1895 :type: list[RecipientAttachment] 1896 """ 1897 1898 self._recipient_attachments = recipient_attachments 1899 1900 @property 1901 def recipient_authentication_status(self): 1902 """Gets the recipient_authentication_status of this Witness. # noqa: E501 1903 1904 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1905 1906 :return: The recipient_authentication_status of this Witness. # noqa: E501 1907 :rtype: AuthenticationStatus 1908 """ 1909 return self._recipient_authentication_status 1910 1911 @recipient_authentication_status.setter 1912 def recipient_authentication_status(self, recipient_authentication_status): 1913 """Sets the recipient_authentication_status of this Witness. 1914 1915 Information about the recipient's authentication status. This property is read-only. # noqa: E501 1916 1917 :param recipient_authentication_status: The recipient_authentication_status of this Witness. # noqa: E501 1918 :type: AuthenticationStatus 1919 """ 1920 1921 self._recipient_authentication_status = recipient_authentication_status 1922 1923 @property 1924 def recipient_feature_metadata(self): 1925 """Gets the recipient_feature_metadata of this Witness. # noqa: E501 1926 1927 # noqa: E501 1928 1929 :return: The recipient_feature_metadata of this Witness. # noqa: E501 1930 :rtype: list[FeatureAvailableMetadata] 1931 """ 1932 return self._recipient_feature_metadata 1933 1934 @recipient_feature_metadata.setter 1935 def recipient_feature_metadata(self, recipient_feature_metadata): 1936 """Sets the recipient_feature_metadata of this Witness. 1937 1938 # noqa: E501 1939 1940 :param recipient_feature_metadata: The recipient_feature_metadata of this Witness. # noqa: E501 1941 :type: list[FeatureAvailableMetadata] 1942 """ 1943 1944 self._recipient_feature_metadata = recipient_feature_metadata 1945 1946 @property 1947 def recipient_id(self): 1948 """Gets the recipient_id of this Witness. # noqa: E501 1949 1950 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1951 1952 :return: The recipient_id of this Witness. # noqa: E501 1953 :rtype: str 1954 """ 1955 return self._recipient_id 1956 1957 @recipient_id.setter 1958 def recipient_id(self, recipient_id): 1959 """Sets the recipient_id of this Witness. 1960 1961 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1962 1963 :param recipient_id: The recipient_id of this Witness. # noqa: E501 1964 :type: str 1965 """ 1966 1967 self._recipient_id = recipient_id 1968 1969 @property 1970 def recipient_id_guid(self): 1971 """Gets the recipient_id_guid of this Witness. # noqa: E501 1972 1973 # noqa: E501 1974 1975 :return: The recipient_id_guid of this Witness. # noqa: E501 1976 :rtype: str 1977 """ 1978 return self._recipient_id_guid 1979 1980 @recipient_id_guid.setter 1981 def recipient_id_guid(self, recipient_id_guid): 1982 """Sets the recipient_id_guid of this Witness. 1983 1984 # noqa: E501 1985 1986 :param recipient_id_guid: The recipient_id_guid of this Witness. # noqa: E501 1987 :type: str 1988 """ 1989 1990 self._recipient_id_guid = recipient_id_guid 1991 1992 @property 1993 def recipient_signature_providers(self): 1994 """Gets the recipient_signature_providers of this Witness. # noqa: E501 1995 1996 # noqa: E501 1997 1998 :return: The recipient_signature_providers of this Witness. # noqa: E501 1999 :rtype: list[RecipientSignatureProvider] 2000 """ 2001 return self._recipient_signature_providers 2002 2003 @recipient_signature_providers.setter 2004 def recipient_signature_providers(self, recipient_signature_providers): 2005 """Sets the recipient_signature_providers of this Witness. 2006 2007 # noqa: E501 2008 2009 :param recipient_signature_providers: The recipient_signature_providers of this Witness. # noqa: E501 2010 :type: list[RecipientSignatureProvider] 2011 """ 2012 2013 self._recipient_signature_providers = recipient_signature_providers 2014 2015 @property 2016 def recipient_supplies_tabs(self): 2017 """Gets the recipient_supplies_tabs of this Witness. # noqa: E501 2018 2019 # noqa: E501 2020 2021 :return: The recipient_supplies_tabs of this Witness. # noqa: E501 2022 :rtype: str 2023 """ 2024 return self._recipient_supplies_tabs 2025 2026 @recipient_supplies_tabs.setter 2027 def recipient_supplies_tabs(self, recipient_supplies_tabs): 2028 """Sets the recipient_supplies_tabs of this Witness. 2029 2030 # noqa: E501 2031 2032 :param recipient_supplies_tabs: The recipient_supplies_tabs of this Witness. # noqa: E501 2033 :type: str 2034 """ 2035 2036 self._recipient_supplies_tabs = recipient_supplies_tabs 2037 2038 @property 2039 def recipient_type(self): 2040 """Gets the recipient_type of this Witness. # noqa: E501 2041 2042 # noqa: E501 2043 2044 :return: The recipient_type of this Witness. # noqa: E501 2045 :rtype: str 2046 """ 2047 return self._recipient_type 2048 2049 @recipient_type.setter 2050 def recipient_type(self, recipient_type): 2051 """Sets the recipient_type of this Witness. 2052 2053 # noqa: E501 2054 2055 :param recipient_type: The recipient_type of this Witness. # noqa: E501 2056 :type: str 2057 """ 2058 2059 self._recipient_type = recipient_type 2060 2061 @property 2062 def recipient_type_metadata(self): 2063 """Gets the recipient_type_metadata of this Witness. # noqa: E501 2064 2065 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2066 2067 :return: The recipient_type_metadata of this Witness. # noqa: E501 2068 :rtype: PropertyMetadata 2069 """ 2070 return self._recipient_type_metadata 2071 2072 @recipient_type_metadata.setter 2073 def recipient_type_metadata(self, recipient_type_metadata): 2074 """Sets the recipient_type_metadata of this Witness. 2075 2076 Metadata that indicates whether the `recipientType` property is editable. This property is read-only. # noqa: E501 2077 2078 :param recipient_type_metadata: The recipient_type_metadata of this Witness. # noqa: E501 2079 :type: PropertyMetadata 2080 """ 2081 2082 self._recipient_type_metadata = recipient_type_metadata 2083 2084 @property 2085 def require_id_lookup(self): 2086 """Gets the require_id_lookup of this Witness. # noqa: E501 2087 2088 When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501 2089 2090 :return: The require_id_lookup of this Witness. # noqa: E501 2091 :rtype: str 2092 """ 2093 return self._require_id_lookup 2094 2095 @require_id_lookup.setter 2096 def require_id_lookup(self, require_id_lookup): 2097 """Sets the require_id_lookup of this Witness. 2098 2099 When set to **true**, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501 2100 2101 :param require_id_lookup: The require_id_lookup of this Witness. # noqa: E501 2102 :type: str 2103 """ 2104 2105 self._require_id_lookup = require_id_lookup 2106 2107 @property 2108 def require_id_lookup_metadata(self): 2109 """Gets the require_id_lookup_metadata of this Witness. # noqa: E501 2110 2111 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2112 2113 :return: The require_id_lookup_metadata of this Witness. # noqa: E501 2114 :rtype: PropertyMetadata 2115 """ 2116 return self._require_id_lookup_metadata 2117 2118 @require_id_lookup_metadata.setter 2119 def require_id_lookup_metadata(self, require_id_lookup_metadata): 2120 """Sets the require_id_lookup_metadata of this Witness. 2121 2122 Metadata that indicates whether the `requireIdLookup` property is editable. This property is read-only. # noqa: E501 2123 2124 :param require_id_lookup_metadata: The require_id_lookup_metadata of this Witness. # noqa: E501 2125 :type: PropertyMetadata 2126 """ 2127 2128 self._require_id_lookup_metadata = require_id_lookup_metadata 2129 2130 @property 2131 def require_signer_certificate(self): 2132 """Gets the require_signer_certificate of this Witness. # noqa: E501 2133 2134 # noqa: E501 2135 2136 :return: The require_signer_certificate of this Witness. # noqa: E501 2137 :rtype: str 2138 """ 2139 return self._require_signer_certificate 2140 2141 @require_signer_certificate.setter 2142 def require_signer_certificate(self, require_signer_certificate): 2143 """Sets the require_signer_certificate of this Witness. 2144 2145 # noqa: E501 2146 2147 :param require_signer_certificate: The require_signer_certificate of this Witness. # noqa: E501 2148 :type: str 2149 """ 2150 2151 self._require_signer_certificate = require_signer_certificate 2152 2153 @property 2154 def require_sign_on_paper(self): 2155 """Gets the require_sign_on_paper of this Witness. # noqa: E501 2156 2157 # noqa: E501 2158 2159 :return: The require_sign_on_paper of this Witness. # noqa: E501 2160 :rtype: str 2161 """ 2162 return self._require_sign_on_paper 2163 2164 @require_sign_on_paper.setter 2165 def require_sign_on_paper(self, require_sign_on_paper): 2166 """Sets the require_sign_on_paper of this Witness. 2167 2168 # noqa: E501 2169 2170 :param require_sign_on_paper: The require_sign_on_paper of this Witness. # noqa: E501 2171 :type: str 2172 """ 2173 2174 self._require_sign_on_paper = require_sign_on_paper 2175 2176 @property 2177 def require_upload_signature(self): 2178 """Gets the require_upload_signature of this Witness. # noqa: E501 2179 2180 # noqa: E501 2181 2182 :return: The require_upload_signature of this Witness. # noqa: E501 2183 :rtype: str 2184 """ 2185 return self._require_upload_signature 2186 2187 @require_upload_signature.setter 2188 def require_upload_signature(self, require_upload_signature): 2189 """Sets the require_upload_signature of this Witness. 2190 2191 # noqa: E501 2192 2193 :param require_upload_signature: The require_upload_signature of this Witness. # noqa: E501 2194 :type: str 2195 """ 2196 2197 self._require_upload_signature = require_upload_signature 2198 2199 @property 2200 def role_name(self): 2201 """Gets the role_name of this Witness. # noqa: E501 2202 2203 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2204 2205 :return: The role_name of this Witness. # noqa: E501 2206 :rtype: str 2207 """ 2208 return self._role_name 2209 2210 @role_name.setter 2211 def role_name(self, role_name): 2212 """Sets the role_name of this Witness. 2213 2214 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 2215 2216 :param role_name: The role_name of this Witness. # noqa: E501 2217 :type: str 2218 """ 2219 2220 self._role_name = role_name 2221 2222 @property 2223 def routing_order(self): 2224 """Gets the routing_order of this Witness. # noqa: E501 2225 2226 Specifies the routing order of the recipient in the envelope. # noqa: E501 2227 2228 :return: The routing_order of this Witness. # noqa: E501 2229 :rtype: str 2230 """ 2231 return self._routing_order 2232 2233 @routing_order.setter 2234 def routing_order(self, routing_order): 2235 """Sets the routing_order of this Witness. 2236 2237 Specifies the routing order of the recipient in the envelope. # noqa: E501 2238 2239 :param routing_order: The routing_order of this Witness. # noqa: E501 2240 :type: str 2241 """ 2242 2243 self._routing_order = routing_order 2244 2245 @property 2246 def routing_order_metadata(self): 2247 """Gets the routing_order_metadata of this Witness. # noqa: E501 2248 2249 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2250 2251 :return: The routing_order_metadata of this Witness. # noqa: E501 2252 :rtype: PropertyMetadata 2253 """ 2254 return self._routing_order_metadata 2255 2256 @routing_order_metadata.setter 2257 def routing_order_metadata(self, routing_order_metadata): 2258 """Sets the routing_order_metadata of this Witness. 2259 2260 Metadata that indicates whether the `routingOrder` property is editable. This property is read-only. # noqa: E501 2261 2262 :param routing_order_metadata: The routing_order_metadata of this Witness. # noqa: E501 2263 :type: PropertyMetadata 2264 """ 2265 2266 self._routing_order_metadata = routing_order_metadata 2267 2268 @property 2269 def sent_date_time(self): 2270 """Gets the sent_date_time of this Witness. # noqa: E501 2271 2272 The date and time the envelope was sent. # noqa: E501 2273 2274 :return: The sent_date_time of this Witness. # noqa: E501 2275 :rtype: str 2276 """ 2277 return self._sent_date_time 2278 2279 @sent_date_time.setter 2280 def sent_date_time(self, sent_date_time): 2281 """Sets the sent_date_time of this Witness. 2282 2283 The date and time the envelope was sent. # noqa: E501 2284 2285 :param sent_date_time: The sent_date_time of this Witness. # noqa: E501 2286 :type: str 2287 """ 2288 2289 self._sent_date_time = sent_date_time 2290 2291 @property 2292 def signature_info(self): 2293 """Gets the signature_info of this Witness. # noqa: E501 2294 2295 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2296 2297 :return: The signature_info of this Witness. # noqa: E501 2298 :rtype: RecipientSignatureInformation 2299 """ 2300 return self._signature_info 2301 2302 @signature_info.setter 2303 def signature_info(self, signature_info): 2304 """Sets the signature_info of this Witness. 2305 2306 Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501 2307 2308 :param signature_info: The signature_info of this Witness. # noqa: E501 2309 :type: RecipientSignatureInformation 2310 """ 2311 2312 self._signature_info = signature_info 2313 2314 @property 2315 def signed_date_time(self): 2316 """Gets the signed_date_time of this Witness. # noqa: E501 2317 2318 Reserved: For DocuSign use only. # noqa: E501 2319 2320 :return: The signed_date_time of this Witness. # noqa: E501 2321 :rtype: str 2322 """ 2323 return self._signed_date_time 2324 2325 @signed_date_time.setter 2326 def signed_date_time(self, signed_date_time): 2327 """Sets the signed_date_time of this Witness. 2328 2329 Reserved: For DocuSign use only. # noqa: E501 2330 2331 :param signed_date_time: The signed_date_time of this Witness. # noqa: E501 2332 :type: str 2333 """ 2334 2335 self._signed_date_time = signed_date_time 2336 2337 @property 2338 def sign_in_each_location(self): 2339 """Gets the sign_in_each_location of this Witness. # noqa: E501 2340 2341 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2342 2343 :return: The sign_in_each_location of this Witness. # noqa: E501 2344 :rtype: str 2345 """ 2346 return self._sign_in_each_location 2347 2348 @sign_in_each_location.setter 2349 def sign_in_each_location(self, sign_in_each_location): 2350 """Sets the sign_in_each_location of this Witness. 2351 2352 When set to **true**, specifies that the signer must sign in all locations. # noqa: E501 2353 2354 :param sign_in_each_location: The sign_in_each_location of this Witness. # noqa: E501 2355 :type: str 2356 """ 2357 2358 self._sign_in_each_location = sign_in_each_location 2359 2360 @property 2361 def sign_in_each_location_metadata(self): 2362 """Gets the sign_in_each_location_metadata of this Witness. # noqa: E501 2363 2364 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2365 2366 :return: The sign_in_each_location_metadata of this Witness. # noqa: E501 2367 :rtype: PropertyMetadata 2368 """ 2369 return self._sign_in_each_location_metadata 2370 2371 @sign_in_each_location_metadata.setter 2372 def sign_in_each_location_metadata(self, sign_in_each_location_metadata): 2373 """Sets the sign_in_each_location_metadata of this Witness. 2374 2375 Metadata that indicates whether the `signInEachLocation` property is editable. This property is read-only. # noqa: E501 2376 2377 :param sign_in_each_location_metadata: The sign_in_each_location_metadata of this Witness. # noqa: E501 2378 :type: PropertyMetadata 2379 """ 2380 2381 self._sign_in_each_location_metadata = sign_in_each_location_metadata 2382 2383 @property 2384 def signing_group_id(self): 2385 """Gets the signing_group_id of this Witness. # noqa: E501 2386 2387 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 2388 2389 :return: The signing_group_id of this Witness. # noqa: E501 2390 :rtype: str 2391 """ 2392 return self._signing_group_id 2393 2394 @signing_group_id.setter 2395 def signing_group_id(self, signing_group_id): 2396 """Sets the signing_group_id of this Witness. 2397 2398 When set to **true** and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501 2399 2400 :param signing_group_id: The signing_group_id of this Witness. # noqa: E501 2401 :type: str 2402 """ 2403 2404 self._signing_group_id = signing_group_id 2405 2406 @property 2407 def signing_group_id_metadata(self): 2408 """Gets the signing_group_id_metadata of this Witness. # noqa: E501 2409 2410 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2411 2412 :return: The signing_group_id_metadata of this Witness. # noqa: E501 2413 :rtype: PropertyMetadata 2414 """ 2415 return self._signing_group_id_metadata 2416 2417 @signing_group_id_metadata.setter 2418 def signing_group_id_metadata(self, signing_group_id_metadata): 2419 """Sets the signing_group_id_metadata of this Witness. 2420 2421 Metadata that indicates whether the `signingGroupId` property is editable. This property is read-only. # noqa: E501 2422 2423 :param signing_group_id_metadata: The signing_group_id_metadata of this Witness. # noqa: E501 2424 :type: PropertyMetadata 2425 """ 2426 2427 self._signing_group_id_metadata = signing_group_id_metadata 2428 2429 @property 2430 def signing_group_name(self): 2431 """Gets the signing_group_name of this Witness. # noqa: E501 2432 2433 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2434 2435 :return: The signing_group_name of this Witness. # noqa: E501 2436 :rtype: str 2437 """ 2438 return self._signing_group_name 2439 2440 @signing_group_name.setter 2441 def signing_group_name(self, signing_group_name): 2442 """Sets the signing_group_name of this Witness. 2443 2444 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 2445 2446 :param signing_group_name: The signing_group_name of this Witness. # noqa: E501 2447 :type: str 2448 """ 2449 2450 self._signing_group_name = signing_group_name 2451 2452 @property 2453 def signing_group_users(self): 2454 """Gets the signing_group_users of this Witness. # noqa: E501 2455 2456 A complex type that contains information about users in the signing group. # noqa: E501 2457 2458 :return: The signing_group_users of this Witness. # noqa: E501 2459 :rtype: list[UserInfo] 2460 """ 2461 return self._signing_group_users 2462 2463 @signing_group_users.setter 2464 def signing_group_users(self, signing_group_users): 2465 """Sets the signing_group_users of this Witness. 2466 2467 A complex type that contains information about users in the signing group. # noqa: E501 2468 2469 :param signing_group_users: The signing_group_users of this Witness. # noqa: E501 2470 :type: list[UserInfo] 2471 """ 2472 2473 self._signing_group_users = signing_group_users 2474 2475 @property 2476 def sms_authentication(self): 2477 """Gets the sms_authentication of this Witness. # noqa: E501 2478 2479 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2480 2481 :return: The sms_authentication of this Witness. # noqa: E501 2482 :rtype: RecipientSMSAuthentication 2483 """ 2484 return self._sms_authentication 2485 2486 @sms_authentication.setter 2487 def sms_authentication(self, sms_authentication): 2488 """Sets the sms_authentication of this Witness. 2489 2490 When `idCheckConfigurationName` is set to `SMS Auth $`, you use this complex type to provide the recipient authentication method details. It contains the element `senderProvidedNumbers`, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501 2491 2492 :param sms_authentication: The sms_authentication of this Witness. # noqa: E501 2493 :type: RecipientSMSAuthentication 2494 """ 2495 2496 self._sms_authentication = sms_authentication 2497 2498 @property 2499 def social_authentications(self): 2500 """Gets the social_authentications of this Witness. # noqa: E501 2501 2502 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2503 2504 :return: The social_authentications of this Witness. # noqa: E501 2505 :rtype: list[SocialAuthentication] 2506 """ 2507 return self._social_authentications 2508 2509 @social_authentications.setter 2510 def social_authentications(self, social_authentications): 2511 """Sets the social_authentications of this Witness. 2512 2513 Lists the social ID type that can be used for recipient authentication. # noqa: E501 2514 2515 :param social_authentications: The social_authentications of this Witness. # noqa: E501 2516 :type: list[SocialAuthentication] 2517 """ 2518 2519 self._social_authentications = social_authentications 2520 2521 @property 2522 def status(self): 2523 """Gets the status of this Witness. # noqa: E501 2524 2525 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 2526 2527 :return: The status of this Witness. # noqa: E501 2528 :rtype: str 2529 """ 2530 return self._status 2531 2532 @status.setter 2533 def status(self, status): 2534 """Sets the status of this Witness. 2535 2536 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 2537 2538 :param status: The status of this Witness. # noqa: E501 2539 :type: str 2540 """ 2541 2542 self._status = status 2543 2544 @property 2545 def status_code(self): 2546 """Gets the status_code of this Witness. # noqa: E501 2547 2548 # noqa: E501 2549 2550 :return: The status_code of this Witness. # noqa: E501 2551 :rtype: str 2552 """ 2553 return self._status_code 2554 2555 @status_code.setter 2556 def status_code(self, status_code): 2557 """Sets the status_code of this Witness. 2558 2559 # noqa: E501 2560 2561 :param status_code: The status_code of this Witness. # noqa: E501 2562 :type: str 2563 """ 2564 2565 self._status_code = status_code 2566 2567 @property 2568 def suppress_emails(self): 2569 """Gets the suppress_emails of this Witness. # noqa: E501 2570 2571 # noqa: E501 2572 2573 :return: The suppress_emails of this Witness. # noqa: E501 2574 :rtype: str 2575 """ 2576 return self._suppress_emails 2577 2578 @suppress_emails.setter 2579 def suppress_emails(self, suppress_emails): 2580 """Sets the suppress_emails of this Witness. 2581 2582 # noqa: E501 2583 2584 :param suppress_emails: The suppress_emails of this Witness. # noqa: E501 2585 :type: str 2586 """ 2587 2588 self._suppress_emails = suppress_emails 2589 2590 @property 2591 def tabs(self): 2592 """Gets the tabs of this Witness. # noqa: E501 2593 2594 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2595 2596 :return: The tabs of this Witness. # noqa: E501 2597 :rtype: Tabs 2598 """ 2599 return self._tabs 2600 2601 @tabs.setter 2602 def tabs(self, tabs): 2603 """Sets the tabs of this Witness. 2604 2605 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501 2606 2607 :param tabs: The tabs of this Witness. # noqa: E501 2608 :type: Tabs 2609 """ 2610 2611 self._tabs = tabs 2612 2613 @property 2614 def template_locked(self): 2615 """Gets the template_locked of this Witness. # noqa: E501 2616 2617 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2618 2619 :return: The template_locked of this Witness. # noqa: E501 2620 :rtype: str 2621 """ 2622 return self._template_locked 2623 2624 @template_locked.setter 2625 def template_locked(self, template_locked): 2626 """Sets the template_locked of this Witness. 2627 2628 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2629 2630 :param template_locked: The template_locked of this Witness. # noqa: E501 2631 :type: str 2632 """ 2633 2634 self._template_locked = template_locked 2635 2636 @property 2637 def template_required(self): 2638 """Gets the template_required of this Witness. # noqa: E501 2639 2640 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2641 2642 :return: The template_required of this Witness. # noqa: E501 2643 :rtype: str 2644 """ 2645 return self._template_required 2646 2647 @template_required.setter 2648 def template_required(self, template_required): 2649 """Sets the template_required of this Witness. 2650 2651 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2652 2653 :param template_required: The template_required of this Witness. # noqa: E501 2654 :type: str 2655 """ 2656 2657 self._template_required = template_required 2658 2659 @property 2660 def total_tab_count(self): 2661 """Gets the total_tab_count of this Witness. # noqa: E501 2662 2663 # noqa: E501 2664 2665 :return: The total_tab_count of this Witness. # noqa: E501 2666 :rtype: str 2667 """ 2668 return self._total_tab_count 2669 2670 @total_tab_count.setter 2671 def total_tab_count(self, total_tab_count): 2672 """Sets the total_tab_count of this Witness. 2673 2674 # noqa: E501 2675 2676 :param total_tab_count: The total_tab_count of this Witness. # noqa: E501 2677 :type: str 2678 """ 2679 2680 self._total_tab_count = total_tab_count 2681 2682 @property 2683 def user_id(self): 2684 """Gets the user_id of this Witness. # noqa: E501 2685 2686 # noqa: E501 2687 2688 :return: The user_id of this Witness. # noqa: E501 2689 :rtype: str 2690 """ 2691 return self._user_id 2692 2693 @user_id.setter 2694 def user_id(self, user_id): 2695 """Sets the user_id of this Witness. 2696 2697 # noqa: E501 2698 2699 :param user_id: The user_id of this Witness. # noqa: E501 2700 :type: str 2701 """ 2702 2703 self._user_id = user_id 2704 2705 @property 2706 def witness_for(self): 2707 """Gets the witness_for of this Witness. # noqa: E501 2708 2709 # noqa: E501 2710 2711 :return: The witness_for of this Witness. # noqa: E501 2712 :rtype: str 2713 """ 2714 return self._witness_for 2715 2716 @witness_for.setter 2717 def witness_for(self, witness_for): 2718 """Sets the witness_for of this Witness. 2719 2720 # noqa: E501 2721 2722 :param witness_for: The witness_for of this Witness. # noqa: E501 2723 :type: str 2724 """ 2725 2726 self._witness_for = witness_for 2727 2728 @property 2729 def witness_for_guid(self): 2730 """Gets the witness_for_guid of this Witness. # noqa: E501 2731 2732 # noqa: E501 2733 2734 :return: The witness_for_guid of this Witness. # noqa: E501 2735 :rtype: str 2736 """ 2737 return self._witness_for_guid 2738 2739 @witness_for_guid.setter 2740 def witness_for_guid(self, witness_for_guid): 2741 """Sets the witness_for_guid of this Witness. 2742 2743 # noqa: E501 2744 2745 :param witness_for_guid: The witness_for_guid of this Witness. # noqa: E501 2746 :type: str 2747 """ 2748 2749 self._witness_for_guid = witness_for_guid 2750 2751 def to_dict(self): 2752 """Returns the model properties as a dict""" 2753 result = {} 2754 2755 for attr, _ in six.iteritems(self.swagger_types): 2756 value = getattr(self, attr) 2757 if isinstance(value, list): 2758 result[attr] = list(map( 2759 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2760 value 2761 )) 2762 elif hasattr(value, "to_dict"): 2763 result[attr] = value.to_dict() 2764 elif isinstance(value, dict): 2765 result[attr] = dict(map( 2766 lambda item: (item[0], item[1].to_dict()) 2767 if hasattr(item[1], "to_dict") else item, 2768 value.items() 2769 )) 2770 else: 2771 result[attr] = value 2772 if issubclass(Witness, dict): 2773 for key, value in self.items(): 2774 result[key] = value 2775 2776 return result 2777 2778 def to_str(self): 2779 """Returns the string representation of the model""" 2780 return pprint.pformat(self.to_dict()) 2781 2782 def __repr__(self): 2783 """For `print` and `pprint`""" 2784 return self.to_str() 2785 2786 def __eq__(self, other): 2787 """Returns true if both objects are equal""" 2788 if not isinstance(other, Witness): 2789 return False 2790 2791 return self.to_dict() == other.to_dict() 2792 2793 def __ne__(self, other): 2794 """Returns true if both objects are not equal""" 2795 if not isinstance(other, Witness): 2796 return True 2797 2798 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.
Witness(_configuration=None, **kwargs)
242 def __init__(self, _configuration=None, **kwargs): # noqa: E501 243 """Witness - a model defined in Swagger""" # noqa: E501 244 if _configuration is None: 245 _configuration = Configuration() 246 self._configuration = _configuration 247 248 self._access_code = None 249 self._access_code_metadata = None 250 self._add_access_code_to_email = None 251 self._additional_notifications = None 252 self._agent_can_edit_email = None 253 self._agent_can_edit_name = None 254 self._allow_system_override_for_locked_recipient = None 255 self._auto_navigation = None 256 self._auto_responded_reason = None 257 self._bulk_recipients_uri = None 258 self._bulk_send_v2_recipient = None 259 self._can_sign_offline = None 260 self._client_user_id = None 261 self._completed_count = None 262 self._consent_details_list = None 263 self._creation_reason = None 264 self._custom_fields = None 265 self._declined_date_time = None 266 self._declined_reason = None 267 self._default_recipient = None 268 self._delegated_by = None 269 self._delegated_to = None 270 self._delivered_date_time = None 271 self._delivery_method = None 272 self._delivery_method_metadata = None 273 self._designator_id = None 274 self._designator_id_guid = None 275 self._document_visibility = None 276 self._email = None 277 self._email_metadata = None 278 self._email_notification = None 279 self._email_recipient_post_signing_url = None 280 self._embedded_recipient_start_url = None 281 self._error_details = None 282 self._excluded_documents = None 283 self._fax_number = None 284 self._fax_number_metadata = None 285 self._first_name = None 286 self._first_name_metadata = None 287 self._full_name = None 288 self._full_name_metadata = None 289 self._id_check_configuration_name = None 290 self._id_check_configuration_name_metadata = None 291 self._id_check_information_input = None 292 self._identity_verification = None 293 self._inherit_email_notification_configuration = None 294 self._is_bulk_recipient = None 295 self._is_bulk_recipient_metadata = None 296 self._last_name = None 297 self._last_name_metadata = None 298 self._locked_recipient_phone_auth_editable = None 299 self._locked_recipient_sms_editable = None 300 self._name = None 301 self._name_metadata = None 302 self._notary_id = None 303 self._notary_signer_email_sent = None 304 self._note = None 305 self._note_metadata = None 306 self._offline_attributes = None 307 self._phone_authentication = None 308 self._phone_number = None 309 self._proof_file = None 310 self._recipient_attachments = None 311 self._recipient_authentication_status = None 312 self._recipient_feature_metadata = None 313 self._recipient_id = None 314 self._recipient_id_guid = None 315 self._recipient_signature_providers = None 316 self._recipient_supplies_tabs = None 317 self._recipient_type = None 318 self._recipient_type_metadata = None 319 self._require_id_lookup = None 320 self._require_id_lookup_metadata = None 321 self._require_signer_certificate = None 322 self._require_sign_on_paper = None 323 self._require_upload_signature = None 324 self._role_name = None 325 self._routing_order = None 326 self._routing_order_metadata = None 327 self._sent_date_time = None 328 self._signature_info = None 329 self._signed_date_time = None 330 self._sign_in_each_location = None 331 self._sign_in_each_location_metadata = None 332 self._signing_group_id = None 333 self._signing_group_id_metadata = None 334 self._signing_group_name = None 335 self._signing_group_users = None 336 self._sms_authentication = None 337 self._social_authentications = None 338 self._status = None 339 self._status_code = None 340 self._suppress_emails = None 341 self._tabs = None 342 self._template_locked = None 343 self._template_required = None 344 self._total_tab_count = None 345 self._user_id = None 346 self._witness_for = None 347 self._witness_for_guid = None 348 self.discriminator = None 349 350 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 351 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 352 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 353 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 354 setattr(self, "_{}".format('agent_can_edit_email'), kwargs.get('agent_can_edit_email', None)) 355 setattr(self, "_{}".format('agent_can_edit_name'), kwargs.get('agent_can_edit_name', None)) 356 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 357 setattr(self, "_{}".format('auto_navigation'), kwargs.get('auto_navigation', None)) 358 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 359 setattr(self, "_{}".format('bulk_recipients_uri'), kwargs.get('bulk_recipients_uri', None)) 360 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 361 setattr(self, "_{}".format('can_sign_offline'), kwargs.get('can_sign_offline', None)) 362 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 363 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 364 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 365 setattr(self, "_{}".format('creation_reason'), kwargs.get('creation_reason', None)) 366 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 367 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 368 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 369 setattr(self, "_{}".format('default_recipient'), kwargs.get('default_recipient', None)) 370 setattr(self, "_{}".format('delegated_by'), kwargs.get('delegated_by', None)) 371 setattr(self, "_{}".format('delegated_to'), kwargs.get('delegated_to', None)) 372 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 373 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 374 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 375 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 376 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 377 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 378 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 379 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 380 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 381 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 382 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 383 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 384 setattr(self, "_{}".format('excluded_documents'), kwargs.get('excluded_documents', None)) 385 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 386 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 387 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 388 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 389 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 390 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 391 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 392 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 393 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 394 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 395 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 396 setattr(self, "_{}".format('is_bulk_recipient'), kwargs.get('is_bulk_recipient', None)) 397 setattr(self, "_{}".format('is_bulk_recipient_metadata'), kwargs.get('is_bulk_recipient_metadata', None)) 398 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 399 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 400 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 401 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 402 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 403 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 404 setattr(self, "_{}".format('notary_id'), kwargs.get('notary_id', None)) 405 setattr(self, "_{}".format('notary_signer_email_sent'), kwargs.get('notary_signer_email_sent', None)) 406 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 407 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 408 setattr(self, "_{}".format('offline_attributes'), kwargs.get('offline_attributes', None)) 409 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 410 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 411 setattr(self, "_{}".format('proof_file'), kwargs.get('proof_file', None)) 412 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 413 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 414 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 415 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 416 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 417 setattr(self, "_{}".format('recipient_signature_providers'), kwargs.get('recipient_signature_providers', None)) 418 setattr(self, "_{}".format('recipient_supplies_tabs'), kwargs.get('recipient_supplies_tabs', None)) 419 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 420 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 421 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 422 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 423 setattr(self, "_{}".format('require_signer_certificate'), kwargs.get('require_signer_certificate', None)) 424 setattr(self, "_{}".format('require_sign_on_paper'), kwargs.get('require_sign_on_paper', None)) 425 setattr(self, "_{}".format('require_upload_signature'), kwargs.get('require_upload_signature', None)) 426 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 427 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 428 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 429 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 430 setattr(self, "_{}".format('signature_info'), kwargs.get('signature_info', None)) 431 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 432 setattr(self, "_{}".format('sign_in_each_location'), kwargs.get('sign_in_each_location', None)) 433 setattr(self, "_{}".format('sign_in_each_location_metadata'), kwargs.get('sign_in_each_location_metadata', None)) 434 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 435 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 436 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 437 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 438 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 439 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 440 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 441 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 442 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 443 setattr(self, "_{}".format('tabs'), kwargs.get('tabs', None)) 444 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 445 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 446 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 447 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 448 setattr(self, "_{}".format('witness_for'), kwargs.get('witness_for', None)) 449 setattr(self, "_{}".format('witness_for_guid'), kwargs.get('witness_for_guid', None))
Witness - a model defined in Swagger
swagger_types = {'access_code': 'str', 'access_code_metadata': 'PropertyMetadata', 'add_access_code_to_email': 'str', 'additional_notifications': 'list[RecipientAdditionalNotification]', 'agent_can_edit_email': 'str', 'agent_can_edit_name': 'str', 'allow_system_override_for_locked_recipient': 'str', 'auto_navigation': 'str', 'auto_responded_reason': 'str', 'bulk_recipients_uri': 'str', 'bulk_send_v2_recipient': 'str', 'can_sign_offline': 'str', 'client_user_id': 'str', 'completed_count': 'str', 'consent_details_list': 'list[ConsentDetails]', 'creation_reason': 'str', 'custom_fields': 'list[str]', 'declined_date_time': 'str', 'declined_reason': 'str', 'default_recipient': 'str', 'delegated_by': 'DelegationInfo', 'delegated_to': 'list[DelegationInfo]', 'delivered_date_time': 'str', 'delivery_method': 'str', 'delivery_method_metadata': 'PropertyMetadata', 'designator_id': 'str', 'designator_id_guid': 'str', 'document_visibility': 'list[DocumentVisibility]', 'email': 'str', 'email_metadata': 'PropertyMetadata', 'email_notification': 'RecipientEmailNotification', 'email_recipient_post_signing_url': 'str', 'embedded_recipient_start_url': 'str', 'error_details': 'ErrorDetails', 'excluded_documents': 'list[str]', 'fax_number': 'str', 'fax_number_metadata': 'PropertyMetadata', 'first_name': 'str', 'first_name_metadata': 'PropertyMetadata', 'full_name': 'str', 'full_name_metadata': 'PropertyMetadata', 'id_check_configuration_name': 'str', 'id_check_configuration_name_metadata': 'PropertyMetadata', 'id_check_information_input': 'IdCheckInformationInput', 'identity_verification': 'RecipientIdentityVerification', 'inherit_email_notification_configuration': 'str', 'is_bulk_recipient': 'str', 'is_bulk_recipient_metadata': 'PropertyMetadata', 'last_name': 'str', 'last_name_metadata': 'PropertyMetadata', 'locked_recipient_phone_auth_editable': 'str', 'locked_recipient_sms_editable': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', 'notary_id': 'str', 'notary_signer_email_sent': 'str', 'note': 'str', 'note_metadata': 'PropertyMetadata', 'offline_attributes': 'OfflineAttributes', 'phone_authentication': 'RecipientPhoneAuthentication', 'phone_number': 'RecipientPhoneNumber', 'proof_file': 'RecipientProofFile', 'recipient_attachments': 'list[RecipientAttachment]', 'recipient_authentication_status': 'AuthenticationStatus', 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 'recipient_id': 'str', 'recipient_id_guid': 'str', 'recipient_signature_providers': 'list[RecipientSignatureProvider]', 'recipient_supplies_tabs': 'str', 'recipient_type': 'str', 'recipient_type_metadata': 'PropertyMetadata', 'require_id_lookup': 'str', 'require_id_lookup_metadata': 'PropertyMetadata', 'require_signer_certificate': 'str', 'require_sign_on_paper': 'str', 'require_upload_signature': 'str', 'role_name': 'str', 'routing_order': 'str', 'routing_order_metadata': 'PropertyMetadata', 'sent_date_time': 'str', 'signature_info': 'RecipientSignatureInformation', 'signed_date_time': 'str', 'sign_in_each_location': 'str', 'sign_in_each_location_metadata': 'PropertyMetadata', 'signing_group_id': 'str', 'signing_group_id_metadata': 'PropertyMetadata', 'signing_group_name': 'str', 'signing_group_users': 'list[UserInfo]', 'sms_authentication': 'RecipientSMSAuthentication', 'social_authentications': 'list[SocialAuthentication]', 'status': 'str', 'status_code': 'str', 'suppress_emails': 'str', 'tabs': 'Tabs', 'template_locked': 'str', 'template_required': 'str', 'total_tab_count': 'str', 'user_id': 'str', 'witness_for': 'str', 'witness_for_guid': 'str'}
attribute_map = {'access_code': 'accessCode', 'access_code_metadata': 'accessCodeMetadata', 'add_access_code_to_email': 'addAccessCodeToEmail', 'additional_notifications': 'additionalNotifications', 'agent_can_edit_email': 'agentCanEditEmail', 'agent_can_edit_name': 'agentCanEditName', 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 'auto_navigation': 'autoNavigation', 'auto_responded_reason': 'autoRespondedReason', 'bulk_recipients_uri': 'bulkRecipientsUri', 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 'can_sign_offline': 'canSignOffline', 'client_user_id': 'clientUserId', 'completed_count': 'completedCount', 'consent_details_list': 'consentDetailsList', 'creation_reason': 'creationReason', 'custom_fields': 'customFields', 'declined_date_time': 'declinedDateTime', 'declined_reason': 'declinedReason', 'default_recipient': 'defaultRecipient', 'delegated_by': 'delegatedBy', 'delegated_to': 'delegatedTo', 'delivered_date_time': 'deliveredDateTime', 'delivery_method': 'deliveryMethod', 'delivery_method_metadata': 'deliveryMethodMetadata', 'designator_id': 'designatorId', 'designator_id_guid': 'designatorIdGuid', 'document_visibility': 'documentVisibility', 'email': 'email', 'email_metadata': 'emailMetadata', 'email_notification': 'emailNotification', 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 'error_details': 'errorDetails', 'excluded_documents': 'excludedDocuments', 'fax_number': 'faxNumber', 'fax_number_metadata': 'faxNumberMetadata', 'first_name': 'firstName', 'first_name_metadata': 'firstNameMetadata', 'full_name': 'fullName', 'full_name_metadata': 'fullNameMetadata', 'id_check_configuration_name': 'idCheckConfigurationName', 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 'id_check_information_input': 'idCheckInformationInput', 'identity_verification': 'identityVerification', 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 'is_bulk_recipient': 'isBulkRecipient', 'is_bulk_recipient_metadata': 'isBulkRecipientMetadata', 'last_name': 'lastName', 'last_name_metadata': 'lastNameMetadata', 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 'name': 'name', 'name_metadata': 'nameMetadata', 'notary_id': 'notaryId', 'notary_signer_email_sent': 'notarySignerEmailSent', 'note': 'note', 'note_metadata': 'noteMetadata', 'offline_attributes': 'offlineAttributes', 'phone_authentication': 'phoneAuthentication', 'phone_number': 'phoneNumber', 'proof_file': 'proofFile', 'recipient_attachments': 'recipientAttachments', 'recipient_authentication_status': 'recipientAuthenticationStatus', 'recipient_feature_metadata': 'recipientFeatureMetadata', 'recipient_id': 'recipientId', 'recipient_id_guid': 'recipientIdGuid', 'recipient_signature_providers': 'recipientSignatureProviders', 'recipient_supplies_tabs': 'recipientSuppliesTabs', 'recipient_type': 'recipientType', 'recipient_type_metadata': 'recipientTypeMetadata', 'require_id_lookup': 'requireIdLookup', 'require_id_lookup_metadata': 'requireIdLookupMetadata', 'require_signer_certificate': 'requireSignerCertificate', 'require_sign_on_paper': 'requireSignOnPaper', 'require_upload_signature': 'requireUploadSignature', 'role_name': 'roleName', 'routing_order': 'routingOrder', 'routing_order_metadata': 'routingOrderMetadata', 'sent_date_time': 'sentDateTime', 'signature_info': 'signatureInfo', 'signed_date_time': 'signedDateTime', 'sign_in_each_location': 'signInEachLocation', 'sign_in_each_location_metadata': 'signInEachLocationMetadata', 'signing_group_id': 'signingGroupId', 'signing_group_id_metadata': 'signingGroupIdMetadata', 'signing_group_name': 'signingGroupName', 'signing_group_users': 'signingGroupUsers', 'sms_authentication': 'smsAuthentication', 'social_authentications': 'socialAuthentications', 'status': 'status', 'status_code': 'statusCode', 'suppress_emails': 'suppressEmails', 'tabs': 'tabs', 'template_locked': 'templateLocked', 'template_required': 'templateRequired', 'total_tab_count': 'totalTabCount', 'user_id': 'userId', 'witness_for': 'witnessFor', 'witness_for_guid': 'witnessForGuid'}
access_code
Gets the access_code of this Witness. # noqa: E501
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account's access code format setting. If blank, but the signer accessCode property is set in the envelope, then that value is used. If blank and the signer accessCode property is not set, then the access code is not required. # noqa: E501
Returns
The access_code of this Witness. # noqa: E501
access_code_metadata
Gets the access_code_metadata of this Witness. # noqa: E501
Metadata that indicates whether the accessCode property is editable. This property is read-only. # noqa: E501
Returns
The access_code_metadata of this Witness. # noqa: E501
add_access_code_to_email
Gets the add_access_code_to_email of this Witness. # noqa: E501
This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient. # noqa: E501
Returns
The add_access_code_to_email of this Witness. # noqa: E501
additional_notifications
Gets the additional_notifications of this Witness. # noqa: E501
# noqa: E501
Returns
The additional_notifications of this Witness. # noqa: E501
agent_can_edit_email
Gets the agent_can_edit_email of this Witness. # noqa: E501
# noqa: E501
Returns
The agent_can_edit_email of this Witness. # noqa: E501
agent_can_edit_name
Gets the agent_can_edit_name of this Witness. # noqa: E501
# noqa: E501
Returns
The agent_can_edit_name of this Witness. # noqa: E501
allow_system_override_for_locked_recipient
Gets the allow_system_override_for_locked_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The allow_system_override_for_locked_recipient of this Witness. # noqa: E501
auto_responded_reason
Gets the auto_responded_reason of this Witness. # noqa: E501
# noqa: E501
Returns
The auto_responded_reason of this Witness. # noqa: E501
bulk_recipients_uri
Gets the bulk_recipients_uri of this Witness. # noqa: E501
Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information. # noqa: E501
Returns
The bulk_recipients_uri of this Witness. # noqa: E501
bulk_send_v2_recipient
Gets the bulk_send_v2_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The bulk_send_v2_recipient of this Witness. # noqa: E501
can_sign_offline
Gets the can_sign_offline of this Witness. # noqa: E501
When set to true, specifies that the signer can perform the signing ceremony offline. # noqa: E501
Returns
The can_sign_offline of this Witness. # noqa: E501
client_user_id
Gets the client_user_id of this Witness. # noqa: E501
Specifies whether the recipient is embedded or remote. If the clientUserId property is not null then the recipient is embedded. Note that if the ClientUserId property is set and either SignerMustHaveAccount or SignerMustLoginToSign property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters. # noqa: E501
Returns
The client_user_id of this Witness. # noqa: E501
completed_count
Gets the completed_count of this Witness. # noqa: E501
# noqa: E501
Returns
The completed_count of this Witness. # noqa: E501
consent_details_list
Gets the consent_details_list of this Witness. # noqa: E501
# noqa: E501
Returns
The consent_details_list of this Witness. # noqa: E501
creation_reason
Gets the creation_reason of this Witness. # noqa: E501
# noqa: E501
Returns
The creation_reason of this Witness. # noqa: E501
custom_fields
Gets the custom_fields of this Witness. # 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 Witness. # noqa: E501
declined_date_time
Gets the declined_date_time of this Witness. # noqa: E501
The date and time the recipient declined the document. # noqa: E501
Returns
The declined_date_time of this Witness. # noqa: E501
declined_reason
Gets the declined_reason of this Witness. # noqa: E501
The reason the recipient declined the document. # noqa: E501
Returns
The declined_reason of this Witness. # noqa: E501
default_recipient
Gets the default_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The default_recipient of this Witness. # noqa: E501
delegated_by
Gets the delegated_by of this Witness. # noqa: E501
# noqa: E501
Returns
The delegated_by of this Witness. # noqa: E501
delegated_to
Gets the delegated_to of this Witness. # noqa: E501
# noqa: E501
Returns
The delegated_to of this Witness. # noqa: E501
delivered_date_time
Gets the delivered_date_time of this Witness. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivered_date_time of this Witness. # noqa: E501
delivery_method
Gets the delivery_method of this Witness. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivery_method of this Witness. # noqa: E501
delivery_method_metadata
Gets the delivery_method_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The delivery_method_metadata of this Witness. # noqa: E501
designator_id
Gets the designator_id of this Witness. # noqa: E501
# noqa: E501
Returns
The designator_id of this Witness. # noqa: E501
designator_id_guid
Gets the designator_id_guid of this Witness. # noqa: E501
# noqa: E501
Returns
The designator_id_guid of this Witness. # noqa: E501
document_visibility
Gets the document_visibility of this Witness. # noqa: E501
# noqa: E501
Returns
The document_visibility of this Witness. # noqa: E501
email
Gets the email of this Witness. # noqa: E501
# noqa: E501
Returns
The email of this Witness. # noqa: E501
email_metadata
Gets the email_metadata of this Witness. # noqa: E501
Metadata that indicates whether the email property is editable. This property is read-only. # noqa: E501
Returns
The email_metadata of this Witness. # noqa: E501
email_notification
Gets the email_notification of this Witness. # noqa: E501
A complex type that contains information sets the language of the recipient's email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and EmailBlurb property settings. # noqa: E501
Returns
The email_notification of this Witness. # noqa: E501
email_recipient_post_signing_url
Gets the email_recipient_post_signing_url of this Witness. # noqa: E501
# noqa: E501
Returns
The email_recipient_post_signing_url of this Witness. # noqa: E501
embedded_recipient_start_url
Gets the embedded_recipient_start_url of this Witness. # noqa: E501
Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender's system (the server responding to the URL) must request a recipient token to launch a signing session. If set to SIGN_AT_DOCUSIGN, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient's identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the clientUserId property is NOT set, and the embeddedRecipientStartURL is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The customFields property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: http://senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[[mergeField3]] # noqa: E501
Returns
The embedded_recipient_start_url of this Witness. # noqa: E501
error_details
Gets the error_details of this Witness. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this Witness. # noqa: E501
excluded_documents
Gets the excluded_documents of this Witness. # noqa: E501
Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the enforceSignerVisibility property must be set to true for the envelope to use this. When enforce signer visibility is enabled, 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. # noqa: E501
Returns
The excluded_documents of this Witness. # noqa: E501
fax_number
Gets the fax_number of this Witness. # noqa: E501
Reserved: # noqa: E501
Returns
The fax_number of this Witness. # noqa: E501
fax_number_metadata
Gets the fax_number_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The fax_number_metadata of this Witness. # noqa: E501
first_name
Gets the first_name of this Witness. # noqa: E501
The user's first name. Maximum Length: 50 characters. # noqa: E501
Returns
The first_name of this Witness. # noqa: E501
first_name_metadata
Gets the first_name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the firstName property is editable. This property is read-only. # noqa: E501
Returns
The first_name_metadata of this Witness. # noqa: E501
full_name
Gets the full_name of this Witness. # noqa: E501
# noqa: E501
Returns
The full_name of this Witness. # noqa: E501
full_name_metadata
Gets the full_name_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The full_name_metadata of this Witness. # noqa: E501
id_check_configuration_name
Gets the id_check_configuration_name of this Witness. # noqa: E501
Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as 'ID Check $' and 'SMS Auth $'. To use ID check in an envelope, the idCheckConfigurationName should be 'ID Check '. If you wanted to use SMS, it would be 'SMS Auth $' and you would need to add you would need to add phone number information to the smsAuthentication node. # noqa: E501
Returns
The id_check_configuration_name of this Witness. # noqa: E501
id_check_configuration_name_metadata
Gets the id_check_configuration_name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the idCheckConfigurationName property is editable. This property is read-only. # noqa: E501
Returns
The id_check_configuration_name_metadata of this Witness. # noqa: E501
id_check_information_input
Gets the id_check_information_input of this Witness. # noqa: E501
An object that contains input information related to a recipient ID check. # noqa: E501
Returns
The id_check_information_input of this Witness. # noqa: E501
identity_verification
Gets the identity_verification of this Witness. # noqa: E501
Specifies the ID Verification workflow applied on an envelope by workflow ID.
See the list method in the IdentityVerifications resource for more information on how to retrieve workflow IDs available for an account.
This can be used in addition to other recipient authentication methods.
Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients' identity by verifying their ID while ID Check relies on data available on public records (such as current and former address). # noqa: E501
Returns
The identity_verification of this Witness. # noqa: E501
inherit_email_notification_configuration
Gets the inherit_email_notification_configuration of this Witness. # noqa: E501
When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient's account. # noqa: E501
Returns
The inherit_email_notification_configuration of this Witness. # noqa: E501
is_bulk_recipient
Gets the is_bulk_recipient of this Witness. # noqa: E501
# noqa: E501
Returns
The is_bulk_recipient of this Witness. # noqa: E501
is_bulk_recipient_metadata
Gets the is_bulk_recipient_metadata of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The is_bulk_recipient_metadata of this Witness. # noqa: E501
last_name
Gets the last_name of this Witness. # noqa: E501
# noqa: E501
Returns
The last_name of this Witness. # noqa: E501
last_name_metadata
Gets the last_name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the lastName property is editable. This property is read-only. # noqa: E501
Returns
The last_name_metadata of this Witness. # noqa: E501
locked_recipient_phone_auth_editable
Gets the locked_recipient_phone_auth_editable of this Witness. # noqa: E501
# noqa: E501
Returns
The locked_recipient_phone_auth_editable of this Witness. # noqa: E501
locked_recipient_sms_editable
Gets the locked_recipient_sms_editable of this Witness. # noqa: E501
# noqa: E501
Returns
The locked_recipient_sms_editable of this Witness. # noqa: E501
name
Gets the name of this Witness. # noqa: E501
# noqa: E501
Returns
The name of this Witness. # noqa: E501
name_metadata
Gets the name_metadata of this Witness. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this Witness. # noqa: E501
notary_id
Gets the notary_id of this Witness. # noqa: E501
# noqa: E501
Returns
The notary_id of this Witness. # noqa: E501
notary_signer_email_sent
Gets the notary_signer_email_sent of this Witness. # noqa: E501
# noqa: E501
Returns
The notary_signer_email_sent of this Witness. # noqa: E501
note
Gets the note of this Witness. # noqa: E501
Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters. # noqa: E501
Returns
The note of this Witness. # noqa: E501
note_metadata
Gets the note_metadata of this Witness. # noqa: E501
Metadata that indicates whether the note property is editable. This property is read-only. # noqa: E501
Returns
The note_metadata of this Witness. # noqa: E501
offline_attributes
Gets the offline_attributes of this Witness. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The offline_attributes of this Witness. # noqa: E501
phone_authentication
Gets the phone_authentication of this Witness. # noqa: E501
When idCheckConfigurationName is set to Phone Auth $, you use this complex type to provide the recipient authentication method details. It contains the following elements: * recipMayProvideNumber: Boolean. When true, the recipient can use whatever phone number they choose. * senderProvidedNumbers: ArrayOfStrings. A list of phone numbers the recipient can use. * recordVoicePrint: Reserved for DocuSign. * validateRecipProvidedNumber: Reserved for DocuSign. # noqa: E501
Returns
The phone_authentication of this Witness. # noqa: E501
phone_number
Gets the phone_number of this Witness. # noqa: E501
Describes the recipient phone number. # noqa: E501
Returns
The phone_number of this Witness. # noqa: E501
proof_file
Gets the proof_file of this Witness. # noqa: E501
The proof file of the recipient. # noqa: E501
Returns
The proof_file of this Witness. # noqa: E501
recipient_attachments
Gets the recipient_attachments of this Witness. # noqa: E501
Reserved: # noqa: E501
Returns
The recipient_attachments of this Witness. # noqa: E501
recipient_authentication_status
Gets the recipient_authentication_status of this Witness. # noqa: E501
Information about the recipient's authentication status. This property is read-only. # noqa: E501
Returns
The recipient_authentication_status of this Witness. # noqa: E501
recipient_feature_metadata
Gets the recipient_feature_metadata of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_feature_metadata of this Witness. # noqa: E501
recipient_id
Gets the recipient_id of this Witness. # noqa: E501
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
Returns
The recipient_id of this Witness. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this Witness. # noqa: E501
recipient_signature_providers
Gets the recipient_signature_providers of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_signature_providers of this Witness. # noqa: E501
recipient_supplies_tabs
Gets the recipient_supplies_tabs of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_supplies_tabs of this Witness. # noqa: E501
recipient_type
Gets the recipient_type of this Witness. # noqa: E501
# noqa: E501
Returns
The recipient_type of this Witness. # noqa: E501
recipient_type_metadata
Gets the recipient_type_metadata of this Witness. # noqa: E501
Metadata that indicates whether the recipientType property is editable. This property is read-only. # noqa: E501
Returns
The recipient_type_metadata of this Witness. # noqa: E501
require_id_lookup
Gets the require_id_lookup of this Witness. # noqa: E501
When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity. # noqa: E501
Returns
The require_id_lookup of this Witness. # noqa: E501
require_id_lookup_metadata
Gets the require_id_lookup_metadata of this Witness. # noqa: E501
Metadata that indicates whether the requireIdLookup property is editable. This property is read-only. # noqa: E501
Returns
The require_id_lookup_metadata of this Witness. # noqa: E501
require_signer_certificate
Gets the require_signer_certificate of this Witness. # noqa: E501
# noqa: E501
Returns
The require_signer_certificate of this Witness. # noqa: E501
require_sign_on_paper
Gets the require_sign_on_paper of this Witness. # noqa: E501
# noqa: E501
Returns
The require_sign_on_paper of this Witness. # noqa: E501
require_upload_signature
Gets the require_upload_signature of this Witness. # noqa: E501
# noqa: E501
Returns
The require_upload_signature of this Witness. # noqa: E501
role_name
Gets the role_name of this Witness. # noqa: E501
Optional element. Specifies the role name associated with the recipient.
This is required when working with template recipients. # noqa: E501
Returns
The role_name of this Witness. # noqa: E501
routing_order
Gets the routing_order of this Witness. # noqa: E501
Specifies the routing order of the recipient in the envelope. # noqa: E501
Returns
The routing_order of this Witness. # noqa: E501
routing_order_metadata
Gets the routing_order_metadata of this Witness. # noqa: E501
Metadata that indicates whether the routingOrder property is editable. This property is read-only. # noqa: E501
Returns
The routing_order_metadata of this Witness. # noqa: E501
sent_date_time
Gets the sent_date_time of this Witness. # noqa: E501
The date and time the envelope was sent. # noqa: E501
Returns
The sent_date_time of this Witness. # noqa: E501
signature_info
Gets the signature_info of this Witness. # noqa: E501
Allows the sender to pre-specify the signature name, signature initials and signature font used in the signature stamp for the recipient. Used only with recipient types In Person Signers and Signers. # noqa: E501
Returns
The signature_info of this Witness. # noqa: E501
signed_date_time
Gets the signed_date_time of this Witness. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The signed_date_time of this Witness. # noqa: E501
sign_in_each_location
Gets the sign_in_each_location of this Witness. # noqa: E501
When set to true, specifies that the signer must sign in all locations. # noqa: E501
Returns
The sign_in_each_location of this Witness. # noqa: E501
sign_in_each_location_metadata
Gets the sign_in_each_location_metadata of this Witness. # noqa: E501
Metadata that indicates whether the signInEachLocation property is editable. This property is read-only. # noqa: E501
Returns
The sign_in_each_location_metadata of this Witness. # noqa: E501
signing_group_id
Gets the signing_group_id of this Witness. # noqa: E501
When set to true and the feature is enabled in the sender's account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once). # noqa: E501
Returns
The signing_group_id of this Witness. # noqa: E501
signing_group_id_metadata
Gets the signing_group_id_metadata of this Witness. # noqa: E501
Metadata that indicates whether the signingGroupId property is editable. This property is read-only. # noqa: E501
Returns
The signing_group_id_metadata of this Witness. # noqa: E501
signing_group_name
Gets the signing_group_name of this Witness. # noqa: E501
The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
Returns
The signing_group_name of this Witness. # noqa: E501
signing_group_users
Gets the signing_group_users of this Witness. # noqa: E501
A complex type that contains information about users in the signing group. # noqa: E501
Returns
The signing_group_users of this Witness. # noqa: E501
sms_authentication
Gets the sms_authentication of this Witness. # noqa: E501
When idCheckConfigurationName is set to SMS Auth $, you use this complex type to provide the recipient authentication method details. It contains the element senderProvidedNumbers, which is an array of phone numbers that the recipient can use for SMS text authentication. # noqa: E501
Returns
The sms_authentication of this Witness. # noqa: E501
status
Gets the status of this Witness. # 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 Witness. # noqa: E501
status_code
Gets the status_code of this Witness. # noqa: E501
# noqa: E501
Returns
The status_code of this Witness. # noqa: E501
suppress_emails
Gets the suppress_emails of this Witness. # noqa: E501
# noqa: E501
Returns
The suppress_emails of this Witness. # noqa: E501
tabs
Gets the tabs of this Witness. # noqa: E501
A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. # noqa: E501
Returns
The tabs of this Witness. # noqa: E501
template_locked
Gets the template_locked of this Witness. # noqa: E501
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_locked of this Witness. # noqa: E501
template_required
Gets the template_required of this Witness. # noqa: E501
When set to true, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_required of this Witness. # noqa: E501
total_tab_count
Gets the total_tab_count of this Witness. # noqa: E501
# noqa: E501
Returns
The total_tab_count of this Witness. # noqa: E501
user_id
Gets the user_id of this Witness. # noqa: E501
# noqa: E501
Returns
The user_id of this Witness. # noqa: E501
witness_for
Gets the witness_for of this Witness. # noqa: E501
# noqa: E501
Returns
The witness_for of this Witness. # noqa: E501
witness_for_guid
Gets the witness_for_guid of this Witness. # noqa: E501
# noqa: E501
Returns
The witness_for_guid of this Witness. # noqa: E501
def
to_dict(self)
2751 def to_dict(self): 2752 """Returns the model properties as a dict""" 2753 result = {} 2754 2755 for attr, _ in six.iteritems(self.swagger_types): 2756 value = getattr(self, attr) 2757 if isinstance(value, list): 2758 result[attr] = list(map( 2759 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2760 value 2761 )) 2762 elif hasattr(value, "to_dict"): 2763 result[attr] = value.to_dict() 2764 elif isinstance(value, dict): 2765 result[attr] = dict(map( 2766 lambda item: (item[0], item[1].to_dict()) 2767 if hasattr(item[1], "to_dict") else item, 2768 value.items() 2769 )) 2770 else: 2771 result[attr] = value 2772 if issubclass(Witness, dict): 2773 for key, value in self.items(): 2774 result[key] = value 2775 2776 return result
Returns the model properties as a dict