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