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