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