docusign_esign.models.seal_sign

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