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