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