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