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