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