docusign_esign.models.participant
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 Participant(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 'allow_system_override_for_locked_recipient': 'str', 41 'auto_responded_reason': 'str', 42 'bulk_send_v2_recipient': 'str', 43 'client_user_id': 'str', 44 'completed_count': 'str', 45 'consent_details_list': 'list[ConsentDetails]', 46 'custom_fields': 'list[str]', 47 'declined_date_time': 'str', 48 'declined_reason': 'str', 49 'delivered_date_time': 'str', 50 'delivery_method': 'str', 51 'delivery_method_metadata': 'PropertyMetadata', 52 'designator_id': 'str', 53 'designator_id_guid': 'str', 54 'document_visibility': 'list[DocumentVisibility]', 55 'email': 'str', 56 'email_metadata': 'PropertyMetadata', 57 'email_notification': 'RecipientEmailNotification', 58 'email_recipient_post_signing_url': 'str', 59 'embedded_recipient_start_url': 'str', 60 'error_details': 'ErrorDetails', 61 'fax_number': 'str', 62 'fax_number_metadata': 'PropertyMetadata', 63 'first_name': 'str', 64 'first_name_metadata': 'PropertyMetadata', 65 'full_name': 'str', 66 'full_name_metadata': 'PropertyMetadata', 67 'id_check_configuration_name': 'str', 68 'id_check_configuration_name_metadata': 'PropertyMetadata', 69 'id_check_information_input': 'IdCheckInformationInput', 70 'identity_verification': 'RecipientIdentityVerification', 71 'inherit_email_notification_configuration': 'str', 72 'last_name': 'str', 73 'last_name_metadata': 'PropertyMetadata', 74 'locked_recipient_phone_auth_editable': 'str', 75 'locked_recipient_sms_editable': 'str', 76 'name': 'str', 77 'name_metadata': 'PropertyMetadata', 78 'note': 'str', 79 'note_metadata': 'PropertyMetadata', 80 'participate_for': 'str', 81 'participate_for_guid': 'str', 82 'phone_authentication': 'RecipientPhoneAuthentication', 83 'phone_number': 'RecipientPhoneNumber', 84 'recipient_attachments': 'list[RecipientAttachment]', 85 'recipient_authentication_status': 'AuthenticationStatus', 86 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 87 'recipient_id': 'str', 88 'recipient_id_guid': 'str', 89 'recipient_type': 'str', 90 'recipient_type_metadata': 'PropertyMetadata', 91 'require_id_lookup': 'str', 92 'require_id_lookup_metadata': 'PropertyMetadata', 93 'role_name': 'str', 94 'routing_order': 'str', 95 'routing_order_metadata': 'PropertyMetadata', 96 'sent_date_time': 'str', 97 'signed_date_time': 'str', 98 'signing_group_id': 'str', 99 'signing_group_id_metadata': 'PropertyMetadata', 100 'signing_group_name': 'str', 101 'signing_group_users': 'list[UserInfo]', 102 'sms_authentication': 'RecipientSMSAuthentication', 103 'social_authentications': 'list[SocialAuthentication]', 104 'status': 'str', 105 'status_code': 'str', 106 'suppress_emails': 'str', 107 'template_locked': 'str', 108 'template_required': 'str', 109 'total_tab_count': 'str', 110 'user_id': 'str' 111 } 112 113 attribute_map = { 114 'access_code': 'accessCode', 115 'access_code_metadata': 'accessCodeMetadata', 116 'add_access_code_to_email': 'addAccessCodeToEmail', 117 'additional_notifications': 'additionalNotifications', 118 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 119 'auto_responded_reason': 'autoRespondedReason', 120 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 121 'client_user_id': 'clientUserId', 122 'completed_count': 'completedCount', 123 'consent_details_list': 'consentDetailsList', 124 'custom_fields': 'customFields', 125 'declined_date_time': 'declinedDateTime', 126 'declined_reason': 'declinedReason', 127 'delivered_date_time': 'deliveredDateTime', 128 'delivery_method': 'deliveryMethod', 129 'delivery_method_metadata': 'deliveryMethodMetadata', 130 'designator_id': 'designatorId', 131 'designator_id_guid': 'designatorIdGuid', 132 'document_visibility': 'documentVisibility', 133 'email': 'email', 134 'email_metadata': 'emailMetadata', 135 'email_notification': 'emailNotification', 136 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 137 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 138 'error_details': 'errorDetails', 139 'fax_number': 'faxNumber', 140 'fax_number_metadata': 'faxNumberMetadata', 141 'first_name': 'firstName', 142 'first_name_metadata': 'firstNameMetadata', 143 'full_name': 'fullName', 144 'full_name_metadata': 'fullNameMetadata', 145 'id_check_configuration_name': 'idCheckConfigurationName', 146 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 147 'id_check_information_input': 'idCheckInformationInput', 148 'identity_verification': 'identityVerification', 149 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 150 'last_name': 'lastName', 151 'last_name_metadata': 'lastNameMetadata', 152 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 153 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 154 'name': 'name', 155 'name_metadata': 'nameMetadata', 156 'note': 'note', 157 'note_metadata': 'noteMetadata', 158 'participate_for': 'participateFor', 159 'participate_for_guid': 'participateForGuid', 160 'phone_authentication': 'phoneAuthentication', 161 'phone_number': 'phoneNumber', 162 'recipient_attachments': 'recipientAttachments', 163 'recipient_authentication_status': 'recipientAuthenticationStatus', 164 'recipient_feature_metadata': 'recipientFeatureMetadata', 165 'recipient_id': 'recipientId', 166 'recipient_id_guid': 'recipientIdGuid', 167 'recipient_type': 'recipientType', 168 'recipient_type_metadata': 'recipientTypeMetadata', 169 'require_id_lookup': 'requireIdLookup', 170 'require_id_lookup_metadata': 'requireIdLookupMetadata', 171 'role_name': 'roleName', 172 'routing_order': 'routingOrder', 173 'routing_order_metadata': 'routingOrderMetadata', 174 'sent_date_time': 'sentDateTime', 175 'signed_date_time': 'signedDateTime', 176 'signing_group_id': 'signingGroupId', 177 'signing_group_id_metadata': 'signingGroupIdMetadata', 178 'signing_group_name': 'signingGroupName', 179 'signing_group_users': 'signingGroupUsers', 180 'sms_authentication': 'smsAuthentication', 181 'social_authentications': 'socialAuthentications', 182 'status': 'status', 183 'status_code': 'statusCode', 184 'suppress_emails': 'suppressEmails', 185 'template_locked': 'templateLocked', 186 'template_required': 'templateRequired', 187 'total_tab_count': 'totalTabCount', 188 'user_id': 'userId' 189 } 190 191 def __init__(self, _configuration=None, **kwargs): # noqa: E501 192 """Participant - a model defined in Swagger""" # noqa: E501 193 if _configuration is None: 194 _configuration = Configuration() 195 self._configuration = _configuration 196 197 self._access_code = None 198 self._access_code_metadata = None 199 self._add_access_code_to_email = None 200 self._additional_notifications = None 201 self._allow_system_override_for_locked_recipient = None 202 self._auto_responded_reason = None 203 self._bulk_send_v2_recipient = None 204 self._client_user_id = None 205 self._completed_count = None 206 self._consent_details_list = None 207 self._custom_fields = None 208 self._declined_date_time = None 209 self._declined_reason = None 210 self._delivered_date_time = None 211 self._delivery_method = None 212 self._delivery_method_metadata = None 213 self._designator_id = None 214 self._designator_id_guid = None 215 self._document_visibility = None 216 self._email = None 217 self._email_metadata = None 218 self._email_notification = None 219 self._email_recipient_post_signing_url = None 220 self._embedded_recipient_start_url = None 221 self._error_details = None 222 self._fax_number = None 223 self._fax_number_metadata = None 224 self._first_name = None 225 self._first_name_metadata = None 226 self._full_name = None 227 self._full_name_metadata = None 228 self._id_check_configuration_name = None 229 self._id_check_configuration_name_metadata = None 230 self._id_check_information_input = None 231 self._identity_verification = None 232 self._inherit_email_notification_configuration = None 233 self._last_name = None 234 self._last_name_metadata = None 235 self._locked_recipient_phone_auth_editable = None 236 self._locked_recipient_sms_editable = None 237 self._name = None 238 self._name_metadata = None 239 self._note = None 240 self._note_metadata = None 241 self._participate_for = None 242 self._participate_for_guid = None 243 self._phone_authentication = None 244 self._phone_number = None 245 self._recipient_attachments = None 246 self._recipient_authentication_status = None 247 self._recipient_feature_metadata = None 248 self._recipient_id = None 249 self._recipient_id_guid = None 250 self._recipient_type = None 251 self._recipient_type_metadata = None 252 self._require_id_lookup = None 253 self._require_id_lookup_metadata = None 254 self._role_name = None 255 self._routing_order = None 256 self._routing_order_metadata = None 257 self._sent_date_time = None 258 self._signed_date_time = None 259 self._signing_group_id = None 260 self._signing_group_id_metadata = None 261 self._signing_group_name = None 262 self._signing_group_users = None 263 self._sms_authentication = None 264 self._social_authentications = None 265 self._status = None 266 self._status_code = None 267 self._suppress_emails = None 268 self._template_locked = None 269 self._template_required = None 270 self._total_tab_count = None 271 self._user_id = None 272 self.discriminator = None 273 274 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 275 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 276 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 277 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 278 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 279 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 280 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 281 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 282 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 283 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 284 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 285 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 286 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 287 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 288 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 289 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 290 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 291 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 292 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 293 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 294 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 295 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 296 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 297 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 298 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 299 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 300 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 301 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 302 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 303 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 304 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 305 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 306 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 307 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 308 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 309 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 310 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 311 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 312 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 313 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 314 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 315 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 316 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 317 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 318 setattr(self, "_{}".format('participate_for'), kwargs.get('participate_for', None)) 319 setattr(self, "_{}".format('participate_for_guid'), kwargs.get('participate_for_guid', None)) 320 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 321 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 322 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 323 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 324 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 325 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 326 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 327 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 328 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 329 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 330 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 331 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 332 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 333 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 334 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 335 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 336 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 337 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 338 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 339 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 340 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 341 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 342 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 343 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 344 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 345 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 346 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 347 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 348 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 349 350 @property 351 def access_code(self): 352 """Gets the access_code of this Participant. # noqa: E501 353 354 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 355 356 :return: The access_code of this Participant. # noqa: E501 357 :rtype: str 358 """ 359 return self._access_code 360 361 @access_code.setter 362 def access_code(self, access_code): 363 """Sets the access_code of this Participant. 364 365 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 366 367 :param access_code: The access_code of this Participant. # noqa: E501 368 :type: str 369 """ 370 371 self._access_code = access_code 372 373 @property 374 def access_code_metadata(self): 375 """Gets the access_code_metadata of this Participant. # noqa: E501 376 377 # noqa: E501 378 379 :return: The access_code_metadata of this Participant. # noqa: E501 380 :rtype: PropertyMetadata 381 """ 382 return self._access_code_metadata 383 384 @access_code_metadata.setter 385 def access_code_metadata(self, access_code_metadata): 386 """Sets the access_code_metadata of this Participant. 387 388 # noqa: E501 389 390 :param access_code_metadata: The access_code_metadata of this Participant. # noqa: E501 391 :type: PropertyMetadata 392 """ 393 394 self._access_code_metadata = access_code_metadata 395 396 @property 397 def add_access_code_to_email(self): 398 """Gets the add_access_code_to_email of this Participant. # noqa: E501 399 400 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 401 402 :return: The add_access_code_to_email of this Participant. # noqa: E501 403 :rtype: str 404 """ 405 return self._add_access_code_to_email 406 407 @add_access_code_to_email.setter 408 def add_access_code_to_email(self, add_access_code_to_email): 409 """Sets the add_access_code_to_email of this Participant. 410 411 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 412 413 :param add_access_code_to_email: The add_access_code_to_email of this Participant. # noqa: E501 414 :type: str 415 """ 416 417 self._add_access_code_to_email = add_access_code_to_email 418 419 @property 420 def additional_notifications(self): 421 """Gets the additional_notifications of this Participant. # noqa: E501 422 423 # noqa: E501 424 425 :return: The additional_notifications of this Participant. # noqa: E501 426 :rtype: list[RecipientAdditionalNotification] 427 """ 428 return self._additional_notifications 429 430 @additional_notifications.setter 431 def additional_notifications(self, additional_notifications): 432 """Sets the additional_notifications of this Participant. 433 434 # noqa: E501 435 436 :param additional_notifications: The additional_notifications of this Participant. # noqa: E501 437 :type: list[RecipientAdditionalNotification] 438 """ 439 440 self._additional_notifications = additional_notifications 441 442 @property 443 def allow_system_override_for_locked_recipient(self): 444 """Gets the allow_system_override_for_locked_recipient of this Participant. # noqa: E501 445 446 # noqa: E501 447 448 :return: The allow_system_override_for_locked_recipient of this Participant. # noqa: E501 449 :rtype: str 450 """ 451 return self._allow_system_override_for_locked_recipient 452 453 @allow_system_override_for_locked_recipient.setter 454 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 455 """Sets the allow_system_override_for_locked_recipient of this Participant. 456 457 # noqa: E501 458 459 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this Participant. # noqa: E501 460 :type: str 461 """ 462 463 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 464 465 @property 466 def auto_responded_reason(self): 467 """Gets the auto_responded_reason of this Participant. # noqa: E501 468 469 # noqa: E501 470 471 :return: The auto_responded_reason of this Participant. # noqa: E501 472 :rtype: str 473 """ 474 return self._auto_responded_reason 475 476 @auto_responded_reason.setter 477 def auto_responded_reason(self, auto_responded_reason): 478 """Sets the auto_responded_reason of this Participant. 479 480 # noqa: E501 481 482 :param auto_responded_reason: The auto_responded_reason of this Participant. # noqa: E501 483 :type: str 484 """ 485 486 self._auto_responded_reason = auto_responded_reason 487 488 @property 489 def bulk_send_v2_recipient(self): 490 """Gets the bulk_send_v2_recipient of this Participant. # noqa: E501 491 492 # noqa: E501 493 494 :return: The bulk_send_v2_recipient of this Participant. # noqa: E501 495 :rtype: str 496 """ 497 return self._bulk_send_v2_recipient 498 499 @bulk_send_v2_recipient.setter 500 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 501 """Sets the bulk_send_v2_recipient of this Participant. 502 503 # noqa: E501 504 505 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this Participant. # noqa: E501 506 :type: str 507 """ 508 509 self._bulk_send_v2_recipient = bulk_send_v2_recipient 510 511 @property 512 def client_user_id(self): 513 """Gets the client_user_id of this Participant. # noqa: E501 514 515 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 516 517 :return: The client_user_id of this Participant. # noqa: E501 518 :rtype: str 519 """ 520 return self._client_user_id 521 522 @client_user_id.setter 523 def client_user_id(self, client_user_id): 524 """Sets the client_user_id of this Participant. 525 526 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 527 528 :param client_user_id: The client_user_id of this Participant. # noqa: E501 529 :type: str 530 """ 531 532 self._client_user_id = client_user_id 533 534 @property 535 def completed_count(self): 536 """Gets the completed_count of this Participant. # noqa: E501 537 538 # noqa: E501 539 540 :return: The completed_count of this Participant. # noqa: E501 541 :rtype: str 542 """ 543 return self._completed_count 544 545 @completed_count.setter 546 def completed_count(self, completed_count): 547 """Sets the completed_count of this Participant. 548 549 # noqa: E501 550 551 :param completed_count: The completed_count of this Participant. # noqa: E501 552 :type: str 553 """ 554 555 self._completed_count = completed_count 556 557 @property 558 def consent_details_list(self): 559 """Gets the consent_details_list of this Participant. # noqa: E501 560 561 # noqa: E501 562 563 :return: The consent_details_list of this Participant. # noqa: E501 564 :rtype: list[ConsentDetails] 565 """ 566 return self._consent_details_list 567 568 @consent_details_list.setter 569 def consent_details_list(self, consent_details_list): 570 """Sets the consent_details_list of this Participant. 571 572 # noqa: E501 573 574 :param consent_details_list: The consent_details_list of this Participant. # noqa: E501 575 :type: list[ConsentDetails] 576 """ 577 578 self._consent_details_list = consent_details_list 579 580 @property 581 def custom_fields(self): 582 """Gets the custom_fields of this Participant. # noqa: E501 583 584 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 585 586 :return: The custom_fields of this Participant. # noqa: E501 587 :rtype: list[str] 588 """ 589 return self._custom_fields 590 591 @custom_fields.setter 592 def custom_fields(self, custom_fields): 593 """Sets the custom_fields of this Participant. 594 595 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 596 597 :param custom_fields: The custom_fields of this Participant. # noqa: E501 598 :type: list[str] 599 """ 600 601 self._custom_fields = custom_fields 602 603 @property 604 def declined_date_time(self): 605 """Gets the declined_date_time of this Participant. # noqa: E501 606 607 The date and time the recipient declined the document. # noqa: E501 608 609 :return: The declined_date_time of this Participant. # noqa: E501 610 :rtype: str 611 """ 612 return self._declined_date_time 613 614 @declined_date_time.setter 615 def declined_date_time(self, declined_date_time): 616 """Sets the declined_date_time of this Participant. 617 618 The date and time the recipient declined the document. # noqa: E501 619 620 :param declined_date_time: The declined_date_time of this Participant. # noqa: E501 621 :type: str 622 """ 623 624 self._declined_date_time = declined_date_time 625 626 @property 627 def declined_reason(self): 628 """Gets the declined_reason of this Participant. # noqa: E501 629 630 The reason the recipient declined the document. # noqa: E501 631 632 :return: The declined_reason of this Participant. # noqa: E501 633 :rtype: str 634 """ 635 return self._declined_reason 636 637 @declined_reason.setter 638 def declined_reason(self, declined_reason): 639 """Sets the declined_reason of this Participant. 640 641 The reason the recipient declined the document. # noqa: E501 642 643 :param declined_reason: The declined_reason of this Participant. # noqa: E501 644 :type: str 645 """ 646 647 self._declined_reason = declined_reason 648 649 @property 650 def delivered_date_time(self): 651 """Gets the delivered_date_time of this Participant. # noqa: E501 652 653 Reserved: For DocuSign use only. # noqa: E501 654 655 :return: The delivered_date_time of this Participant. # noqa: E501 656 :rtype: str 657 """ 658 return self._delivered_date_time 659 660 @delivered_date_time.setter 661 def delivered_date_time(self, delivered_date_time): 662 """Sets the delivered_date_time of this Participant. 663 664 Reserved: For DocuSign use only. # noqa: E501 665 666 :param delivered_date_time: The delivered_date_time of this Participant. # noqa: E501 667 :type: str 668 """ 669 670 self._delivered_date_time = delivered_date_time 671 672 @property 673 def delivery_method(self): 674 """Gets the delivery_method of this Participant. # noqa: E501 675 676 Reserved: For DocuSign use only. # noqa: E501 677 678 :return: The delivery_method of this Participant. # noqa: E501 679 :rtype: str 680 """ 681 return self._delivery_method 682 683 @delivery_method.setter 684 def delivery_method(self, delivery_method): 685 """Sets the delivery_method of this Participant. 686 687 Reserved: For DocuSign use only. # noqa: E501 688 689 :param delivery_method: The delivery_method of this Participant. # noqa: E501 690 :type: str 691 """ 692 693 self._delivery_method = delivery_method 694 695 @property 696 def delivery_method_metadata(self): 697 """Gets the delivery_method_metadata of this Participant. # noqa: E501 698 699 # noqa: E501 700 701 :return: The delivery_method_metadata of this Participant. # noqa: E501 702 :rtype: PropertyMetadata 703 """ 704 return self._delivery_method_metadata 705 706 @delivery_method_metadata.setter 707 def delivery_method_metadata(self, delivery_method_metadata): 708 """Sets the delivery_method_metadata of this Participant. 709 710 # noqa: E501 711 712 :param delivery_method_metadata: The delivery_method_metadata of this Participant. # noqa: E501 713 :type: PropertyMetadata 714 """ 715 716 self._delivery_method_metadata = delivery_method_metadata 717 718 @property 719 def designator_id(self): 720 """Gets the designator_id of this Participant. # noqa: E501 721 722 # noqa: E501 723 724 :return: The designator_id of this Participant. # noqa: E501 725 :rtype: str 726 """ 727 return self._designator_id 728 729 @designator_id.setter 730 def designator_id(self, designator_id): 731 """Sets the designator_id of this Participant. 732 733 # noqa: E501 734 735 :param designator_id: The designator_id of this Participant. # noqa: E501 736 :type: str 737 """ 738 739 self._designator_id = designator_id 740 741 @property 742 def designator_id_guid(self): 743 """Gets the designator_id_guid of this Participant. # noqa: E501 744 745 # noqa: E501 746 747 :return: The designator_id_guid of this Participant. # noqa: E501 748 :rtype: str 749 """ 750 return self._designator_id_guid 751 752 @designator_id_guid.setter 753 def designator_id_guid(self, designator_id_guid): 754 """Sets the designator_id_guid of this Participant. 755 756 # noqa: E501 757 758 :param designator_id_guid: The designator_id_guid of this Participant. # noqa: E501 759 :type: str 760 """ 761 762 self._designator_id_guid = designator_id_guid 763 764 @property 765 def document_visibility(self): 766 """Gets the document_visibility of this Participant. # noqa: E501 767 768 # noqa: E501 769 770 :return: The document_visibility of this Participant. # noqa: E501 771 :rtype: list[DocumentVisibility] 772 """ 773 return self._document_visibility 774 775 @document_visibility.setter 776 def document_visibility(self, document_visibility): 777 """Sets the document_visibility of this Participant. 778 779 # noqa: E501 780 781 :param document_visibility: The document_visibility of this Participant. # noqa: E501 782 :type: list[DocumentVisibility] 783 """ 784 785 self._document_visibility = document_visibility 786 787 @property 788 def email(self): 789 """Gets the email of this Participant. # noqa: E501 790 791 # noqa: E501 792 793 :return: The email of this Participant. # noqa: E501 794 :rtype: str 795 """ 796 return self._email 797 798 @email.setter 799 def email(self, email): 800 """Sets the email of this Participant. 801 802 # noqa: E501 803 804 :param email: The email of this Participant. # noqa: E501 805 :type: str 806 """ 807 808 self._email = email 809 810 @property 811 def email_metadata(self): 812 """Gets the email_metadata of this Participant. # noqa: E501 813 814 # noqa: E501 815 816 :return: The email_metadata of this Participant. # noqa: E501 817 :rtype: PropertyMetadata 818 """ 819 return self._email_metadata 820 821 @email_metadata.setter 822 def email_metadata(self, email_metadata): 823 """Sets the email_metadata of this Participant. 824 825 # noqa: E501 826 827 :param email_metadata: The email_metadata of this Participant. # noqa: E501 828 :type: PropertyMetadata 829 """ 830 831 self._email_metadata = email_metadata 832 833 @property 834 def email_notification(self): 835 """Gets the email_notification of this Participant. # noqa: E501 836 837 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 838 839 :return: The email_notification of this Participant. # noqa: E501 840 :rtype: RecipientEmailNotification 841 """ 842 return self._email_notification 843 844 @email_notification.setter 845 def email_notification(self, email_notification): 846 """Sets the email_notification of this Participant. 847 848 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 849 850 :param email_notification: The email_notification of this Participant. # noqa: E501 851 :type: RecipientEmailNotification 852 """ 853 854 self._email_notification = email_notification 855 856 @property 857 def email_recipient_post_signing_url(self): 858 """Gets the email_recipient_post_signing_url of this Participant. # noqa: E501 859 860 # noqa: E501 861 862 :return: The email_recipient_post_signing_url of this Participant. # noqa: E501 863 :rtype: str 864 """ 865 return self._email_recipient_post_signing_url 866 867 @email_recipient_post_signing_url.setter 868 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 869 """Sets the email_recipient_post_signing_url of this Participant. 870 871 # noqa: E501 872 873 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Participant. # noqa: E501 874 :type: str 875 """ 876 877 self._email_recipient_post_signing_url = email_recipient_post_signing_url 878 879 @property 880 def embedded_recipient_start_url(self): 881 """Gets the embedded_recipient_start_url of this Participant. # noqa: E501 882 883 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 884 885 :return: The embedded_recipient_start_url of this Participant. # noqa: E501 886 :rtype: str 887 """ 888 return self._embedded_recipient_start_url 889 890 @embedded_recipient_start_url.setter 891 def embedded_recipient_start_url(self, embedded_recipient_start_url): 892 """Sets the embedded_recipient_start_url of this Participant. 893 894 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 895 896 :param embedded_recipient_start_url: The embedded_recipient_start_url of this Participant. # noqa: E501 897 :type: str 898 """ 899 900 self._embedded_recipient_start_url = embedded_recipient_start_url 901 902 @property 903 def error_details(self): 904 """Gets the error_details of this Participant. # noqa: E501 905 906 Array or errors. # noqa: E501 907 908 :return: The error_details of this Participant. # noqa: E501 909 :rtype: ErrorDetails 910 """ 911 return self._error_details 912 913 @error_details.setter 914 def error_details(self, error_details): 915 """Sets the error_details of this Participant. 916 917 Array or errors. # noqa: E501 918 919 :param error_details: The error_details of this Participant. # noqa: E501 920 :type: ErrorDetails 921 """ 922 923 self._error_details = error_details 924 925 @property 926 def fax_number(self): 927 """Gets the fax_number of this Participant. # noqa: E501 928 929 Reserved: # noqa: E501 930 931 :return: The fax_number of this Participant. # noqa: E501 932 :rtype: str 933 """ 934 return self._fax_number 935 936 @fax_number.setter 937 def fax_number(self, fax_number): 938 """Sets the fax_number of this Participant. 939 940 Reserved: # noqa: E501 941 942 :param fax_number: The fax_number of this Participant. # noqa: E501 943 :type: str 944 """ 945 946 self._fax_number = fax_number 947 948 @property 949 def fax_number_metadata(self): 950 """Gets the fax_number_metadata of this Participant. # noqa: E501 951 952 # noqa: E501 953 954 :return: The fax_number_metadata of this Participant. # noqa: E501 955 :rtype: PropertyMetadata 956 """ 957 return self._fax_number_metadata 958 959 @fax_number_metadata.setter 960 def fax_number_metadata(self, fax_number_metadata): 961 """Sets the fax_number_metadata of this Participant. 962 963 # noqa: E501 964 965 :param fax_number_metadata: The fax_number_metadata of this Participant. # noqa: E501 966 :type: PropertyMetadata 967 """ 968 969 self._fax_number_metadata = fax_number_metadata 970 971 @property 972 def first_name(self): 973 """Gets the first_name of this Participant. # noqa: E501 974 975 The user's first name. Maximum Length: 50 characters. # noqa: E501 976 977 :return: The first_name of this Participant. # noqa: E501 978 :rtype: str 979 """ 980 return self._first_name 981 982 @first_name.setter 983 def first_name(self, first_name): 984 """Sets the first_name of this Participant. 985 986 The user's first name. Maximum Length: 50 characters. # noqa: E501 987 988 :param first_name: The first_name of this Participant. # noqa: E501 989 :type: str 990 """ 991 992 self._first_name = first_name 993 994 @property 995 def first_name_metadata(self): 996 """Gets the first_name_metadata of this Participant. # noqa: E501 997 998 # noqa: E501 999 1000 :return: The first_name_metadata of this Participant. # noqa: E501 1001 :rtype: PropertyMetadata 1002 """ 1003 return self._first_name_metadata 1004 1005 @first_name_metadata.setter 1006 def first_name_metadata(self, first_name_metadata): 1007 """Sets the first_name_metadata of this Participant. 1008 1009 # noqa: E501 1010 1011 :param first_name_metadata: The first_name_metadata of this Participant. # noqa: E501 1012 :type: PropertyMetadata 1013 """ 1014 1015 self._first_name_metadata = first_name_metadata 1016 1017 @property 1018 def full_name(self): 1019 """Gets the full_name of this Participant. # noqa: E501 1020 1021 # noqa: E501 1022 1023 :return: The full_name of this Participant. # noqa: E501 1024 :rtype: str 1025 """ 1026 return self._full_name 1027 1028 @full_name.setter 1029 def full_name(self, full_name): 1030 """Sets the full_name of this Participant. 1031 1032 # noqa: E501 1033 1034 :param full_name: The full_name of this Participant. # noqa: E501 1035 :type: str 1036 """ 1037 1038 self._full_name = full_name 1039 1040 @property 1041 def full_name_metadata(self): 1042 """Gets the full_name_metadata of this Participant. # noqa: E501 1043 1044 # noqa: E501 1045 1046 :return: The full_name_metadata of this Participant. # noqa: E501 1047 :rtype: PropertyMetadata 1048 """ 1049 return self._full_name_metadata 1050 1051 @full_name_metadata.setter 1052 def full_name_metadata(self, full_name_metadata): 1053 """Sets the full_name_metadata of this Participant. 1054 1055 # noqa: E501 1056 1057 :param full_name_metadata: The full_name_metadata of this Participant. # noqa: E501 1058 :type: PropertyMetadata 1059 """ 1060 1061 self._full_name_metadata = full_name_metadata 1062 1063 @property 1064 def id_check_configuration_name(self): 1065 """Gets the id_check_configuration_name of this Participant. # noqa: E501 1066 1067 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 1068 1069 :return: The id_check_configuration_name of this Participant. # noqa: E501 1070 :rtype: str 1071 """ 1072 return self._id_check_configuration_name 1073 1074 @id_check_configuration_name.setter 1075 def id_check_configuration_name(self, id_check_configuration_name): 1076 """Sets the id_check_configuration_name of this Participant. 1077 1078 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 1079 1080 :param id_check_configuration_name: The id_check_configuration_name of this Participant. # noqa: E501 1081 :type: str 1082 """ 1083 1084 self._id_check_configuration_name = id_check_configuration_name 1085 1086 @property 1087 def id_check_configuration_name_metadata(self): 1088 """Gets the id_check_configuration_name_metadata of this Participant. # noqa: E501 1089 1090 # noqa: E501 1091 1092 :return: The id_check_configuration_name_metadata of this Participant. # noqa: E501 1093 :rtype: PropertyMetadata 1094 """ 1095 return self._id_check_configuration_name_metadata 1096 1097 @id_check_configuration_name_metadata.setter 1098 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1099 """Sets the id_check_configuration_name_metadata of this Participant. 1100 1101 # noqa: E501 1102 1103 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this Participant. # noqa: E501 1104 :type: PropertyMetadata 1105 """ 1106 1107 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1108 1109 @property 1110 def id_check_information_input(self): 1111 """Gets the id_check_information_input of this Participant. # noqa: E501 1112 1113 # noqa: E501 1114 1115 :return: The id_check_information_input of this Participant. # noqa: E501 1116 :rtype: IdCheckInformationInput 1117 """ 1118 return self._id_check_information_input 1119 1120 @id_check_information_input.setter 1121 def id_check_information_input(self, id_check_information_input): 1122 """Sets the id_check_information_input of this Participant. 1123 1124 # noqa: E501 1125 1126 :param id_check_information_input: The id_check_information_input of this Participant. # noqa: E501 1127 :type: IdCheckInformationInput 1128 """ 1129 1130 self._id_check_information_input = id_check_information_input 1131 1132 @property 1133 def identity_verification(self): 1134 """Gets the identity_verification of this Participant. # noqa: E501 1135 1136 # noqa: E501 1137 1138 :return: The identity_verification of this Participant. # noqa: E501 1139 :rtype: RecipientIdentityVerification 1140 """ 1141 return self._identity_verification 1142 1143 @identity_verification.setter 1144 def identity_verification(self, identity_verification): 1145 """Sets the identity_verification of this Participant. 1146 1147 # noqa: E501 1148 1149 :param identity_verification: The identity_verification of this Participant. # noqa: E501 1150 :type: RecipientIdentityVerification 1151 """ 1152 1153 self._identity_verification = identity_verification 1154 1155 @property 1156 def inherit_email_notification_configuration(self): 1157 """Gets the inherit_email_notification_configuration of this Participant. # noqa: E501 1158 1159 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 1160 1161 :return: The inherit_email_notification_configuration of this Participant. # noqa: E501 1162 :rtype: str 1163 """ 1164 return self._inherit_email_notification_configuration 1165 1166 @inherit_email_notification_configuration.setter 1167 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1168 """Sets the inherit_email_notification_configuration of this Participant. 1169 1170 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 1171 1172 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this Participant. # noqa: E501 1173 :type: str 1174 """ 1175 1176 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1177 1178 @property 1179 def last_name(self): 1180 """Gets the last_name of this Participant. # noqa: E501 1181 1182 # noqa: E501 1183 1184 :return: The last_name of this Participant. # noqa: E501 1185 :rtype: str 1186 """ 1187 return self._last_name 1188 1189 @last_name.setter 1190 def last_name(self, last_name): 1191 """Sets the last_name of this Participant. 1192 1193 # noqa: E501 1194 1195 :param last_name: The last_name of this Participant. # noqa: E501 1196 :type: str 1197 """ 1198 1199 self._last_name = last_name 1200 1201 @property 1202 def last_name_metadata(self): 1203 """Gets the last_name_metadata of this Participant. # noqa: E501 1204 1205 # noqa: E501 1206 1207 :return: The last_name_metadata of this Participant. # noqa: E501 1208 :rtype: PropertyMetadata 1209 """ 1210 return self._last_name_metadata 1211 1212 @last_name_metadata.setter 1213 def last_name_metadata(self, last_name_metadata): 1214 """Sets the last_name_metadata of this Participant. 1215 1216 # noqa: E501 1217 1218 :param last_name_metadata: The last_name_metadata of this Participant. # noqa: E501 1219 :type: PropertyMetadata 1220 """ 1221 1222 self._last_name_metadata = last_name_metadata 1223 1224 @property 1225 def locked_recipient_phone_auth_editable(self): 1226 """Gets the locked_recipient_phone_auth_editable of this Participant. # noqa: E501 1227 1228 # noqa: E501 1229 1230 :return: The locked_recipient_phone_auth_editable of this Participant. # noqa: E501 1231 :rtype: str 1232 """ 1233 return self._locked_recipient_phone_auth_editable 1234 1235 @locked_recipient_phone_auth_editable.setter 1236 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1237 """Sets the locked_recipient_phone_auth_editable of this Participant. 1238 1239 # noqa: E501 1240 1241 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this Participant. # noqa: E501 1242 :type: str 1243 """ 1244 1245 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1246 1247 @property 1248 def locked_recipient_sms_editable(self): 1249 """Gets the locked_recipient_sms_editable of this Participant. # noqa: E501 1250 1251 # noqa: E501 1252 1253 :return: The locked_recipient_sms_editable of this Participant. # noqa: E501 1254 :rtype: str 1255 """ 1256 return self._locked_recipient_sms_editable 1257 1258 @locked_recipient_sms_editable.setter 1259 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1260 """Sets the locked_recipient_sms_editable of this Participant. 1261 1262 # noqa: E501 1263 1264 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this Participant. # noqa: E501 1265 :type: str 1266 """ 1267 1268 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1269 1270 @property 1271 def name(self): 1272 """Gets the name of this Participant. # noqa: E501 1273 1274 # noqa: E501 1275 1276 :return: The name of this Participant. # noqa: E501 1277 :rtype: str 1278 """ 1279 return self._name 1280 1281 @name.setter 1282 def name(self, name): 1283 """Sets the name of this Participant. 1284 1285 # noqa: E501 1286 1287 :param name: The name of this Participant. # noqa: E501 1288 :type: str 1289 """ 1290 1291 self._name = name 1292 1293 @property 1294 def name_metadata(self): 1295 """Gets the name_metadata of this Participant. # noqa: E501 1296 1297 # noqa: E501 1298 1299 :return: The name_metadata of this Participant. # noqa: E501 1300 :rtype: PropertyMetadata 1301 """ 1302 return self._name_metadata 1303 1304 @name_metadata.setter 1305 def name_metadata(self, name_metadata): 1306 """Sets the name_metadata of this Participant. 1307 1308 # noqa: E501 1309 1310 :param name_metadata: The name_metadata of this Participant. # noqa: E501 1311 :type: PropertyMetadata 1312 """ 1313 1314 self._name_metadata = name_metadata 1315 1316 @property 1317 def note(self): 1318 """Gets the note of this Participant. # noqa: E501 1319 1320 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 1321 1322 :return: The note of this Participant. # noqa: E501 1323 :rtype: str 1324 """ 1325 return self._note 1326 1327 @note.setter 1328 def note(self, note): 1329 """Sets the note of this Participant. 1330 1331 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 1332 1333 :param note: The note of this Participant. # noqa: E501 1334 :type: str 1335 """ 1336 1337 self._note = note 1338 1339 @property 1340 def note_metadata(self): 1341 """Gets the note_metadata of this Participant. # noqa: E501 1342 1343 # noqa: E501 1344 1345 :return: The note_metadata of this Participant. # noqa: E501 1346 :rtype: PropertyMetadata 1347 """ 1348 return self._note_metadata 1349 1350 @note_metadata.setter 1351 def note_metadata(self, note_metadata): 1352 """Sets the note_metadata of this Participant. 1353 1354 # noqa: E501 1355 1356 :param note_metadata: The note_metadata of this Participant. # noqa: E501 1357 :type: PropertyMetadata 1358 """ 1359 1360 self._note_metadata = note_metadata 1361 1362 @property 1363 def participate_for(self): 1364 """Gets the participate_for of this Participant. # noqa: E501 1365 1366 # noqa: E501 1367 1368 :return: The participate_for of this Participant. # noqa: E501 1369 :rtype: str 1370 """ 1371 return self._participate_for 1372 1373 @participate_for.setter 1374 def participate_for(self, participate_for): 1375 """Sets the participate_for of this Participant. 1376 1377 # noqa: E501 1378 1379 :param participate_for: The participate_for of this Participant. # noqa: E501 1380 :type: str 1381 """ 1382 1383 self._participate_for = participate_for 1384 1385 @property 1386 def participate_for_guid(self): 1387 """Gets the participate_for_guid of this Participant. # noqa: E501 1388 1389 # noqa: E501 1390 1391 :return: The participate_for_guid of this Participant. # noqa: E501 1392 :rtype: str 1393 """ 1394 return self._participate_for_guid 1395 1396 @participate_for_guid.setter 1397 def participate_for_guid(self, participate_for_guid): 1398 """Sets the participate_for_guid of this Participant. 1399 1400 # noqa: E501 1401 1402 :param participate_for_guid: The participate_for_guid of this Participant. # noqa: E501 1403 :type: str 1404 """ 1405 1406 self._participate_for_guid = participate_for_guid 1407 1408 @property 1409 def phone_authentication(self): 1410 """Gets the phone_authentication of this Participant. # noqa: E501 1411 1412 # noqa: E501 1413 1414 :return: The phone_authentication of this Participant. # noqa: E501 1415 :rtype: RecipientPhoneAuthentication 1416 """ 1417 return self._phone_authentication 1418 1419 @phone_authentication.setter 1420 def phone_authentication(self, phone_authentication): 1421 """Sets the phone_authentication of this Participant. 1422 1423 # noqa: E501 1424 1425 :param phone_authentication: The phone_authentication of this Participant. # noqa: E501 1426 :type: RecipientPhoneAuthentication 1427 """ 1428 1429 self._phone_authentication = phone_authentication 1430 1431 @property 1432 def phone_number(self): 1433 """Gets the phone_number of this Participant. # noqa: E501 1434 1435 # noqa: E501 1436 1437 :return: The phone_number of this Participant. # noqa: E501 1438 :rtype: RecipientPhoneNumber 1439 """ 1440 return self._phone_number 1441 1442 @phone_number.setter 1443 def phone_number(self, phone_number): 1444 """Sets the phone_number of this Participant. 1445 1446 # noqa: E501 1447 1448 :param phone_number: The phone_number of this Participant. # noqa: E501 1449 :type: RecipientPhoneNumber 1450 """ 1451 1452 self._phone_number = phone_number 1453 1454 @property 1455 def recipient_attachments(self): 1456 """Gets the recipient_attachments of this Participant. # noqa: E501 1457 1458 Reserved: # noqa: E501 1459 1460 :return: The recipient_attachments of this Participant. # noqa: E501 1461 :rtype: list[RecipientAttachment] 1462 """ 1463 return self._recipient_attachments 1464 1465 @recipient_attachments.setter 1466 def recipient_attachments(self, recipient_attachments): 1467 """Sets the recipient_attachments of this Participant. 1468 1469 Reserved: # noqa: E501 1470 1471 :param recipient_attachments: The recipient_attachments of this Participant. # noqa: E501 1472 :type: list[RecipientAttachment] 1473 """ 1474 1475 self._recipient_attachments = recipient_attachments 1476 1477 @property 1478 def recipient_authentication_status(self): 1479 """Gets the recipient_authentication_status of this Participant. # noqa: E501 1480 1481 # noqa: E501 1482 1483 :return: The recipient_authentication_status of this Participant. # noqa: E501 1484 :rtype: AuthenticationStatus 1485 """ 1486 return self._recipient_authentication_status 1487 1488 @recipient_authentication_status.setter 1489 def recipient_authentication_status(self, recipient_authentication_status): 1490 """Sets the recipient_authentication_status of this Participant. 1491 1492 # noqa: E501 1493 1494 :param recipient_authentication_status: The recipient_authentication_status of this Participant. # noqa: E501 1495 :type: AuthenticationStatus 1496 """ 1497 1498 self._recipient_authentication_status = recipient_authentication_status 1499 1500 @property 1501 def recipient_feature_metadata(self): 1502 """Gets the recipient_feature_metadata of this Participant. # noqa: E501 1503 1504 # noqa: E501 1505 1506 :return: The recipient_feature_metadata of this Participant. # noqa: E501 1507 :rtype: list[FeatureAvailableMetadata] 1508 """ 1509 return self._recipient_feature_metadata 1510 1511 @recipient_feature_metadata.setter 1512 def recipient_feature_metadata(self, recipient_feature_metadata): 1513 """Sets the recipient_feature_metadata of this Participant. 1514 1515 # noqa: E501 1516 1517 :param recipient_feature_metadata: The recipient_feature_metadata of this Participant. # noqa: E501 1518 :type: list[FeatureAvailableMetadata] 1519 """ 1520 1521 self._recipient_feature_metadata = recipient_feature_metadata 1522 1523 @property 1524 def recipient_id(self): 1525 """Gets the recipient_id of this Participant. # noqa: E501 1526 1527 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1528 1529 :return: The recipient_id of this Participant. # noqa: E501 1530 :rtype: str 1531 """ 1532 return self._recipient_id 1533 1534 @recipient_id.setter 1535 def recipient_id(self, recipient_id): 1536 """Sets the recipient_id of this Participant. 1537 1538 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1539 1540 :param recipient_id: The recipient_id of this Participant. # noqa: E501 1541 :type: str 1542 """ 1543 1544 self._recipient_id = recipient_id 1545 1546 @property 1547 def recipient_id_guid(self): 1548 """Gets the recipient_id_guid of this Participant. # noqa: E501 1549 1550 # noqa: E501 1551 1552 :return: The recipient_id_guid of this Participant. # noqa: E501 1553 :rtype: str 1554 """ 1555 return self._recipient_id_guid 1556 1557 @recipient_id_guid.setter 1558 def recipient_id_guid(self, recipient_id_guid): 1559 """Sets the recipient_id_guid of this Participant. 1560 1561 # noqa: E501 1562 1563 :param recipient_id_guid: The recipient_id_guid of this Participant. # noqa: E501 1564 :type: str 1565 """ 1566 1567 self._recipient_id_guid = recipient_id_guid 1568 1569 @property 1570 def recipient_type(self): 1571 """Gets the recipient_type of this Participant. # noqa: E501 1572 1573 # noqa: E501 1574 1575 :return: The recipient_type of this Participant. # noqa: E501 1576 :rtype: str 1577 """ 1578 return self._recipient_type 1579 1580 @recipient_type.setter 1581 def recipient_type(self, recipient_type): 1582 """Sets the recipient_type of this Participant. 1583 1584 # noqa: E501 1585 1586 :param recipient_type: The recipient_type of this Participant. # noqa: E501 1587 :type: str 1588 """ 1589 1590 self._recipient_type = recipient_type 1591 1592 @property 1593 def recipient_type_metadata(self): 1594 """Gets the recipient_type_metadata of this Participant. # noqa: E501 1595 1596 # noqa: E501 1597 1598 :return: The recipient_type_metadata of this Participant. # noqa: E501 1599 :rtype: PropertyMetadata 1600 """ 1601 return self._recipient_type_metadata 1602 1603 @recipient_type_metadata.setter 1604 def recipient_type_metadata(self, recipient_type_metadata): 1605 """Sets the recipient_type_metadata of this Participant. 1606 1607 # noqa: E501 1608 1609 :param recipient_type_metadata: The recipient_type_metadata of this Participant. # noqa: E501 1610 :type: PropertyMetadata 1611 """ 1612 1613 self._recipient_type_metadata = recipient_type_metadata 1614 1615 @property 1616 def require_id_lookup(self): 1617 """Gets the require_id_lookup of this Participant. # noqa: E501 1618 1619 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 1620 1621 :return: The require_id_lookup of this Participant. # noqa: E501 1622 :rtype: str 1623 """ 1624 return self._require_id_lookup 1625 1626 @require_id_lookup.setter 1627 def require_id_lookup(self, require_id_lookup): 1628 """Sets the require_id_lookup of this Participant. 1629 1630 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 1631 1632 :param require_id_lookup: The require_id_lookup of this Participant. # noqa: E501 1633 :type: str 1634 """ 1635 1636 self._require_id_lookup = require_id_lookup 1637 1638 @property 1639 def require_id_lookup_metadata(self): 1640 """Gets the require_id_lookup_metadata of this Participant. # noqa: E501 1641 1642 # noqa: E501 1643 1644 :return: The require_id_lookup_metadata of this Participant. # noqa: E501 1645 :rtype: PropertyMetadata 1646 """ 1647 return self._require_id_lookup_metadata 1648 1649 @require_id_lookup_metadata.setter 1650 def require_id_lookup_metadata(self, require_id_lookup_metadata): 1651 """Sets the require_id_lookup_metadata of this Participant. 1652 1653 # noqa: E501 1654 1655 :param require_id_lookup_metadata: The require_id_lookup_metadata of this Participant. # noqa: E501 1656 :type: PropertyMetadata 1657 """ 1658 1659 self._require_id_lookup_metadata = require_id_lookup_metadata 1660 1661 @property 1662 def role_name(self): 1663 """Gets the role_name of this Participant. # noqa: E501 1664 1665 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1666 1667 :return: The role_name of this Participant. # noqa: E501 1668 :rtype: str 1669 """ 1670 return self._role_name 1671 1672 @role_name.setter 1673 def role_name(self, role_name): 1674 """Sets the role_name of this Participant. 1675 1676 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1677 1678 :param role_name: The role_name of this Participant. # noqa: E501 1679 :type: str 1680 """ 1681 1682 self._role_name = role_name 1683 1684 @property 1685 def routing_order(self): 1686 """Gets the routing_order of this Participant. # noqa: E501 1687 1688 Specifies the routing order of the recipient in the envelope. # noqa: E501 1689 1690 :return: The routing_order of this Participant. # noqa: E501 1691 :rtype: str 1692 """ 1693 return self._routing_order 1694 1695 @routing_order.setter 1696 def routing_order(self, routing_order): 1697 """Sets the routing_order of this Participant. 1698 1699 Specifies the routing order of the recipient in the envelope. # noqa: E501 1700 1701 :param routing_order: The routing_order of this Participant. # noqa: E501 1702 :type: str 1703 """ 1704 1705 self._routing_order = routing_order 1706 1707 @property 1708 def routing_order_metadata(self): 1709 """Gets the routing_order_metadata of this Participant. # noqa: E501 1710 1711 # noqa: E501 1712 1713 :return: The routing_order_metadata of this Participant. # noqa: E501 1714 :rtype: PropertyMetadata 1715 """ 1716 return self._routing_order_metadata 1717 1718 @routing_order_metadata.setter 1719 def routing_order_metadata(self, routing_order_metadata): 1720 """Sets the routing_order_metadata of this Participant. 1721 1722 # noqa: E501 1723 1724 :param routing_order_metadata: The routing_order_metadata of this Participant. # noqa: E501 1725 :type: PropertyMetadata 1726 """ 1727 1728 self._routing_order_metadata = routing_order_metadata 1729 1730 @property 1731 def sent_date_time(self): 1732 """Gets the sent_date_time of this Participant. # noqa: E501 1733 1734 The date and time the envelope was sent. # noqa: E501 1735 1736 :return: The sent_date_time of this Participant. # noqa: E501 1737 :rtype: str 1738 """ 1739 return self._sent_date_time 1740 1741 @sent_date_time.setter 1742 def sent_date_time(self, sent_date_time): 1743 """Sets the sent_date_time of this Participant. 1744 1745 The date and time the envelope was sent. # noqa: E501 1746 1747 :param sent_date_time: The sent_date_time of this Participant. # noqa: E501 1748 :type: str 1749 """ 1750 1751 self._sent_date_time = sent_date_time 1752 1753 @property 1754 def signed_date_time(self): 1755 """Gets the signed_date_time of this Participant. # noqa: E501 1756 1757 Reserved: For DocuSign use only. # noqa: E501 1758 1759 :return: The signed_date_time of this Participant. # noqa: E501 1760 :rtype: str 1761 """ 1762 return self._signed_date_time 1763 1764 @signed_date_time.setter 1765 def signed_date_time(self, signed_date_time): 1766 """Sets the signed_date_time of this Participant. 1767 1768 Reserved: For DocuSign use only. # noqa: E501 1769 1770 :param signed_date_time: The signed_date_time of this Participant. # noqa: E501 1771 :type: str 1772 """ 1773 1774 self._signed_date_time = signed_date_time 1775 1776 @property 1777 def signing_group_id(self): 1778 """Gets the signing_group_id of this Participant. # noqa: E501 1779 1780 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 1781 1782 :return: The signing_group_id of this Participant. # noqa: E501 1783 :rtype: str 1784 """ 1785 return self._signing_group_id 1786 1787 @signing_group_id.setter 1788 def signing_group_id(self, signing_group_id): 1789 """Sets the signing_group_id of this Participant. 1790 1791 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 1792 1793 :param signing_group_id: The signing_group_id of this Participant. # noqa: E501 1794 :type: str 1795 """ 1796 1797 self._signing_group_id = signing_group_id 1798 1799 @property 1800 def signing_group_id_metadata(self): 1801 """Gets the signing_group_id_metadata of this Participant. # noqa: E501 1802 1803 # noqa: E501 1804 1805 :return: The signing_group_id_metadata of this Participant. # noqa: E501 1806 :rtype: PropertyMetadata 1807 """ 1808 return self._signing_group_id_metadata 1809 1810 @signing_group_id_metadata.setter 1811 def signing_group_id_metadata(self, signing_group_id_metadata): 1812 """Sets the signing_group_id_metadata of this Participant. 1813 1814 # noqa: E501 1815 1816 :param signing_group_id_metadata: The signing_group_id_metadata of this Participant. # noqa: E501 1817 :type: PropertyMetadata 1818 """ 1819 1820 self._signing_group_id_metadata = signing_group_id_metadata 1821 1822 @property 1823 def signing_group_name(self): 1824 """Gets the signing_group_name of this Participant. # noqa: E501 1825 1826 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1827 1828 :return: The signing_group_name of this Participant. # noqa: E501 1829 :rtype: str 1830 """ 1831 return self._signing_group_name 1832 1833 @signing_group_name.setter 1834 def signing_group_name(self, signing_group_name): 1835 """Sets the signing_group_name of this Participant. 1836 1837 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1838 1839 :param signing_group_name: The signing_group_name of this Participant. # noqa: E501 1840 :type: str 1841 """ 1842 1843 self._signing_group_name = signing_group_name 1844 1845 @property 1846 def signing_group_users(self): 1847 """Gets the signing_group_users of this Participant. # noqa: E501 1848 1849 A complex type that contains information about users in the signing group. # noqa: E501 1850 1851 :return: The signing_group_users of this Participant. # noqa: E501 1852 :rtype: list[UserInfo] 1853 """ 1854 return self._signing_group_users 1855 1856 @signing_group_users.setter 1857 def signing_group_users(self, signing_group_users): 1858 """Sets the signing_group_users of this Participant. 1859 1860 A complex type that contains information about users in the signing group. # noqa: E501 1861 1862 :param signing_group_users: The signing_group_users of this Participant. # noqa: E501 1863 :type: list[UserInfo] 1864 """ 1865 1866 self._signing_group_users = signing_group_users 1867 1868 @property 1869 def sms_authentication(self): 1870 """Gets the sms_authentication of this Participant. # noqa: E501 1871 1872 # noqa: E501 1873 1874 :return: The sms_authentication of this Participant. # noqa: E501 1875 :rtype: RecipientSMSAuthentication 1876 """ 1877 return self._sms_authentication 1878 1879 @sms_authentication.setter 1880 def sms_authentication(self, sms_authentication): 1881 """Sets the sms_authentication of this Participant. 1882 1883 # noqa: E501 1884 1885 :param sms_authentication: The sms_authentication of this Participant. # noqa: E501 1886 :type: RecipientSMSAuthentication 1887 """ 1888 1889 self._sms_authentication = sms_authentication 1890 1891 @property 1892 def social_authentications(self): 1893 """Gets the social_authentications of this Participant. # noqa: E501 1894 1895 Lists the social ID type that can be used for recipient authentication. # noqa: E501 1896 1897 :return: The social_authentications of this Participant. # noqa: E501 1898 :rtype: list[SocialAuthentication] 1899 """ 1900 return self._social_authentications 1901 1902 @social_authentications.setter 1903 def social_authentications(self, social_authentications): 1904 """Sets the social_authentications of this Participant. 1905 1906 Lists the social ID type that can be used for recipient authentication. # noqa: E501 1907 1908 :param social_authentications: The social_authentications of this Participant. # noqa: E501 1909 :type: list[SocialAuthentication] 1910 """ 1911 1912 self._social_authentications = social_authentications 1913 1914 @property 1915 def status(self): 1916 """Gets the status of this Participant. # noqa: E501 1917 1918 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 1919 1920 :return: The status of this Participant. # noqa: E501 1921 :rtype: str 1922 """ 1923 return self._status 1924 1925 @status.setter 1926 def status(self, status): 1927 """Sets the status of this Participant. 1928 1929 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 1930 1931 :param status: The status of this Participant. # noqa: E501 1932 :type: str 1933 """ 1934 1935 self._status = status 1936 1937 @property 1938 def status_code(self): 1939 """Gets the status_code of this Participant. # noqa: E501 1940 1941 # noqa: E501 1942 1943 :return: The status_code of this Participant. # noqa: E501 1944 :rtype: str 1945 """ 1946 return self._status_code 1947 1948 @status_code.setter 1949 def status_code(self, status_code): 1950 """Sets the status_code of this Participant. 1951 1952 # noqa: E501 1953 1954 :param status_code: The status_code of this Participant. # noqa: E501 1955 :type: str 1956 """ 1957 1958 self._status_code = status_code 1959 1960 @property 1961 def suppress_emails(self): 1962 """Gets the suppress_emails of this Participant. # noqa: E501 1963 1964 # noqa: E501 1965 1966 :return: The suppress_emails of this Participant. # noqa: E501 1967 :rtype: str 1968 """ 1969 return self._suppress_emails 1970 1971 @suppress_emails.setter 1972 def suppress_emails(self, suppress_emails): 1973 """Sets the suppress_emails of this Participant. 1974 1975 # noqa: E501 1976 1977 :param suppress_emails: The suppress_emails of this Participant. # noqa: E501 1978 :type: str 1979 """ 1980 1981 self._suppress_emails = suppress_emails 1982 1983 @property 1984 def template_locked(self): 1985 """Gets the template_locked of this Participant. # noqa: E501 1986 1987 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 1988 1989 :return: The template_locked of this Participant. # noqa: E501 1990 :rtype: str 1991 """ 1992 return self._template_locked 1993 1994 @template_locked.setter 1995 def template_locked(self, template_locked): 1996 """Sets the template_locked of this Participant. 1997 1998 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 1999 2000 :param template_locked: The template_locked of this Participant. # noqa: E501 2001 :type: str 2002 """ 2003 2004 self._template_locked = template_locked 2005 2006 @property 2007 def template_required(self): 2008 """Gets the template_required of this Participant. # noqa: E501 2009 2010 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2011 2012 :return: The template_required of this Participant. # noqa: E501 2013 :rtype: str 2014 """ 2015 return self._template_required 2016 2017 @template_required.setter 2018 def template_required(self, template_required): 2019 """Sets the template_required of this Participant. 2020 2021 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2022 2023 :param template_required: The template_required of this Participant. # noqa: E501 2024 :type: str 2025 """ 2026 2027 self._template_required = template_required 2028 2029 @property 2030 def total_tab_count(self): 2031 """Gets the total_tab_count of this Participant. # noqa: E501 2032 2033 # noqa: E501 2034 2035 :return: The total_tab_count of this Participant. # noqa: E501 2036 :rtype: str 2037 """ 2038 return self._total_tab_count 2039 2040 @total_tab_count.setter 2041 def total_tab_count(self, total_tab_count): 2042 """Sets the total_tab_count of this Participant. 2043 2044 # noqa: E501 2045 2046 :param total_tab_count: The total_tab_count of this Participant. # noqa: E501 2047 :type: str 2048 """ 2049 2050 self._total_tab_count = total_tab_count 2051 2052 @property 2053 def user_id(self): 2054 """Gets the user_id of this Participant. # noqa: E501 2055 2056 # noqa: E501 2057 2058 :return: The user_id of this Participant. # noqa: E501 2059 :rtype: str 2060 """ 2061 return self._user_id 2062 2063 @user_id.setter 2064 def user_id(self, user_id): 2065 """Sets the user_id of this Participant. 2066 2067 # noqa: E501 2068 2069 :param user_id: The user_id of this Participant. # noqa: E501 2070 :type: str 2071 """ 2072 2073 self._user_id = user_id 2074 2075 def to_dict(self): 2076 """Returns the model properties as a dict""" 2077 result = {} 2078 2079 for attr, _ in six.iteritems(self.swagger_types): 2080 value = getattr(self, attr) 2081 if isinstance(value, list): 2082 result[attr] = list(map( 2083 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2084 value 2085 )) 2086 elif hasattr(value, "to_dict"): 2087 result[attr] = value.to_dict() 2088 elif isinstance(value, dict): 2089 result[attr] = dict(map( 2090 lambda item: (item[0], item[1].to_dict()) 2091 if hasattr(item[1], "to_dict") else item, 2092 value.items() 2093 )) 2094 else: 2095 result[attr] = value 2096 if issubclass(Participant, dict): 2097 for key, value in self.items(): 2098 result[key] = value 2099 2100 return result 2101 2102 def to_str(self): 2103 """Returns the string representation of the model""" 2104 return pprint.pformat(self.to_dict()) 2105 2106 def __repr__(self): 2107 """For `print` and `pprint`""" 2108 return self.to_str() 2109 2110 def __eq__(self, other): 2111 """Returns true if both objects are equal""" 2112 if not isinstance(other, Participant): 2113 return False 2114 2115 return self.to_dict() == other.to_dict() 2116 2117 def __ne__(self, other): 2118 """Returns true if both objects are not equal""" 2119 if not isinstance(other, Participant): 2120 return True 2121 2122 return self.to_dict() != other.to_dict()
class
Participant:
23class Participant(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 'allow_system_override_for_locked_recipient': 'str', 42 'auto_responded_reason': 'str', 43 'bulk_send_v2_recipient': 'str', 44 'client_user_id': 'str', 45 'completed_count': 'str', 46 'consent_details_list': 'list[ConsentDetails]', 47 'custom_fields': 'list[str]', 48 'declined_date_time': 'str', 49 'declined_reason': 'str', 50 'delivered_date_time': 'str', 51 'delivery_method': 'str', 52 'delivery_method_metadata': 'PropertyMetadata', 53 'designator_id': 'str', 54 'designator_id_guid': 'str', 55 'document_visibility': 'list[DocumentVisibility]', 56 'email': 'str', 57 'email_metadata': 'PropertyMetadata', 58 'email_notification': 'RecipientEmailNotification', 59 'email_recipient_post_signing_url': 'str', 60 'embedded_recipient_start_url': 'str', 61 'error_details': 'ErrorDetails', 62 'fax_number': 'str', 63 'fax_number_metadata': 'PropertyMetadata', 64 'first_name': 'str', 65 'first_name_metadata': 'PropertyMetadata', 66 'full_name': 'str', 67 'full_name_metadata': 'PropertyMetadata', 68 'id_check_configuration_name': 'str', 69 'id_check_configuration_name_metadata': 'PropertyMetadata', 70 'id_check_information_input': 'IdCheckInformationInput', 71 'identity_verification': 'RecipientIdentityVerification', 72 'inherit_email_notification_configuration': 'str', 73 'last_name': 'str', 74 'last_name_metadata': 'PropertyMetadata', 75 'locked_recipient_phone_auth_editable': 'str', 76 'locked_recipient_sms_editable': 'str', 77 'name': 'str', 78 'name_metadata': 'PropertyMetadata', 79 'note': 'str', 80 'note_metadata': 'PropertyMetadata', 81 'participate_for': 'str', 82 'participate_for_guid': 'str', 83 'phone_authentication': 'RecipientPhoneAuthentication', 84 'phone_number': 'RecipientPhoneNumber', 85 'recipient_attachments': 'list[RecipientAttachment]', 86 'recipient_authentication_status': 'AuthenticationStatus', 87 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 88 'recipient_id': 'str', 89 'recipient_id_guid': 'str', 90 'recipient_type': 'str', 91 'recipient_type_metadata': 'PropertyMetadata', 92 'require_id_lookup': 'str', 93 'require_id_lookup_metadata': 'PropertyMetadata', 94 'role_name': 'str', 95 'routing_order': 'str', 96 'routing_order_metadata': 'PropertyMetadata', 97 'sent_date_time': 'str', 98 'signed_date_time': 'str', 99 'signing_group_id': 'str', 100 'signing_group_id_metadata': 'PropertyMetadata', 101 'signing_group_name': 'str', 102 'signing_group_users': 'list[UserInfo]', 103 'sms_authentication': 'RecipientSMSAuthentication', 104 'social_authentications': 'list[SocialAuthentication]', 105 'status': 'str', 106 'status_code': 'str', 107 'suppress_emails': 'str', 108 'template_locked': 'str', 109 'template_required': 'str', 110 'total_tab_count': 'str', 111 'user_id': 'str' 112 } 113 114 attribute_map = { 115 'access_code': 'accessCode', 116 'access_code_metadata': 'accessCodeMetadata', 117 'add_access_code_to_email': 'addAccessCodeToEmail', 118 'additional_notifications': 'additionalNotifications', 119 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 120 'auto_responded_reason': 'autoRespondedReason', 121 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 122 'client_user_id': 'clientUserId', 123 'completed_count': 'completedCount', 124 'consent_details_list': 'consentDetailsList', 125 'custom_fields': 'customFields', 126 'declined_date_time': 'declinedDateTime', 127 'declined_reason': 'declinedReason', 128 'delivered_date_time': 'deliveredDateTime', 129 'delivery_method': 'deliveryMethod', 130 'delivery_method_metadata': 'deliveryMethodMetadata', 131 'designator_id': 'designatorId', 132 'designator_id_guid': 'designatorIdGuid', 133 'document_visibility': 'documentVisibility', 134 'email': 'email', 135 'email_metadata': 'emailMetadata', 136 'email_notification': 'emailNotification', 137 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 138 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 139 'error_details': 'errorDetails', 140 'fax_number': 'faxNumber', 141 'fax_number_metadata': 'faxNumberMetadata', 142 'first_name': 'firstName', 143 'first_name_metadata': 'firstNameMetadata', 144 'full_name': 'fullName', 145 'full_name_metadata': 'fullNameMetadata', 146 'id_check_configuration_name': 'idCheckConfigurationName', 147 'id_check_configuration_name_metadata': 'idCheckConfigurationNameMetadata', 148 'id_check_information_input': 'idCheckInformationInput', 149 'identity_verification': 'identityVerification', 150 'inherit_email_notification_configuration': 'inheritEmailNotificationConfiguration', 151 'last_name': 'lastName', 152 'last_name_metadata': 'lastNameMetadata', 153 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 154 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 155 'name': 'name', 156 'name_metadata': 'nameMetadata', 157 'note': 'note', 158 'note_metadata': 'noteMetadata', 159 'participate_for': 'participateFor', 160 'participate_for_guid': 'participateForGuid', 161 'phone_authentication': 'phoneAuthentication', 162 'phone_number': 'phoneNumber', 163 'recipient_attachments': 'recipientAttachments', 164 'recipient_authentication_status': 'recipientAuthenticationStatus', 165 'recipient_feature_metadata': 'recipientFeatureMetadata', 166 'recipient_id': 'recipientId', 167 'recipient_id_guid': 'recipientIdGuid', 168 'recipient_type': 'recipientType', 169 'recipient_type_metadata': 'recipientTypeMetadata', 170 'require_id_lookup': 'requireIdLookup', 171 'require_id_lookup_metadata': 'requireIdLookupMetadata', 172 'role_name': 'roleName', 173 'routing_order': 'routingOrder', 174 'routing_order_metadata': 'routingOrderMetadata', 175 'sent_date_time': 'sentDateTime', 176 'signed_date_time': 'signedDateTime', 177 'signing_group_id': 'signingGroupId', 178 'signing_group_id_metadata': 'signingGroupIdMetadata', 179 'signing_group_name': 'signingGroupName', 180 'signing_group_users': 'signingGroupUsers', 181 'sms_authentication': 'smsAuthentication', 182 'social_authentications': 'socialAuthentications', 183 'status': 'status', 184 'status_code': 'statusCode', 185 'suppress_emails': 'suppressEmails', 186 'template_locked': 'templateLocked', 187 'template_required': 'templateRequired', 188 'total_tab_count': 'totalTabCount', 189 'user_id': 'userId' 190 } 191 192 def __init__(self, _configuration=None, **kwargs): # noqa: E501 193 """Participant - a model defined in Swagger""" # noqa: E501 194 if _configuration is None: 195 _configuration = Configuration() 196 self._configuration = _configuration 197 198 self._access_code = None 199 self._access_code_metadata = None 200 self._add_access_code_to_email = None 201 self._additional_notifications = None 202 self._allow_system_override_for_locked_recipient = None 203 self._auto_responded_reason = None 204 self._bulk_send_v2_recipient = None 205 self._client_user_id = None 206 self._completed_count = None 207 self._consent_details_list = None 208 self._custom_fields = None 209 self._declined_date_time = None 210 self._declined_reason = None 211 self._delivered_date_time = None 212 self._delivery_method = None 213 self._delivery_method_metadata = None 214 self._designator_id = None 215 self._designator_id_guid = None 216 self._document_visibility = None 217 self._email = None 218 self._email_metadata = None 219 self._email_notification = None 220 self._email_recipient_post_signing_url = None 221 self._embedded_recipient_start_url = None 222 self._error_details = None 223 self._fax_number = None 224 self._fax_number_metadata = None 225 self._first_name = None 226 self._first_name_metadata = None 227 self._full_name = None 228 self._full_name_metadata = None 229 self._id_check_configuration_name = None 230 self._id_check_configuration_name_metadata = None 231 self._id_check_information_input = None 232 self._identity_verification = None 233 self._inherit_email_notification_configuration = None 234 self._last_name = None 235 self._last_name_metadata = None 236 self._locked_recipient_phone_auth_editable = None 237 self._locked_recipient_sms_editable = None 238 self._name = None 239 self._name_metadata = None 240 self._note = None 241 self._note_metadata = None 242 self._participate_for = None 243 self._participate_for_guid = None 244 self._phone_authentication = None 245 self._phone_number = None 246 self._recipient_attachments = None 247 self._recipient_authentication_status = None 248 self._recipient_feature_metadata = None 249 self._recipient_id = None 250 self._recipient_id_guid = None 251 self._recipient_type = None 252 self._recipient_type_metadata = None 253 self._require_id_lookup = None 254 self._require_id_lookup_metadata = None 255 self._role_name = None 256 self._routing_order = None 257 self._routing_order_metadata = None 258 self._sent_date_time = None 259 self._signed_date_time = None 260 self._signing_group_id = None 261 self._signing_group_id_metadata = None 262 self._signing_group_name = None 263 self._signing_group_users = None 264 self._sms_authentication = None 265 self._social_authentications = None 266 self._status = None 267 self._status_code = None 268 self._suppress_emails = None 269 self._template_locked = None 270 self._template_required = None 271 self._total_tab_count = None 272 self._user_id = None 273 self.discriminator = None 274 275 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 276 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 277 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 278 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 279 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 280 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 281 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 282 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 283 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 284 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 285 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 286 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 287 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 288 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 289 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 290 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 291 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 292 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 293 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 294 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 295 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 296 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 297 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 298 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 299 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 300 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 301 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 302 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 303 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 304 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 305 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 306 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 307 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 308 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 309 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 310 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 311 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 312 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 313 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 314 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 315 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 316 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 317 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 318 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 319 setattr(self, "_{}".format('participate_for'), kwargs.get('participate_for', None)) 320 setattr(self, "_{}".format('participate_for_guid'), kwargs.get('participate_for_guid', None)) 321 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 322 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 323 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 324 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 325 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 326 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 327 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 328 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 329 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 330 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 331 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 332 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 333 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 334 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 335 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 336 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 337 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 338 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 339 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 340 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 341 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 342 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 343 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 344 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 345 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 346 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 347 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 348 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 349 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None)) 350 351 @property 352 def access_code(self): 353 """Gets the access_code of this Participant. # noqa: E501 354 355 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 356 357 :return: The access_code of this Participant. # noqa: E501 358 :rtype: str 359 """ 360 return self._access_code 361 362 @access_code.setter 363 def access_code(self, access_code): 364 """Sets the access_code of this Participant. 365 366 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 367 368 :param access_code: The access_code of this Participant. # noqa: E501 369 :type: str 370 """ 371 372 self._access_code = access_code 373 374 @property 375 def access_code_metadata(self): 376 """Gets the access_code_metadata of this Participant. # noqa: E501 377 378 # noqa: E501 379 380 :return: The access_code_metadata of this Participant. # noqa: E501 381 :rtype: PropertyMetadata 382 """ 383 return self._access_code_metadata 384 385 @access_code_metadata.setter 386 def access_code_metadata(self, access_code_metadata): 387 """Sets the access_code_metadata of this Participant. 388 389 # noqa: E501 390 391 :param access_code_metadata: The access_code_metadata of this Participant. # noqa: E501 392 :type: PropertyMetadata 393 """ 394 395 self._access_code_metadata = access_code_metadata 396 397 @property 398 def add_access_code_to_email(self): 399 """Gets the add_access_code_to_email of this Participant. # noqa: E501 400 401 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 402 403 :return: The add_access_code_to_email of this Participant. # noqa: E501 404 :rtype: str 405 """ 406 return self._add_access_code_to_email 407 408 @add_access_code_to_email.setter 409 def add_access_code_to_email(self, add_access_code_to_email): 410 """Sets the add_access_code_to_email of this Participant. 411 412 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 413 414 :param add_access_code_to_email: The add_access_code_to_email of this Participant. # noqa: E501 415 :type: str 416 """ 417 418 self._add_access_code_to_email = add_access_code_to_email 419 420 @property 421 def additional_notifications(self): 422 """Gets the additional_notifications of this Participant. # noqa: E501 423 424 # noqa: E501 425 426 :return: The additional_notifications of this Participant. # noqa: E501 427 :rtype: list[RecipientAdditionalNotification] 428 """ 429 return self._additional_notifications 430 431 @additional_notifications.setter 432 def additional_notifications(self, additional_notifications): 433 """Sets the additional_notifications of this Participant. 434 435 # noqa: E501 436 437 :param additional_notifications: The additional_notifications of this Participant. # noqa: E501 438 :type: list[RecipientAdditionalNotification] 439 """ 440 441 self._additional_notifications = additional_notifications 442 443 @property 444 def allow_system_override_for_locked_recipient(self): 445 """Gets the allow_system_override_for_locked_recipient of this Participant. # noqa: E501 446 447 # noqa: E501 448 449 :return: The allow_system_override_for_locked_recipient of this Participant. # noqa: E501 450 :rtype: str 451 """ 452 return self._allow_system_override_for_locked_recipient 453 454 @allow_system_override_for_locked_recipient.setter 455 def allow_system_override_for_locked_recipient(self, allow_system_override_for_locked_recipient): 456 """Sets the allow_system_override_for_locked_recipient of this Participant. 457 458 # noqa: E501 459 460 :param allow_system_override_for_locked_recipient: The allow_system_override_for_locked_recipient of this Participant. # noqa: E501 461 :type: str 462 """ 463 464 self._allow_system_override_for_locked_recipient = allow_system_override_for_locked_recipient 465 466 @property 467 def auto_responded_reason(self): 468 """Gets the auto_responded_reason of this Participant. # noqa: E501 469 470 # noqa: E501 471 472 :return: The auto_responded_reason of this Participant. # noqa: E501 473 :rtype: str 474 """ 475 return self._auto_responded_reason 476 477 @auto_responded_reason.setter 478 def auto_responded_reason(self, auto_responded_reason): 479 """Sets the auto_responded_reason of this Participant. 480 481 # noqa: E501 482 483 :param auto_responded_reason: The auto_responded_reason of this Participant. # noqa: E501 484 :type: str 485 """ 486 487 self._auto_responded_reason = auto_responded_reason 488 489 @property 490 def bulk_send_v2_recipient(self): 491 """Gets the bulk_send_v2_recipient of this Participant. # noqa: E501 492 493 # noqa: E501 494 495 :return: The bulk_send_v2_recipient of this Participant. # noqa: E501 496 :rtype: str 497 """ 498 return self._bulk_send_v2_recipient 499 500 @bulk_send_v2_recipient.setter 501 def bulk_send_v2_recipient(self, bulk_send_v2_recipient): 502 """Sets the bulk_send_v2_recipient of this Participant. 503 504 # noqa: E501 505 506 :param bulk_send_v2_recipient: The bulk_send_v2_recipient of this Participant. # noqa: E501 507 :type: str 508 """ 509 510 self._bulk_send_v2_recipient = bulk_send_v2_recipient 511 512 @property 513 def client_user_id(self): 514 """Gets the client_user_id of this Participant. # noqa: E501 515 516 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 517 518 :return: The client_user_id of this Participant. # noqa: E501 519 :rtype: str 520 """ 521 return self._client_user_id 522 523 @client_user_id.setter 524 def client_user_id(self, client_user_id): 525 """Sets the client_user_id of this Participant. 526 527 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 528 529 :param client_user_id: The client_user_id of this Participant. # noqa: E501 530 :type: str 531 """ 532 533 self._client_user_id = client_user_id 534 535 @property 536 def completed_count(self): 537 """Gets the completed_count of this Participant. # noqa: E501 538 539 # noqa: E501 540 541 :return: The completed_count of this Participant. # noqa: E501 542 :rtype: str 543 """ 544 return self._completed_count 545 546 @completed_count.setter 547 def completed_count(self, completed_count): 548 """Sets the completed_count of this Participant. 549 550 # noqa: E501 551 552 :param completed_count: The completed_count of this Participant. # noqa: E501 553 :type: str 554 """ 555 556 self._completed_count = completed_count 557 558 @property 559 def consent_details_list(self): 560 """Gets the consent_details_list of this Participant. # noqa: E501 561 562 # noqa: E501 563 564 :return: The consent_details_list of this Participant. # noqa: E501 565 :rtype: list[ConsentDetails] 566 """ 567 return self._consent_details_list 568 569 @consent_details_list.setter 570 def consent_details_list(self, consent_details_list): 571 """Sets the consent_details_list of this Participant. 572 573 # noqa: E501 574 575 :param consent_details_list: The consent_details_list of this Participant. # noqa: E501 576 :type: list[ConsentDetails] 577 """ 578 579 self._consent_details_list = consent_details_list 580 581 @property 582 def custom_fields(self): 583 """Gets the custom_fields of this Participant. # noqa: E501 584 585 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 586 587 :return: The custom_fields of this Participant. # noqa: E501 588 :rtype: list[str] 589 """ 590 return self._custom_fields 591 592 @custom_fields.setter 593 def custom_fields(self, custom_fields): 594 """Sets the custom_fields of this Participant. 595 596 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 597 598 :param custom_fields: The custom_fields of this Participant. # noqa: E501 599 :type: list[str] 600 """ 601 602 self._custom_fields = custom_fields 603 604 @property 605 def declined_date_time(self): 606 """Gets the declined_date_time of this Participant. # noqa: E501 607 608 The date and time the recipient declined the document. # noqa: E501 609 610 :return: The declined_date_time of this Participant. # noqa: E501 611 :rtype: str 612 """ 613 return self._declined_date_time 614 615 @declined_date_time.setter 616 def declined_date_time(self, declined_date_time): 617 """Sets the declined_date_time of this Participant. 618 619 The date and time the recipient declined the document. # noqa: E501 620 621 :param declined_date_time: The declined_date_time of this Participant. # noqa: E501 622 :type: str 623 """ 624 625 self._declined_date_time = declined_date_time 626 627 @property 628 def declined_reason(self): 629 """Gets the declined_reason of this Participant. # noqa: E501 630 631 The reason the recipient declined the document. # noqa: E501 632 633 :return: The declined_reason of this Participant. # noqa: E501 634 :rtype: str 635 """ 636 return self._declined_reason 637 638 @declined_reason.setter 639 def declined_reason(self, declined_reason): 640 """Sets the declined_reason of this Participant. 641 642 The reason the recipient declined the document. # noqa: E501 643 644 :param declined_reason: The declined_reason of this Participant. # noqa: E501 645 :type: str 646 """ 647 648 self._declined_reason = declined_reason 649 650 @property 651 def delivered_date_time(self): 652 """Gets the delivered_date_time of this Participant. # noqa: E501 653 654 Reserved: For DocuSign use only. # noqa: E501 655 656 :return: The delivered_date_time of this Participant. # noqa: E501 657 :rtype: str 658 """ 659 return self._delivered_date_time 660 661 @delivered_date_time.setter 662 def delivered_date_time(self, delivered_date_time): 663 """Sets the delivered_date_time of this Participant. 664 665 Reserved: For DocuSign use only. # noqa: E501 666 667 :param delivered_date_time: The delivered_date_time of this Participant. # noqa: E501 668 :type: str 669 """ 670 671 self._delivered_date_time = delivered_date_time 672 673 @property 674 def delivery_method(self): 675 """Gets the delivery_method of this Participant. # noqa: E501 676 677 Reserved: For DocuSign use only. # noqa: E501 678 679 :return: The delivery_method of this Participant. # noqa: E501 680 :rtype: str 681 """ 682 return self._delivery_method 683 684 @delivery_method.setter 685 def delivery_method(self, delivery_method): 686 """Sets the delivery_method of this Participant. 687 688 Reserved: For DocuSign use only. # noqa: E501 689 690 :param delivery_method: The delivery_method of this Participant. # noqa: E501 691 :type: str 692 """ 693 694 self._delivery_method = delivery_method 695 696 @property 697 def delivery_method_metadata(self): 698 """Gets the delivery_method_metadata of this Participant. # noqa: E501 699 700 # noqa: E501 701 702 :return: The delivery_method_metadata of this Participant. # noqa: E501 703 :rtype: PropertyMetadata 704 """ 705 return self._delivery_method_metadata 706 707 @delivery_method_metadata.setter 708 def delivery_method_metadata(self, delivery_method_metadata): 709 """Sets the delivery_method_metadata of this Participant. 710 711 # noqa: E501 712 713 :param delivery_method_metadata: The delivery_method_metadata of this Participant. # noqa: E501 714 :type: PropertyMetadata 715 """ 716 717 self._delivery_method_metadata = delivery_method_metadata 718 719 @property 720 def designator_id(self): 721 """Gets the designator_id of this Participant. # noqa: E501 722 723 # noqa: E501 724 725 :return: The designator_id of this Participant. # noqa: E501 726 :rtype: str 727 """ 728 return self._designator_id 729 730 @designator_id.setter 731 def designator_id(self, designator_id): 732 """Sets the designator_id of this Participant. 733 734 # noqa: E501 735 736 :param designator_id: The designator_id of this Participant. # noqa: E501 737 :type: str 738 """ 739 740 self._designator_id = designator_id 741 742 @property 743 def designator_id_guid(self): 744 """Gets the designator_id_guid of this Participant. # noqa: E501 745 746 # noqa: E501 747 748 :return: The designator_id_guid of this Participant. # noqa: E501 749 :rtype: str 750 """ 751 return self._designator_id_guid 752 753 @designator_id_guid.setter 754 def designator_id_guid(self, designator_id_guid): 755 """Sets the designator_id_guid of this Participant. 756 757 # noqa: E501 758 759 :param designator_id_guid: The designator_id_guid of this Participant. # noqa: E501 760 :type: str 761 """ 762 763 self._designator_id_guid = designator_id_guid 764 765 @property 766 def document_visibility(self): 767 """Gets the document_visibility of this Participant. # noqa: E501 768 769 # noqa: E501 770 771 :return: The document_visibility of this Participant. # noqa: E501 772 :rtype: list[DocumentVisibility] 773 """ 774 return self._document_visibility 775 776 @document_visibility.setter 777 def document_visibility(self, document_visibility): 778 """Sets the document_visibility of this Participant. 779 780 # noqa: E501 781 782 :param document_visibility: The document_visibility of this Participant. # noqa: E501 783 :type: list[DocumentVisibility] 784 """ 785 786 self._document_visibility = document_visibility 787 788 @property 789 def email(self): 790 """Gets the email of this Participant. # noqa: E501 791 792 # noqa: E501 793 794 :return: The email of this Participant. # noqa: E501 795 :rtype: str 796 """ 797 return self._email 798 799 @email.setter 800 def email(self, email): 801 """Sets the email of this Participant. 802 803 # noqa: E501 804 805 :param email: The email of this Participant. # noqa: E501 806 :type: str 807 """ 808 809 self._email = email 810 811 @property 812 def email_metadata(self): 813 """Gets the email_metadata of this Participant. # noqa: E501 814 815 # noqa: E501 816 817 :return: The email_metadata of this Participant. # noqa: E501 818 :rtype: PropertyMetadata 819 """ 820 return self._email_metadata 821 822 @email_metadata.setter 823 def email_metadata(self, email_metadata): 824 """Sets the email_metadata of this Participant. 825 826 # noqa: E501 827 828 :param email_metadata: The email_metadata of this Participant. # noqa: E501 829 :type: PropertyMetadata 830 """ 831 832 self._email_metadata = email_metadata 833 834 @property 835 def email_notification(self): 836 """Gets the email_notification of this Participant. # noqa: E501 837 838 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 839 840 :return: The email_notification of this Participant. # noqa: E501 841 :rtype: RecipientEmailNotification 842 """ 843 return self._email_notification 844 845 @email_notification.setter 846 def email_notification(self, email_notification): 847 """Sets the email_notification of this Participant. 848 849 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 850 851 :param email_notification: The email_notification of this Participant. # noqa: E501 852 :type: RecipientEmailNotification 853 """ 854 855 self._email_notification = email_notification 856 857 @property 858 def email_recipient_post_signing_url(self): 859 """Gets the email_recipient_post_signing_url of this Participant. # noqa: E501 860 861 # noqa: E501 862 863 :return: The email_recipient_post_signing_url of this Participant. # noqa: E501 864 :rtype: str 865 """ 866 return self._email_recipient_post_signing_url 867 868 @email_recipient_post_signing_url.setter 869 def email_recipient_post_signing_url(self, email_recipient_post_signing_url): 870 """Sets the email_recipient_post_signing_url of this Participant. 871 872 # noqa: E501 873 874 :param email_recipient_post_signing_url: The email_recipient_post_signing_url of this Participant. # noqa: E501 875 :type: str 876 """ 877 878 self._email_recipient_post_signing_url = email_recipient_post_signing_url 879 880 @property 881 def embedded_recipient_start_url(self): 882 """Gets the embedded_recipient_start_url of this Participant. # noqa: E501 883 884 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 885 886 :return: The embedded_recipient_start_url of this Participant. # noqa: E501 887 :rtype: str 888 """ 889 return self._embedded_recipient_start_url 890 891 @embedded_recipient_start_url.setter 892 def embedded_recipient_start_url(self, embedded_recipient_start_url): 893 """Sets the embedded_recipient_start_url of this Participant. 894 895 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 896 897 :param embedded_recipient_start_url: The embedded_recipient_start_url of this Participant. # noqa: E501 898 :type: str 899 """ 900 901 self._embedded_recipient_start_url = embedded_recipient_start_url 902 903 @property 904 def error_details(self): 905 """Gets the error_details of this Participant. # noqa: E501 906 907 Array or errors. # noqa: E501 908 909 :return: The error_details of this Participant. # noqa: E501 910 :rtype: ErrorDetails 911 """ 912 return self._error_details 913 914 @error_details.setter 915 def error_details(self, error_details): 916 """Sets the error_details of this Participant. 917 918 Array or errors. # noqa: E501 919 920 :param error_details: The error_details of this Participant. # noqa: E501 921 :type: ErrorDetails 922 """ 923 924 self._error_details = error_details 925 926 @property 927 def fax_number(self): 928 """Gets the fax_number of this Participant. # noqa: E501 929 930 Reserved: # noqa: E501 931 932 :return: The fax_number of this Participant. # noqa: E501 933 :rtype: str 934 """ 935 return self._fax_number 936 937 @fax_number.setter 938 def fax_number(self, fax_number): 939 """Sets the fax_number of this Participant. 940 941 Reserved: # noqa: E501 942 943 :param fax_number: The fax_number of this Participant. # noqa: E501 944 :type: str 945 """ 946 947 self._fax_number = fax_number 948 949 @property 950 def fax_number_metadata(self): 951 """Gets the fax_number_metadata of this Participant. # noqa: E501 952 953 # noqa: E501 954 955 :return: The fax_number_metadata of this Participant. # noqa: E501 956 :rtype: PropertyMetadata 957 """ 958 return self._fax_number_metadata 959 960 @fax_number_metadata.setter 961 def fax_number_metadata(self, fax_number_metadata): 962 """Sets the fax_number_metadata of this Participant. 963 964 # noqa: E501 965 966 :param fax_number_metadata: The fax_number_metadata of this Participant. # noqa: E501 967 :type: PropertyMetadata 968 """ 969 970 self._fax_number_metadata = fax_number_metadata 971 972 @property 973 def first_name(self): 974 """Gets the first_name of this Participant. # noqa: E501 975 976 The user's first name. Maximum Length: 50 characters. # noqa: E501 977 978 :return: The first_name of this Participant. # noqa: E501 979 :rtype: str 980 """ 981 return self._first_name 982 983 @first_name.setter 984 def first_name(self, first_name): 985 """Sets the first_name of this Participant. 986 987 The user's first name. Maximum Length: 50 characters. # noqa: E501 988 989 :param first_name: The first_name of this Participant. # noqa: E501 990 :type: str 991 """ 992 993 self._first_name = first_name 994 995 @property 996 def first_name_metadata(self): 997 """Gets the first_name_metadata of this Participant. # noqa: E501 998 999 # noqa: E501 1000 1001 :return: The first_name_metadata of this Participant. # noqa: E501 1002 :rtype: PropertyMetadata 1003 """ 1004 return self._first_name_metadata 1005 1006 @first_name_metadata.setter 1007 def first_name_metadata(self, first_name_metadata): 1008 """Sets the first_name_metadata of this Participant. 1009 1010 # noqa: E501 1011 1012 :param first_name_metadata: The first_name_metadata of this Participant. # noqa: E501 1013 :type: PropertyMetadata 1014 """ 1015 1016 self._first_name_metadata = first_name_metadata 1017 1018 @property 1019 def full_name(self): 1020 """Gets the full_name of this Participant. # noqa: E501 1021 1022 # noqa: E501 1023 1024 :return: The full_name of this Participant. # noqa: E501 1025 :rtype: str 1026 """ 1027 return self._full_name 1028 1029 @full_name.setter 1030 def full_name(self, full_name): 1031 """Sets the full_name of this Participant. 1032 1033 # noqa: E501 1034 1035 :param full_name: The full_name of this Participant. # noqa: E501 1036 :type: str 1037 """ 1038 1039 self._full_name = full_name 1040 1041 @property 1042 def full_name_metadata(self): 1043 """Gets the full_name_metadata of this Participant. # noqa: E501 1044 1045 # noqa: E501 1046 1047 :return: The full_name_metadata of this Participant. # noqa: E501 1048 :rtype: PropertyMetadata 1049 """ 1050 return self._full_name_metadata 1051 1052 @full_name_metadata.setter 1053 def full_name_metadata(self, full_name_metadata): 1054 """Sets the full_name_metadata of this Participant. 1055 1056 # noqa: E501 1057 1058 :param full_name_metadata: The full_name_metadata of this Participant. # noqa: E501 1059 :type: PropertyMetadata 1060 """ 1061 1062 self._full_name_metadata = full_name_metadata 1063 1064 @property 1065 def id_check_configuration_name(self): 1066 """Gets the id_check_configuration_name of this Participant. # noqa: E501 1067 1068 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 1069 1070 :return: The id_check_configuration_name of this Participant. # noqa: E501 1071 :rtype: str 1072 """ 1073 return self._id_check_configuration_name 1074 1075 @id_check_configuration_name.setter 1076 def id_check_configuration_name(self, id_check_configuration_name): 1077 """Sets the id_check_configuration_name of this Participant. 1078 1079 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 1080 1081 :param id_check_configuration_name: The id_check_configuration_name of this Participant. # noqa: E501 1082 :type: str 1083 """ 1084 1085 self._id_check_configuration_name = id_check_configuration_name 1086 1087 @property 1088 def id_check_configuration_name_metadata(self): 1089 """Gets the id_check_configuration_name_metadata of this Participant. # noqa: E501 1090 1091 # noqa: E501 1092 1093 :return: The id_check_configuration_name_metadata of this Participant. # noqa: E501 1094 :rtype: PropertyMetadata 1095 """ 1096 return self._id_check_configuration_name_metadata 1097 1098 @id_check_configuration_name_metadata.setter 1099 def id_check_configuration_name_metadata(self, id_check_configuration_name_metadata): 1100 """Sets the id_check_configuration_name_metadata of this Participant. 1101 1102 # noqa: E501 1103 1104 :param id_check_configuration_name_metadata: The id_check_configuration_name_metadata of this Participant. # noqa: E501 1105 :type: PropertyMetadata 1106 """ 1107 1108 self._id_check_configuration_name_metadata = id_check_configuration_name_metadata 1109 1110 @property 1111 def id_check_information_input(self): 1112 """Gets the id_check_information_input of this Participant. # noqa: E501 1113 1114 # noqa: E501 1115 1116 :return: The id_check_information_input of this Participant. # noqa: E501 1117 :rtype: IdCheckInformationInput 1118 """ 1119 return self._id_check_information_input 1120 1121 @id_check_information_input.setter 1122 def id_check_information_input(self, id_check_information_input): 1123 """Sets the id_check_information_input of this Participant. 1124 1125 # noqa: E501 1126 1127 :param id_check_information_input: The id_check_information_input of this Participant. # noqa: E501 1128 :type: IdCheckInformationInput 1129 """ 1130 1131 self._id_check_information_input = id_check_information_input 1132 1133 @property 1134 def identity_verification(self): 1135 """Gets the identity_verification of this Participant. # noqa: E501 1136 1137 # noqa: E501 1138 1139 :return: The identity_verification of this Participant. # noqa: E501 1140 :rtype: RecipientIdentityVerification 1141 """ 1142 return self._identity_verification 1143 1144 @identity_verification.setter 1145 def identity_verification(self, identity_verification): 1146 """Sets the identity_verification of this Participant. 1147 1148 # noqa: E501 1149 1150 :param identity_verification: The identity_verification of this Participant. # noqa: E501 1151 :type: RecipientIdentityVerification 1152 """ 1153 1154 self._identity_verification = identity_verification 1155 1156 @property 1157 def inherit_email_notification_configuration(self): 1158 """Gets the inherit_email_notification_configuration of this Participant. # noqa: E501 1159 1160 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 1161 1162 :return: The inherit_email_notification_configuration of this Participant. # noqa: E501 1163 :rtype: str 1164 """ 1165 return self._inherit_email_notification_configuration 1166 1167 @inherit_email_notification_configuration.setter 1168 def inherit_email_notification_configuration(self, inherit_email_notification_configuration): 1169 """Sets the inherit_email_notification_configuration of this Participant. 1170 1171 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 1172 1173 :param inherit_email_notification_configuration: The inherit_email_notification_configuration of this Participant. # noqa: E501 1174 :type: str 1175 """ 1176 1177 self._inherit_email_notification_configuration = inherit_email_notification_configuration 1178 1179 @property 1180 def last_name(self): 1181 """Gets the last_name of this Participant. # noqa: E501 1182 1183 # noqa: E501 1184 1185 :return: The last_name of this Participant. # noqa: E501 1186 :rtype: str 1187 """ 1188 return self._last_name 1189 1190 @last_name.setter 1191 def last_name(self, last_name): 1192 """Sets the last_name of this Participant. 1193 1194 # noqa: E501 1195 1196 :param last_name: The last_name of this Participant. # noqa: E501 1197 :type: str 1198 """ 1199 1200 self._last_name = last_name 1201 1202 @property 1203 def last_name_metadata(self): 1204 """Gets the last_name_metadata of this Participant. # noqa: E501 1205 1206 # noqa: E501 1207 1208 :return: The last_name_metadata of this Participant. # noqa: E501 1209 :rtype: PropertyMetadata 1210 """ 1211 return self._last_name_metadata 1212 1213 @last_name_metadata.setter 1214 def last_name_metadata(self, last_name_metadata): 1215 """Sets the last_name_metadata of this Participant. 1216 1217 # noqa: E501 1218 1219 :param last_name_metadata: The last_name_metadata of this Participant. # noqa: E501 1220 :type: PropertyMetadata 1221 """ 1222 1223 self._last_name_metadata = last_name_metadata 1224 1225 @property 1226 def locked_recipient_phone_auth_editable(self): 1227 """Gets the locked_recipient_phone_auth_editable of this Participant. # noqa: E501 1228 1229 # noqa: E501 1230 1231 :return: The locked_recipient_phone_auth_editable of this Participant. # noqa: E501 1232 :rtype: str 1233 """ 1234 return self._locked_recipient_phone_auth_editable 1235 1236 @locked_recipient_phone_auth_editable.setter 1237 def locked_recipient_phone_auth_editable(self, locked_recipient_phone_auth_editable): 1238 """Sets the locked_recipient_phone_auth_editable of this Participant. 1239 1240 # noqa: E501 1241 1242 :param locked_recipient_phone_auth_editable: The locked_recipient_phone_auth_editable of this Participant. # noqa: E501 1243 :type: str 1244 """ 1245 1246 self._locked_recipient_phone_auth_editable = locked_recipient_phone_auth_editable 1247 1248 @property 1249 def locked_recipient_sms_editable(self): 1250 """Gets the locked_recipient_sms_editable of this Participant. # noqa: E501 1251 1252 # noqa: E501 1253 1254 :return: The locked_recipient_sms_editable of this Participant. # noqa: E501 1255 :rtype: str 1256 """ 1257 return self._locked_recipient_sms_editable 1258 1259 @locked_recipient_sms_editable.setter 1260 def locked_recipient_sms_editable(self, locked_recipient_sms_editable): 1261 """Sets the locked_recipient_sms_editable of this Participant. 1262 1263 # noqa: E501 1264 1265 :param locked_recipient_sms_editable: The locked_recipient_sms_editable of this Participant. # noqa: E501 1266 :type: str 1267 """ 1268 1269 self._locked_recipient_sms_editable = locked_recipient_sms_editable 1270 1271 @property 1272 def name(self): 1273 """Gets the name of this Participant. # noqa: E501 1274 1275 # noqa: E501 1276 1277 :return: The name of this Participant. # noqa: E501 1278 :rtype: str 1279 """ 1280 return self._name 1281 1282 @name.setter 1283 def name(self, name): 1284 """Sets the name of this Participant. 1285 1286 # noqa: E501 1287 1288 :param name: The name of this Participant. # noqa: E501 1289 :type: str 1290 """ 1291 1292 self._name = name 1293 1294 @property 1295 def name_metadata(self): 1296 """Gets the name_metadata of this Participant. # noqa: E501 1297 1298 # noqa: E501 1299 1300 :return: The name_metadata of this Participant. # noqa: E501 1301 :rtype: PropertyMetadata 1302 """ 1303 return self._name_metadata 1304 1305 @name_metadata.setter 1306 def name_metadata(self, name_metadata): 1307 """Sets the name_metadata of this Participant. 1308 1309 # noqa: E501 1310 1311 :param name_metadata: The name_metadata of this Participant. # noqa: E501 1312 :type: PropertyMetadata 1313 """ 1314 1315 self._name_metadata = name_metadata 1316 1317 @property 1318 def note(self): 1319 """Gets the note of this Participant. # noqa: E501 1320 1321 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 1322 1323 :return: The note of this Participant. # noqa: E501 1324 :rtype: str 1325 """ 1326 return self._note 1327 1328 @note.setter 1329 def note(self, note): 1330 """Sets the note of this Participant. 1331 1332 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 1333 1334 :param note: The note of this Participant. # noqa: E501 1335 :type: str 1336 """ 1337 1338 self._note = note 1339 1340 @property 1341 def note_metadata(self): 1342 """Gets the note_metadata of this Participant. # noqa: E501 1343 1344 # noqa: E501 1345 1346 :return: The note_metadata of this Participant. # noqa: E501 1347 :rtype: PropertyMetadata 1348 """ 1349 return self._note_metadata 1350 1351 @note_metadata.setter 1352 def note_metadata(self, note_metadata): 1353 """Sets the note_metadata of this Participant. 1354 1355 # noqa: E501 1356 1357 :param note_metadata: The note_metadata of this Participant. # noqa: E501 1358 :type: PropertyMetadata 1359 """ 1360 1361 self._note_metadata = note_metadata 1362 1363 @property 1364 def participate_for(self): 1365 """Gets the participate_for of this Participant. # noqa: E501 1366 1367 # noqa: E501 1368 1369 :return: The participate_for of this Participant. # noqa: E501 1370 :rtype: str 1371 """ 1372 return self._participate_for 1373 1374 @participate_for.setter 1375 def participate_for(self, participate_for): 1376 """Sets the participate_for of this Participant. 1377 1378 # noqa: E501 1379 1380 :param participate_for: The participate_for of this Participant. # noqa: E501 1381 :type: str 1382 """ 1383 1384 self._participate_for = participate_for 1385 1386 @property 1387 def participate_for_guid(self): 1388 """Gets the participate_for_guid of this Participant. # noqa: E501 1389 1390 # noqa: E501 1391 1392 :return: The participate_for_guid of this Participant. # noqa: E501 1393 :rtype: str 1394 """ 1395 return self._participate_for_guid 1396 1397 @participate_for_guid.setter 1398 def participate_for_guid(self, participate_for_guid): 1399 """Sets the participate_for_guid of this Participant. 1400 1401 # noqa: E501 1402 1403 :param participate_for_guid: The participate_for_guid of this Participant. # noqa: E501 1404 :type: str 1405 """ 1406 1407 self._participate_for_guid = participate_for_guid 1408 1409 @property 1410 def phone_authentication(self): 1411 """Gets the phone_authentication of this Participant. # noqa: E501 1412 1413 # noqa: E501 1414 1415 :return: The phone_authentication of this Participant. # noqa: E501 1416 :rtype: RecipientPhoneAuthentication 1417 """ 1418 return self._phone_authentication 1419 1420 @phone_authentication.setter 1421 def phone_authentication(self, phone_authentication): 1422 """Sets the phone_authentication of this Participant. 1423 1424 # noqa: E501 1425 1426 :param phone_authentication: The phone_authentication of this Participant. # noqa: E501 1427 :type: RecipientPhoneAuthentication 1428 """ 1429 1430 self._phone_authentication = phone_authentication 1431 1432 @property 1433 def phone_number(self): 1434 """Gets the phone_number of this Participant. # noqa: E501 1435 1436 # noqa: E501 1437 1438 :return: The phone_number of this Participant. # noqa: E501 1439 :rtype: RecipientPhoneNumber 1440 """ 1441 return self._phone_number 1442 1443 @phone_number.setter 1444 def phone_number(self, phone_number): 1445 """Sets the phone_number of this Participant. 1446 1447 # noqa: E501 1448 1449 :param phone_number: The phone_number of this Participant. # noqa: E501 1450 :type: RecipientPhoneNumber 1451 """ 1452 1453 self._phone_number = phone_number 1454 1455 @property 1456 def recipient_attachments(self): 1457 """Gets the recipient_attachments of this Participant. # noqa: E501 1458 1459 Reserved: # noqa: E501 1460 1461 :return: The recipient_attachments of this Participant. # noqa: E501 1462 :rtype: list[RecipientAttachment] 1463 """ 1464 return self._recipient_attachments 1465 1466 @recipient_attachments.setter 1467 def recipient_attachments(self, recipient_attachments): 1468 """Sets the recipient_attachments of this Participant. 1469 1470 Reserved: # noqa: E501 1471 1472 :param recipient_attachments: The recipient_attachments of this Participant. # noqa: E501 1473 :type: list[RecipientAttachment] 1474 """ 1475 1476 self._recipient_attachments = recipient_attachments 1477 1478 @property 1479 def recipient_authentication_status(self): 1480 """Gets the recipient_authentication_status of this Participant. # noqa: E501 1481 1482 # noqa: E501 1483 1484 :return: The recipient_authentication_status of this Participant. # noqa: E501 1485 :rtype: AuthenticationStatus 1486 """ 1487 return self._recipient_authentication_status 1488 1489 @recipient_authentication_status.setter 1490 def recipient_authentication_status(self, recipient_authentication_status): 1491 """Sets the recipient_authentication_status of this Participant. 1492 1493 # noqa: E501 1494 1495 :param recipient_authentication_status: The recipient_authentication_status of this Participant. # noqa: E501 1496 :type: AuthenticationStatus 1497 """ 1498 1499 self._recipient_authentication_status = recipient_authentication_status 1500 1501 @property 1502 def recipient_feature_metadata(self): 1503 """Gets the recipient_feature_metadata of this Participant. # noqa: E501 1504 1505 # noqa: E501 1506 1507 :return: The recipient_feature_metadata of this Participant. # noqa: E501 1508 :rtype: list[FeatureAvailableMetadata] 1509 """ 1510 return self._recipient_feature_metadata 1511 1512 @recipient_feature_metadata.setter 1513 def recipient_feature_metadata(self, recipient_feature_metadata): 1514 """Sets the recipient_feature_metadata of this Participant. 1515 1516 # noqa: E501 1517 1518 :param recipient_feature_metadata: The recipient_feature_metadata of this Participant. # noqa: E501 1519 :type: list[FeatureAvailableMetadata] 1520 """ 1521 1522 self._recipient_feature_metadata = recipient_feature_metadata 1523 1524 @property 1525 def recipient_id(self): 1526 """Gets the recipient_id of this Participant. # noqa: E501 1527 1528 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1529 1530 :return: The recipient_id of this Participant. # noqa: E501 1531 :rtype: str 1532 """ 1533 return self._recipient_id 1534 1535 @recipient_id.setter 1536 def recipient_id(self, recipient_id): 1537 """Sets the recipient_id of this Participant. 1538 1539 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1540 1541 :param recipient_id: The recipient_id of this Participant. # noqa: E501 1542 :type: str 1543 """ 1544 1545 self._recipient_id = recipient_id 1546 1547 @property 1548 def recipient_id_guid(self): 1549 """Gets the recipient_id_guid of this Participant. # noqa: E501 1550 1551 # noqa: E501 1552 1553 :return: The recipient_id_guid of this Participant. # noqa: E501 1554 :rtype: str 1555 """ 1556 return self._recipient_id_guid 1557 1558 @recipient_id_guid.setter 1559 def recipient_id_guid(self, recipient_id_guid): 1560 """Sets the recipient_id_guid of this Participant. 1561 1562 # noqa: E501 1563 1564 :param recipient_id_guid: The recipient_id_guid of this Participant. # noqa: E501 1565 :type: str 1566 """ 1567 1568 self._recipient_id_guid = recipient_id_guid 1569 1570 @property 1571 def recipient_type(self): 1572 """Gets the recipient_type of this Participant. # noqa: E501 1573 1574 # noqa: E501 1575 1576 :return: The recipient_type of this Participant. # noqa: E501 1577 :rtype: str 1578 """ 1579 return self._recipient_type 1580 1581 @recipient_type.setter 1582 def recipient_type(self, recipient_type): 1583 """Sets the recipient_type of this Participant. 1584 1585 # noqa: E501 1586 1587 :param recipient_type: The recipient_type of this Participant. # noqa: E501 1588 :type: str 1589 """ 1590 1591 self._recipient_type = recipient_type 1592 1593 @property 1594 def recipient_type_metadata(self): 1595 """Gets the recipient_type_metadata of this Participant. # noqa: E501 1596 1597 # noqa: E501 1598 1599 :return: The recipient_type_metadata of this Participant. # noqa: E501 1600 :rtype: PropertyMetadata 1601 """ 1602 return self._recipient_type_metadata 1603 1604 @recipient_type_metadata.setter 1605 def recipient_type_metadata(self, recipient_type_metadata): 1606 """Sets the recipient_type_metadata of this Participant. 1607 1608 # noqa: E501 1609 1610 :param recipient_type_metadata: The recipient_type_metadata of this Participant. # noqa: E501 1611 :type: PropertyMetadata 1612 """ 1613 1614 self._recipient_type_metadata = recipient_type_metadata 1615 1616 @property 1617 def require_id_lookup(self): 1618 """Gets the require_id_lookup of this Participant. # noqa: E501 1619 1620 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 1621 1622 :return: The require_id_lookup of this Participant. # noqa: E501 1623 :rtype: str 1624 """ 1625 return self._require_id_lookup 1626 1627 @require_id_lookup.setter 1628 def require_id_lookup(self, require_id_lookup): 1629 """Sets the require_id_lookup of this Participant. 1630 1631 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 1632 1633 :param require_id_lookup: The require_id_lookup of this Participant. # noqa: E501 1634 :type: str 1635 """ 1636 1637 self._require_id_lookup = require_id_lookup 1638 1639 @property 1640 def require_id_lookup_metadata(self): 1641 """Gets the require_id_lookup_metadata of this Participant. # noqa: E501 1642 1643 # noqa: E501 1644 1645 :return: The require_id_lookup_metadata of this Participant. # noqa: E501 1646 :rtype: PropertyMetadata 1647 """ 1648 return self._require_id_lookup_metadata 1649 1650 @require_id_lookup_metadata.setter 1651 def require_id_lookup_metadata(self, require_id_lookup_metadata): 1652 """Sets the require_id_lookup_metadata of this Participant. 1653 1654 # noqa: E501 1655 1656 :param require_id_lookup_metadata: The require_id_lookup_metadata of this Participant. # noqa: E501 1657 :type: PropertyMetadata 1658 """ 1659 1660 self._require_id_lookup_metadata = require_id_lookup_metadata 1661 1662 @property 1663 def role_name(self): 1664 """Gets the role_name of this Participant. # noqa: E501 1665 1666 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1667 1668 :return: The role_name of this Participant. # noqa: E501 1669 :rtype: str 1670 """ 1671 return self._role_name 1672 1673 @role_name.setter 1674 def role_name(self, role_name): 1675 """Sets the role_name of this Participant. 1676 1677 Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients. # noqa: E501 1678 1679 :param role_name: The role_name of this Participant. # noqa: E501 1680 :type: str 1681 """ 1682 1683 self._role_name = role_name 1684 1685 @property 1686 def routing_order(self): 1687 """Gets the routing_order of this Participant. # noqa: E501 1688 1689 Specifies the routing order of the recipient in the envelope. # noqa: E501 1690 1691 :return: The routing_order of this Participant. # noqa: E501 1692 :rtype: str 1693 """ 1694 return self._routing_order 1695 1696 @routing_order.setter 1697 def routing_order(self, routing_order): 1698 """Sets the routing_order of this Participant. 1699 1700 Specifies the routing order of the recipient in the envelope. # noqa: E501 1701 1702 :param routing_order: The routing_order of this Participant. # noqa: E501 1703 :type: str 1704 """ 1705 1706 self._routing_order = routing_order 1707 1708 @property 1709 def routing_order_metadata(self): 1710 """Gets the routing_order_metadata of this Participant. # noqa: E501 1711 1712 # noqa: E501 1713 1714 :return: The routing_order_metadata of this Participant. # noqa: E501 1715 :rtype: PropertyMetadata 1716 """ 1717 return self._routing_order_metadata 1718 1719 @routing_order_metadata.setter 1720 def routing_order_metadata(self, routing_order_metadata): 1721 """Sets the routing_order_metadata of this Participant. 1722 1723 # noqa: E501 1724 1725 :param routing_order_metadata: The routing_order_metadata of this Participant. # noqa: E501 1726 :type: PropertyMetadata 1727 """ 1728 1729 self._routing_order_metadata = routing_order_metadata 1730 1731 @property 1732 def sent_date_time(self): 1733 """Gets the sent_date_time of this Participant. # noqa: E501 1734 1735 The date and time the envelope was sent. # noqa: E501 1736 1737 :return: The sent_date_time of this Participant. # noqa: E501 1738 :rtype: str 1739 """ 1740 return self._sent_date_time 1741 1742 @sent_date_time.setter 1743 def sent_date_time(self, sent_date_time): 1744 """Sets the sent_date_time of this Participant. 1745 1746 The date and time the envelope was sent. # noqa: E501 1747 1748 :param sent_date_time: The sent_date_time of this Participant. # noqa: E501 1749 :type: str 1750 """ 1751 1752 self._sent_date_time = sent_date_time 1753 1754 @property 1755 def signed_date_time(self): 1756 """Gets the signed_date_time of this Participant. # noqa: E501 1757 1758 Reserved: For DocuSign use only. # noqa: E501 1759 1760 :return: The signed_date_time of this Participant. # noqa: E501 1761 :rtype: str 1762 """ 1763 return self._signed_date_time 1764 1765 @signed_date_time.setter 1766 def signed_date_time(self, signed_date_time): 1767 """Sets the signed_date_time of this Participant. 1768 1769 Reserved: For DocuSign use only. # noqa: E501 1770 1771 :param signed_date_time: The signed_date_time of this Participant. # noqa: E501 1772 :type: str 1773 """ 1774 1775 self._signed_date_time = signed_date_time 1776 1777 @property 1778 def signing_group_id(self): 1779 """Gets the signing_group_id of this Participant. # noqa: E501 1780 1781 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 1782 1783 :return: The signing_group_id of this Participant. # noqa: E501 1784 :rtype: str 1785 """ 1786 return self._signing_group_id 1787 1788 @signing_group_id.setter 1789 def signing_group_id(self, signing_group_id): 1790 """Sets the signing_group_id of this Participant. 1791 1792 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 1793 1794 :param signing_group_id: The signing_group_id of this Participant. # noqa: E501 1795 :type: str 1796 """ 1797 1798 self._signing_group_id = signing_group_id 1799 1800 @property 1801 def signing_group_id_metadata(self): 1802 """Gets the signing_group_id_metadata of this Participant. # noqa: E501 1803 1804 # noqa: E501 1805 1806 :return: The signing_group_id_metadata of this Participant. # noqa: E501 1807 :rtype: PropertyMetadata 1808 """ 1809 return self._signing_group_id_metadata 1810 1811 @signing_group_id_metadata.setter 1812 def signing_group_id_metadata(self, signing_group_id_metadata): 1813 """Sets the signing_group_id_metadata of this Participant. 1814 1815 # noqa: E501 1816 1817 :param signing_group_id_metadata: The signing_group_id_metadata of this Participant. # noqa: E501 1818 :type: PropertyMetadata 1819 """ 1820 1821 self._signing_group_id_metadata = signing_group_id_metadata 1822 1823 @property 1824 def signing_group_name(self): 1825 """Gets the signing_group_name of this Participant. # noqa: E501 1826 1827 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1828 1829 :return: The signing_group_name of this Participant. # noqa: E501 1830 :rtype: str 1831 """ 1832 return self._signing_group_name 1833 1834 @signing_group_name.setter 1835 def signing_group_name(self, signing_group_name): 1836 """Sets the signing_group_name of this Participant. 1837 1838 The display name for the signing group. Maximum Length: 100 characters. # noqa: E501 1839 1840 :param signing_group_name: The signing_group_name of this Participant. # noqa: E501 1841 :type: str 1842 """ 1843 1844 self._signing_group_name = signing_group_name 1845 1846 @property 1847 def signing_group_users(self): 1848 """Gets the signing_group_users of this Participant. # noqa: E501 1849 1850 A complex type that contains information about users in the signing group. # noqa: E501 1851 1852 :return: The signing_group_users of this Participant. # noqa: E501 1853 :rtype: list[UserInfo] 1854 """ 1855 return self._signing_group_users 1856 1857 @signing_group_users.setter 1858 def signing_group_users(self, signing_group_users): 1859 """Sets the signing_group_users of this Participant. 1860 1861 A complex type that contains information about users in the signing group. # noqa: E501 1862 1863 :param signing_group_users: The signing_group_users of this Participant. # noqa: E501 1864 :type: list[UserInfo] 1865 """ 1866 1867 self._signing_group_users = signing_group_users 1868 1869 @property 1870 def sms_authentication(self): 1871 """Gets the sms_authentication of this Participant. # noqa: E501 1872 1873 # noqa: E501 1874 1875 :return: The sms_authentication of this Participant. # noqa: E501 1876 :rtype: RecipientSMSAuthentication 1877 """ 1878 return self._sms_authentication 1879 1880 @sms_authentication.setter 1881 def sms_authentication(self, sms_authentication): 1882 """Sets the sms_authentication of this Participant. 1883 1884 # noqa: E501 1885 1886 :param sms_authentication: The sms_authentication of this Participant. # noqa: E501 1887 :type: RecipientSMSAuthentication 1888 """ 1889 1890 self._sms_authentication = sms_authentication 1891 1892 @property 1893 def social_authentications(self): 1894 """Gets the social_authentications of this Participant. # noqa: E501 1895 1896 Lists the social ID type that can be used for recipient authentication. # noqa: E501 1897 1898 :return: The social_authentications of this Participant. # noqa: E501 1899 :rtype: list[SocialAuthentication] 1900 """ 1901 return self._social_authentications 1902 1903 @social_authentications.setter 1904 def social_authentications(self, social_authentications): 1905 """Sets the social_authentications of this Participant. 1906 1907 Lists the social ID type that can be used for recipient authentication. # noqa: E501 1908 1909 :param social_authentications: The social_authentications of this Participant. # noqa: E501 1910 :type: list[SocialAuthentication] 1911 """ 1912 1913 self._social_authentications = social_authentications 1914 1915 @property 1916 def status(self): 1917 """Gets the status of this Participant. # noqa: E501 1918 1919 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 1920 1921 :return: The status of this Participant. # noqa: E501 1922 :rtype: str 1923 """ 1924 return self._status 1925 1926 @status.setter 1927 def status(self, status): 1928 """Sets the status of this Participant. 1929 1930 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 1931 1932 :param status: The status of this Participant. # noqa: E501 1933 :type: str 1934 """ 1935 1936 self._status = status 1937 1938 @property 1939 def status_code(self): 1940 """Gets the status_code of this Participant. # noqa: E501 1941 1942 # noqa: E501 1943 1944 :return: The status_code of this Participant. # noqa: E501 1945 :rtype: str 1946 """ 1947 return self._status_code 1948 1949 @status_code.setter 1950 def status_code(self, status_code): 1951 """Sets the status_code of this Participant. 1952 1953 # noqa: E501 1954 1955 :param status_code: The status_code of this Participant. # noqa: E501 1956 :type: str 1957 """ 1958 1959 self._status_code = status_code 1960 1961 @property 1962 def suppress_emails(self): 1963 """Gets the suppress_emails of this Participant. # noqa: E501 1964 1965 # noqa: E501 1966 1967 :return: The suppress_emails of this Participant. # noqa: E501 1968 :rtype: str 1969 """ 1970 return self._suppress_emails 1971 1972 @suppress_emails.setter 1973 def suppress_emails(self, suppress_emails): 1974 """Sets the suppress_emails of this Participant. 1975 1976 # noqa: E501 1977 1978 :param suppress_emails: The suppress_emails of this Participant. # noqa: E501 1979 :type: str 1980 """ 1981 1982 self._suppress_emails = suppress_emails 1983 1984 @property 1985 def template_locked(self): 1986 """Gets the template_locked of this Participant. # noqa: E501 1987 1988 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 1989 1990 :return: The template_locked of this Participant. # noqa: E501 1991 :rtype: str 1992 """ 1993 return self._template_locked 1994 1995 @template_locked.setter 1996 def template_locked(self, template_locked): 1997 """Sets the template_locked of this Participant. 1998 1999 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2000 2001 :param template_locked: The template_locked of this Participant. # noqa: E501 2002 :type: str 2003 """ 2004 2005 self._template_locked = template_locked 2006 2007 @property 2008 def template_required(self): 2009 """Gets the template_required of this Participant. # noqa: E501 2010 2011 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2012 2013 :return: The template_required of this Participant. # noqa: E501 2014 :rtype: str 2015 """ 2016 return self._template_required 2017 2018 @template_required.setter 2019 def template_required(self, template_required): 2020 """Sets the template_required of this Participant. 2021 2022 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2023 2024 :param template_required: The template_required of this Participant. # noqa: E501 2025 :type: str 2026 """ 2027 2028 self._template_required = template_required 2029 2030 @property 2031 def total_tab_count(self): 2032 """Gets the total_tab_count of this Participant. # noqa: E501 2033 2034 # noqa: E501 2035 2036 :return: The total_tab_count of this Participant. # noqa: E501 2037 :rtype: str 2038 """ 2039 return self._total_tab_count 2040 2041 @total_tab_count.setter 2042 def total_tab_count(self, total_tab_count): 2043 """Sets the total_tab_count of this Participant. 2044 2045 # noqa: E501 2046 2047 :param total_tab_count: The total_tab_count of this Participant. # noqa: E501 2048 :type: str 2049 """ 2050 2051 self._total_tab_count = total_tab_count 2052 2053 @property 2054 def user_id(self): 2055 """Gets the user_id of this Participant. # noqa: E501 2056 2057 # noqa: E501 2058 2059 :return: The user_id of this Participant. # noqa: E501 2060 :rtype: str 2061 """ 2062 return self._user_id 2063 2064 @user_id.setter 2065 def user_id(self, user_id): 2066 """Sets the user_id of this Participant. 2067 2068 # noqa: E501 2069 2070 :param user_id: The user_id of this Participant. # noqa: E501 2071 :type: str 2072 """ 2073 2074 self._user_id = user_id 2075 2076 def to_dict(self): 2077 """Returns the model properties as a dict""" 2078 result = {} 2079 2080 for attr, _ in six.iteritems(self.swagger_types): 2081 value = getattr(self, attr) 2082 if isinstance(value, list): 2083 result[attr] = list(map( 2084 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2085 value 2086 )) 2087 elif hasattr(value, "to_dict"): 2088 result[attr] = value.to_dict() 2089 elif isinstance(value, dict): 2090 result[attr] = dict(map( 2091 lambda item: (item[0], item[1].to_dict()) 2092 if hasattr(item[1], "to_dict") else item, 2093 value.items() 2094 )) 2095 else: 2096 result[attr] = value 2097 if issubclass(Participant, dict): 2098 for key, value in self.items(): 2099 result[key] = value 2100 2101 return result 2102 2103 def to_str(self): 2104 """Returns the string representation of the model""" 2105 return pprint.pformat(self.to_dict()) 2106 2107 def __repr__(self): 2108 """For `print` and `pprint`""" 2109 return self.to_str() 2110 2111 def __eq__(self, other): 2112 """Returns true if both objects are equal""" 2113 if not isinstance(other, Participant): 2114 return False 2115 2116 return self.to_dict() == other.to_dict() 2117 2118 def __ne__(self, other): 2119 """Returns true if both objects are not equal""" 2120 if not isinstance(other, Participant): 2121 return True 2122 2123 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.
Participant(_configuration=None, **kwargs)
192 def __init__(self, _configuration=None, **kwargs): # noqa: E501 193 """Participant - a model defined in Swagger""" # noqa: E501 194 if _configuration is None: 195 _configuration = Configuration() 196 self._configuration = _configuration 197 198 self._access_code = None 199 self._access_code_metadata = None 200 self._add_access_code_to_email = None 201 self._additional_notifications = None 202 self._allow_system_override_for_locked_recipient = None 203 self._auto_responded_reason = None 204 self._bulk_send_v2_recipient = None 205 self._client_user_id = None 206 self._completed_count = None 207 self._consent_details_list = None 208 self._custom_fields = None 209 self._declined_date_time = None 210 self._declined_reason = None 211 self._delivered_date_time = None 212 self._delivery_method = None 213 self._delivery_method_metadata = None 214 self._designator_id = None 215 self._designator_id_guid = None 216 self._document_visibility = None 217 self._email = None 218 self._email_metadata = None 219 self._email_notification = None 220 self._email_recipient_post_signing_url = None 221 self._embedded_recipient_start_url = None 222 self._error_details = None 223 self._fax_number = None 224 self._fax_number_metadata = None 225 self._first_name = None 226 self._first_name_metadata = None 227 self._full_name = None 228 self._full_name_metadata = None 229 self._id_check_configuration_name = None 230 self._id_check_configuration_name_metadata = None 231 self._id_check_information_input = None 232 self._identity_verification = None 233 self._inherit_email_notification_configuration = None 234 self._last_name = None 235 self._last_name_metadata = None 236 self._locked_recipient_phone_auth_editable = None 237 self._locked_recipient_sms_editable = None 238 self._name = None 239 self._name_metadata = None 240 self._note = None 241 self._note_metadata = None 242 self._participate_for = None 243 self._participate_for_guid = None 244 self._phone_authentication = None 245 self._phone_number = None 246 self._recipient_attachments = None 247 self._recipient_authentication_status = None 248 self._recipient_feature_metadata = None 249 self._recipient_id = None 250 self._recipient_id_guid = None 251 self._recipient_type = None 252 self._recipient_type_metadata = None 253 self._require_id_lookup = None 254 self._require_id_lookup_metadata = None 255 self._role_name = None 256 self._routing_order = None 257 self._routing_order_metadata = None 258 self._sent_date_time = None 259 self._signed_date_time = None 260 self._signing_group_id = None 261 self._signing_group_id_metadata = None 262 self._signing_group_name = None 263 self._signing_group_users = None 264 self._sms_authentication = None 265 self._social_authentications = None 266 self._status = None 267 self._status_code = None 268 self._suppress_emails = None 269 self._template_locked = None 270 self._template_required = None 271 self._total_tab_count = None 272 self._user_id = None 273 self.discriminator = None 274 275 setattr(self, "_{}".format('access_code'), kwargs.get('access_code', None)) 276 setattr(self, "_{}".format('access_code_metadata'), kwargs.get('access_code_metadata', None)) 277 setattr(self, "_{}".format('add_access_code_to_email'), kwargs.get('add_access_code_to_email', None)) 278 setattr(self, "_{}".format('additional_notifications'), kwargs.get('additional_notifications', None)) 279 setattr(self, "_{}".format('allow_system_override_for_locked_recipient'), kwargs.get('allow_system_override_for_locked_recipient', None)) 280 setattr(self, "_{}".format('auto_responded_reason'), kwargs.get('auto_responded_reason', None)) 281 setattr(self, "_{}".format('bulk_send_v2_recipient'), kwargs.get('bulk_send_v2_recipient', None)) 282 setattr(self, "_{}".format('client_user_id'), kwargs.get('client_user_id', None)) 283 setattr(self, "_{}".format('completed_count'), kwargs.get('completed_count', None)) 284 setattr(self, "_{}".format('consent_details_list'), kwargs.get('consent_details_list', None)) 285 setattr(self, "_{}".format('custom_fields'), kwargs.get('custom_fields', None)) 286 setattr(self, "_{}".format('declined_date_time'), kwargs.get('declined_date_time', None)) 287 setattr(self, "_{}".format('declined_reason'), kwargs.get('declined_reason', None)) 288 setattr(self, "_{}".format('delivered_date_time'), kwargs.get('delivered_date_time', None)) 289 setattr(self, "_{}".format('delivery_method'), kwargs.get('delivery_method', None)) 290 setattr(self, "_{}".format('delivery_method_metadata'), kwargs.get('delivery_method_metadata', None)) 291 setattr(self, "_{}".format('designator_id'), kwargs.get('designator_id', None)) 292 setattr(self, "_{}".format('designator_id_guid'), kwargs.get('designator_id_guid', None)) 293 setattr(self, "_{}".format('document_visibility'), kwargs.get('document_visibility', None)) 294 setattr(self, "_{}".format('email'), kwargs.get('email', None)) 295 setattr(self, "_{}".format('email_metadata'), kwargs.get('email_metadata', None)) 296 setattr(self, "_{}".format('email_notification'), kwargs.get('email_notification', None)) 297 setattr(self, "_{}".format('email_recipient_post_signing_url'), kwargs.get('email_recipient_post_signing_url', None)) 298 setattr(self, "_{}".format('embedded_recipient_start_url'), kwargs.get('embedded_recipient_start_url', None)) 299 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 300 setattr(self, "_{}".format('fax_number'), kwargs.get('fax_number', None)) 301 setattr(self, "_{}".format('fax_number_metadata'), kwargs.get('fax_number_metadata', None)) 302 setattr(self, "_{}".format('first_name'), kwargs.get('first_name', None)) 303 setattr(self, "_{}".format('first_name_metadata'), kwargs.get('first_name_metadata', None)) 304 setattr(self, "_{}".format('full_name'), kwargs.get('full_name', None)) 305 setattr(self, "_{}".format('full_name_metadata'), kwargs.get('full_name_metadata', None)) 306 setattr(self, "_{}".format('id_check_configuration_name'), kwargs.get('id_check_configuration_name', None)) 307 setattr(self, "_{}".format('id_check_configuration_name_metadata'), kwargs.get('id_check_configuration_name_metadata', None)) 308 setattr(self, "_{}".format('id_check_information_input'), kwargs.get('id_check_information_input', None)) 309 setattr(self, "_{}".format('identity_verification'), kwargs.get('identity_verification', None)) 310 setattr(self, "_{}".format('inherit_email_notification_configuration'), kwargs.get('inherit_email_notification_configuration', None)) 311 setattr(self, "_{}".format('last_name'), kwargs.get('last_name', None)) 312 setattr(self, "_{}".format('last_name_metadata'), kwargs.get('last_name_metadata', None)) 313 setattr(self, "_{}".format('locked_recipient_phone_auth_editable'), kwargs.get('locked_recipient_phone_auth_editable', None)) 314 setattr(self, "_{}".format('locked_recipient_sms_editable'), kwargs.get('locked_recipient_sms_editable', None)) 315 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 316 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 317 setattr(self, "_{}".format('note'), kwargs.get('note', None)) 318 setattr(self, "_{}".format('note_metadata'), kwargs.get('note_metadata', None)) 319 setattr(self, "_{}".format('participate_for'), kwargs.get('participate_for', None)) 320 setattr(self, "_{}".format('participate_for_guid'), kwargs.get('participate_for_guid', None)) 321 setattr(self, "_{}".format('phone_authentication'), kwargs.get('phone_authentication', None)) 322 setattr(self, "_{}".format('phone_number'), kwargs.get('phone_number', None)) 323 setattr(self, "_{}".format('recipient_attachments'), kwargs.get('recipient_attachments', None)) 324 setattr(self, "_{}".format('recipient_authentication_status'), kwargs.get('recipient_authentication_status', None)) 325 setattr(self, "_{}".format('recipient_feature_metadata'), kwargs.get('recipient_feature_metadata', None)) 326 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 327 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 328 setattr(self, "_{}".format('recipient_type'), kwargs.get('recipient_type', None)) 329 setattr(self, "_{}".format('recipient_type_metadata'), kwargs.get('recipient_type_metadata', None)) 330 setattr(self, "_{}".format('require_id_lookup'), kwargs.get('require_id_lookup', None)) 331 setattr(self, "_{}".format('require_id_lookup_metadata'), kwargs.get('require_id_lookup_metadata', None)) 332 setattr(self, "_{}".format('role_name'), kwargs.get('role_name', None)) 333 setattr(self, "_{}".format('routing_order'), kwargs.get('routing_order', None)) 334 setattr(self, "_{}".format('routing_order_metadata'), kwargs.get('routing_order_metadata', None)) 335 setattr(self, "_{}".format('sent_date_time'), kwargs.get('sent_date_time', None)) 336 setattr(self, "_{}".format('signed_date_time'), kwargs.get('signed_date_time', None)) 337 setattr(self, "_{}".format('signing_group_id'), kwargs.get('signing_group_id', None)) 338 setattr(self, "_{}".format('signing_group_id_metadata'), kwargs.get('signing_group_id_metadata', None)) 339 setattr(self, "_{}".format('signing_group_name'), kwargs.get('signing_group_name', None)) 340 setattr(self, "_{}".format('signing_group_users'), kwargs.get('signing_group_users', None)) 341 setattr(self, "_{}".format('sms_authentication'), kwargs.get('sms_authentication', None)) 342 setattr(self, "_{}".format('social_authentications'), kwargs.get('social_authentications', None)) 343 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 344 setattr(self, "_{}".format('status_code'), kwargs.get('status_code', None)) 345 setattr(self, "_{}".format('suppress_emails'), kwargs.get('suppress_emails', None)) 346 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 347 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 348 setattr(self, "_{}".format('total_tab_count'), kwargs.get('total_tab_count', None)) 349 setattr(self, "_{}".format('user_id'), kwargs.get('user_id', None))
Participant - a model defined in Swagger
swagger_types = {'access_code': 'str', 'access_code_metadata': 'PropertyMetadata', 'add_access_code_to_email': 'str', 'additional_notifications': 'list[RecipientAdditionalNotification]', 'allow_system_override_for_locked_recipient': 'str', 'auto_responded_reason': 'str', 'bulk_send_v2_recipient': 'str', 'client_user_id': 'str', 'completed_count': 'str', 'consent_details_list': 'list[ConsentDetails]', 'custom_fields': 'list[str]', 'declined_date_time': 'str', 'declined_reason': 'str', 'delivered_date_time': 'str', 'delivery_method': 'str', 'delivery_method_metadata': 'PropertyMetadata', 'designator_id': 'str', 'designator_id_guid': 'str', 'document_visibility': 'list[DocumentVisibility]', 'email': 'str', 'email_metadata': 'PropertyMetadata', 'email_notification': 'RecipientEmailNotification', 'email_recipient_post_signing_url': 'str', 'embedded_recipient_start_url': 'str', 'error_details': 'ErrorDetails', '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', 'last_name': 'str', 'last_name_metadata': 'PropertyMetadata', 'locked_recipient_phone_auth_editable': 'str', 'locked_recipient_sms_editable': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', 'note': 'str', 'note_metadata': 'PropertyMetadata', 'participate_for': 'str', 'participate_for_guid': 'str', 'phone_authentication': 'RecipientPhoneAuthentication', 'phone_number': 'RecipientPhoneNumber', 'recipient_attachments': 'list[RecipientAttachment]', 'recipient_authentication_status': 'AuthenticationStatus', 'recipient_feature_metadata': 'list[FeatureAvailableMetadata]', 'recipient_id': 'str', 'recipient_id_guid': 'str', 'recipient_type': 'str', 'recipient_type_metadata': 'PropertyMetadata', 'require_id_lookup': 'str', 'require_id_lookup_metadata': 'PropertyMetadata', 'role_name': 'str', 'routing_order': 'str', 'routing_order_metadata': 'PropertyMetadata', 'sent_date_time': 'str', 'signed_date_time': 'str', 'signing_group_id': 'str', 'signing_group_id_metadata': 'PropertyMetadata', 'signing_group_name': 'str', 'signing_group_users': 'list[UserInfo]', 'sms_authentication': 'RecipientSMSAuthentication', 'social_authentications': 'list[SocialAuthentication]', 'status': 'str', 'status_code': 'str', 'suppress_emails': 'str', 'template_locked': 'str', 'template_required': 'str', 'total_tab_count': 'str', 'user_id': 'str'}
attribute_map = {'access_code': 'accessCode', 'access_code_metadata': 'accessCodeMetadata', 'add_access_code_to_email': 'addAccessCodeToEmail', 'additional_notifications': 'additionalNotifications', 'allow_system_override_for_locked_recipient': 'allowSystemOverrideForLockedRecipient', 'auto_responded_reason': 'autoRespondedReason', 'bulk_send_v2_recipient': 'bulkSendV2Recipient', 'client_user_id': 'clientUserId', 'completed_count': 'completedCount', 'consent_details_list': 'consentDetailsList', 'custom_fields': 'customFields', 'declined_date_time': 'declinedDateTime', 'declined_reason': 'declinedReason', 'delivered_date_time': 'deliveredDateTime', 'delivery_method': 'deliveryMethod', 'delivery_method_metadata': 'deliveryMethodMetadata', 'designator_id': 'designatorId', 'designator_id_guid': 'designatorIdGuid', 'document_visibility': 'documentVisibility', 'email': 'email', 'email_metadata': 'emailMetadata', 'email_notification': 'emailNotification', 'email_recipient_post_signing_url': 'emailRecipientPostSigningURL', 'embedded_recipient_start_url': 'embeddedRecipientStartURL', 'error_details': 'errorDetails', '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', 'last_name': 'lastName', 'last_name_metadata': 'lastNameMetadata', 'locked_recipient_phone_auth_editable': 'lockedRecipientPhoneAuthEditable', 'locked_recipient_sms_editable': 'lockedRecipientSmsEditable', 'name': 'name', 'name_metadata': 'nameMetadata', 'note': 'note', 'note_metadata': 'noteMetadata', 'participate_for': 'participateFor', 'participate_for_guid': 'participateForGuid', 'phone_authentication': 'phoneAuthentication', 'phone_number': 'phoneNumber', 'recipient_attachments': 'recipientAttachments', 'recipient_authentication_status': 'recipientAuthenticationStatus', 'recipient_feature_metadata': 'recipientFeatureMetadata', 'recipient_id': 'recipientId', 'recipient_id_guid': 'recipientIdGuid', 'recipient_type': 'recipientType', 'recipient_type_metadata': 'recipientTypeMetadata', 'require_id_lookup': 'requireIdLookup', 'require_id_lookup_metadata': 'requireIdLookupMetadata', 'role_name': 'roleName', 'routing_order': 'routingOrder', 'routing_order_metadata': 'routingOrderMetadata', 'sent_date_time': 'sentDateTime', 'signed_date_time': 'signedDateTime', 'signing_group_id': 'signingGroupId', 'signing_group_id_metadata': 'signingGroupIdMetadata', 'signing_group_name': 'signingGroupName', 'signing_group_users': 'signingGroupUsers', 'sms_authentication': 'smsAuthentication', 'social_authentications': 'socialAuthentications', 'status': 'status', 'status_code': 'statusCode', 'suppress_emails': 'suppressEmails', 'template_locked': 'templateLocked', 'template_required': 'templateRequired', 'total_tab_count': 'totalTabCount', 'user_id': 'userId'}
access_code
Gets the access_code of this Participant. # 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 Participant. # noqa: E501
access_code_metadata
Gets the access_code_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The access_code_metadata of this Participant. # noqa: E501
add_access_code_to_email
Gets the add_access_code_to_email of this Participant. # 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 Participant. # noqa: E501
additional_notifications
Gets the additional_notifications of this Participant. # noqa: E501
# noqa: E501
Returns
The additional_notifications of this Participant. # noqa: E501
allow_system_override_for_locked_recipient
Gets the allow_system_override_for_locked_recipient of this Participant. # noqa: E501
# noqa: E501
Returns
The allow_system_override_for_locked_recipient of this Participant. # noqa: E501
auto_responded_reason
Gets the auto_responded_reason of this Participant. # noqa: E501
# noqa: E501
Returns
The auto_responded_reason of this Participant. # noqa: E501
bulk_send_v2_recipient
Gets the bulk_send_v2_recipient of this Participant. # noqa: E501
# noqa: E501
Returns
The bulk_send_v2_recipient of this Participant. # noqa: E501
client_user_id
Gets the client_user_id of this Participant. # 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 Participant. # noqa: E501
completed_count
Gets the completed_count of this Participant. # noqa: E501
# noqa: E501
Returns
The completed_count of this Participant. # noqa: E501
consent_details_list
Gets the consent_details_list of this Participant. # noqa: E501
# noqa: E501
Returns
The consent_details_list of this Participant. # noqa: E501
custom_fields
Gets the custom_fields of this Participant. # 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 Participant. # noqa: E501
declined_date_time
Gets the declined_date_time of this Participant. # noqa: E501
The date and time the recipient declined the document. # noqa: E501
Returns
The declined_date_time of this Participant. # noqa: E501
declined_reason
Gets the declined_reason of this Participant. # noqa: E501
The reason the recipient declined the document. # noqa: E501
Returns
The declined_reason of this Participant. # noqa: E501
delivered_date_time
Gets the delivered_date_time of this Participant. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivered_date_time of this Participant. # noqa: E501
delivery_method
Gets the delivery_method of this Participant. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The delivery_method of this Participant. # noqa: E501
delivery_method_metadata
Gets the delivery_method_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The delivery_method_metadata of this Participant. # noqa: E501
designator_id
Gets the designator_id of this Participant. # noqa: E501
# noqa: E501
Returns
The designator_id of this Participant. # noqa: E501
designator_id_guid
Gets the designator_id_guid of this Participant. # noqa: E501
# noqa: E501
Returns
The designator_id_guid of this Participant. # noqa: E501
document_visibility
Gets the document_visibility of this Participant. # noqa: E501
# noqa: E501
Returns
The document_visibility of this Participant. # noqa: E501
email
Gets the email of this Participant. # noqa: E501
# noqa: E501
Returns
The email of this Participant. # noqa: E501
email_metadata
Gets the email_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The email_metadata of this Participant. # noqa: E501
email_notification
Gets the email_notification of this Participant. # 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 Participant. # noqa: E501
email_recipient_post_signing_url
Gets the email_recipient_post_signing_url of this Participant. # noqa: E501
# noqa: E501
Returns
The email_recipient_post_signing_url of this Participant. # noqa: E501
embedded_recipient_start_url
Gets the embedded_recipient_start_url of this Participant. # 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 Participant. # noqa: E501
error_details
Gets the error_details of this Participant. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this Participant. # noqa: E501
fax_number
Gets the fax_number of this Participant. # noqa: E501
Reserved: # noqa: E501
Returns
The fax_number of this Participant. # noqa: E501
fax_number_metadata
Gets the fax_number_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The fax_number_metadata of this Participant. # noqa: E501
first_name
Gets the first_name of this Participant. # noqa: E501
The user's first name. Maximum Length: 50 characters. # noqa: E501
Returns
The first_name of this Participant. # noqa: E501
first_name_metadata
Gets the first_name_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The first_name_metadata of this Participant. # noqa: E501
full_name
Gets the full_name of this Participant. # noqa: E501
# noqa: E501
Returns
The full_name of this Participant. # noqa: E501
full_name_metadata
Gets the full_name_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The full_name_metadata of this Participant. # noqa: E501
id_check_configuration_name
Gets the id_check_configuration_name of this Participant. # 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 Participant. # noqa: E501
id_check_configuration_name_metadata
Gets the id_check_configuration_name_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The id_check_configuration_name_metadata of this Participant. # noqa: E501
id_check_information_input
Gets the id_check_information_input of this Participant. # noqa: E501
# noqa: E501
Returns
The id_check_information_input of this Participant. # noqa: E501
identity_verification
Gets the identity_verification of this Participant. # noqa: E501
# noqa: E501
Returns
The identity_verification of this Participant. # noqa: E501
inherit_email_notification_configuration
Gets the inherit_email_notification_configuration of this Participant. # 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 Participant. # noqa: E501
last_name
Gets the last_name of this Participant. # noqa: E501
# noqa: E501
Returns
The last_name of this Participant. # noqa: E501
last_name_metadata
Gets the last_name_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The last_name_metadata of this Participant. # noqa: E501
locked_recipient_phone_auth_editable
Gets the locked_recipient_phone_auth_editable of this Participant. # noqa: E501
# noqa: E501
Returns
The locked_recipient_phone_auth_editable of this Participant. # noqa: E501
locked_recipient_sms_editable
Gets the locked_recipient_sms_editable of this Participant. # noqa: E501
# noqa: E501
Returns
The locked_recipient_sms_editable of this Participant. # noqa: E501
name
Gets the name of this Participant. # noqa: E501
# noqa: E501
Returns
The name of this Participant. # noqa: E501
name_metadata
Gets the name_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The name_metadata of this Participant. # noqa: E501
note
Gets the note of this Participant. # 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 Participant. # noqa: E501
note_metadata
Gets the note_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The note_metadata of this Participant. # noqa: E501
participate_for
Gets the participate_for of this Participant. # noqa: E501
# noqa: E501
Returns
The participate_for of this Participant. # noqa: E501
participate_for_guid
Gets the participate_for_guid of this Participant. # noqa: E501
# noqa: E501
Returns
The participate_for_guid of this Participant. # noqa: E501
phone_authentication
Gets the phone_authentication of this Participant. # noqa: E501
# noqa: E501
Returns
The phone_authentication of this Participant. # noqa: E501
phone_number
Gets the phone_number of this Participant. # noqa: E501
# noqa: E501
Returns
The phone_number of this Participant. # noqa: E501
recipient_attachments
Gets the recipient_attachments of this Participant. # noqa: E501
Reserved: # noqa: E501
Returns
The recipient_attachments of this Participant. # noqa: E501
recipient_authentication_status
Gets the recipient_authentication_status of this Participant. # noqa: E501
# noqa: E501
Returns
The recipient_authentication_status of this Participant. # noqa: E501
recipient_feature_metadata
Gets the recipient_feature_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The recipient_feature_metadata of this Participant. # noqa: E501
recipient_id
Gets the recipient_id of this Participant. # 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 Participant. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this Participant. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this Participant. # noqa: E501
recipient_type
Gets the recipient_type of this Participant. # noqa: E501
# noqa: E501
Returns
The recipient_type of this Participant. # noqa: E501
recipient_type_metadata
Gets the recipient_type_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The recipient_type_metadata of this Participant. # noqa: E501
require_id_lookup
Gets the require_id_lookup of this Participant. # 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 Participant. # noqa: E501
require_id_lookup_metadata
Gets the require_id_lookup_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The require_id_lookup_metadata of this Participant. # noqa: E501
role_name
Gets the role_name of this Participant. # 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 Participant. # noqa: E501
routing_order
Gets the routing_order of this Participant. # noqa: E501
Specifies the routing order of the recipient in the envelope. # noqa: E501
Returns
The routing_order of this Participant. # noqa: E501
routing_order_metadata
Gets the routing_order_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The routing_order_metadata of this Participant. # noqa: E501
sent_date_time
Gets the sent_date_time of this Participant. # noqa: E501
The date and time the envelope was sent. # noqa: E501
Returns
The sent_date_time of this Participant. # noqa: E501
signed_date_time
Gets the signed_date_time of this Participant. # noqa: E501
Reserved: For DocuSign use only. # noqa: E501
Returns
The signed_date_time of this Participant. # noqa: E501
signing_group_id
Gets the signing_group_id of this Participant. # 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 Participant. # noqa: E501
signing_group_id_metadata
Gets the signing_group_id_metadata of this Participant. # noqa: E501
# noqa: E501
Returns
The signing_group_id_metadata of this Participant. # noqa: E501
signing_group_name
Gets the signing_group_name of this Participant. # noqa: E501
The display name for the signing group. Maximum Length: 100 characters. # noqa: E501
Returns
The signing_group_name of this Participant. # noqa: E501
signing_group_users
Gets the signing_group_users of this Participant. # noqa: E501
A complex type that contains information about users in the signing group. # noqa: E501
Returns
The signing_group_users of this Participant. # noqa: E501
sms_authentication
Gets the sms_authentication of this Participant. # noqa: E501
# noqa: E501
Returns
The sms_authentication of this Participant. # noqa: E501
status
Gets the status of this Participant. # 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 Participant. # noqa: E501
status_code
Gets the status_code of this Participant. # noqa: E501
# noqa: E501
Returns
The status_code of this Participant. # noqa: E501
suppress_emails
Gets the suppress_emails of this Participant. # noqa: E501
# noqa: E501
Returns
The suppress_emails of this Participant. # noqa: E501
template_locked
Gets the template_locked of this Participant. # 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 Participant. # noqa: E501
template_required
Gets the template_required of this Participant. # 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 Participant. # noqa: E501
total_tab_count
Gets the total_tab_count of this Participant. # noqa: E501
# noqa: E501
Returns
The total_tab_count of this Participant. # noqa: E501
user_id
Gets the user_id of this Participant. # noqa: E501
# noqa: E501
Returns
The user_id of this Participant. # noqa: E501
def
to_dict(self)
2076 def to_dict(self): 2077 """Returns the model properties as a dict""" 2078 result = {} 2079 2080 for attr, _ in six.iteritems(self.swagger_types): 2081 value = getattr(self, attr) 2082 if isinstance(value, list): 2083 result[attr] = list(map( 2084 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2085 value 2086 )) 2087 elif hasattr(value, "to_dict"): 2088 result[attr] = value.to_dict() 2089 elif isinstance(value, dict): 2090 result[attr] = dict(map( 2091 lambda item: (item[0], item[1].to_dict()) 2092 if hasattr(item[1], "to_dict") else item, 2093 value.items() 2094 )) 2095 else: 2096 result[attr] = value 2097 if issubclass(Participant, dict): 2098 for key, value in self.items(): 2099 result[key] = value 2100 2101 return result
Returns the model properties as a dict