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