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