docusign_esign.models.seal_sign

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