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