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