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