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