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