docusign_esign.models.tab_metadata

   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 TabMetadata(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        'anchor': 'str',
  37        'anchor_case_sensitive': 'str',
  38        'anchor_horizontal_alignment': 'str',
  39        'anchor_ignore_if_not_present': 'str',
  40        'anchor_match_whole_word': 'str',
  41        'anchor_units': 'str',
  42        'anchor_x_offset': 'str',
  43        'anchor_y_offset': 'str',
  44        'bold': 'str',
  45        'collaborative': 'str',
  46        'conceal_value_on_document': 'str',
  47        'created_by_display_name': 'str',
  48        'created_by_user_id': 'str',
  49        'custom_tab_id': 'str',
  50        'disable_auto_size': 'str',
  51        'editable': 'str',
  52        'font': 'str',
  53        'font_color': 'str',
  54        'font_size': 'str',
  55        'height': 'str',
  56        'included_in_email': 'str',
  57        'initial_value': 'str',
  58        'italic': 'str',
  59        'items': 'list[str]',
  60        'last_modified': 'str',
  61        'last_modified_by_display_name': 'str',
  62        'last_modified_by_user_id': 'str',
  63        'locale_policy': 'LocalePolicyTab',
  64        'locked': 'str',
  65        'maximum_length': 'str',
  66        'max_numerical_value': 'str',
  67        'merge_field': 'MergeField',
  68        'min_numerical_value': 'str',
  69        'name': 'str',
  70        'numerical_value': 'str',
  71        'payment_item_code': 'str',
  72        'payment_item_description': 'str',
  73        'payment_item_name': 'str',
  74        'require_all': 'str',
  75        'required': 'str',
  76        'require_initial_on_shared_change': 'str',
  77        'scale_value': 'str',
  78        'selected': 'str',
  79        'shared': 'str',
  80        'signature_provider_id': 'str',
  81        'stamp_type': 'str',
  82        'stamp_type_metadata': 'PropertyMetadata',
  83        'tab_label': 'str',
  84        'type': 'str',
  85        'underline': 'str',
  86        'validation_message': 'str',
  87        'validation_pattern': 'str',
  88        'validation_type': 'str',
  89        'width': 'str'
  90    }
  91
  92    attribute_map = {
  93        'anchor': 'anchor',
  94        'anchor_case_sensitive': 'anchorCaseSensitive',
  95        'anchor_horizontal_alignment': 'anchorHorizontalAlignment',
  96        'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent',
  97        'anchor_match_whole_word': 'anchorMatchWholeWord',
  98        'anchor_units': 'anchorUnits',
  99        'anchor_x_offset': 'anchorXOffset',
 100        'anchor_y_offset': 'anchorYOffset',
 101        'bold': 'bold',
 102        'collaborative': 'collaborative',
 103        'conceal_value_on_document': 'concealValueOnDocument',
 104        'created_by_display_name': 'createdByDisplayName',
 105        'created_by_user_id': 'createdByUserId',
 106        'custom_tab_id': 'customTabId',
 107        'disable_auto_size': 'disableAutoSize',
 108        'editable': 'editable',
 109        'font': 'font',
 110        'font_color': 'fontColor',
 111        'font_size': 'fontSize',
 112        'height': 'height',
 113        'included_in_email': 'includedInEmail',
 114        'initial_value': 'initialValue',
 115        'italic': 'italic',
 116        'items': 'items',
 117        'last_modified': 'lastModified',
 118        'last_modified_by_display_name': 'lastModifiedByDisplayName',
 119        'last_modified_by_user_id': 'lastModifiedByUserId',
 120        'locale_policy': 'localePolicy',
 121        'locked': 'locked',
 122        'maximum_length': 'maximumLength',
 123        'max_numerical_value': 'maxNumericalValue',
 124        'merge_field': 'mergeField',
 125        'min_numerical_value': 'minNumericalValue',
 126        'name': 'name',
 127        'numerical_value': 'numericalValue',
 128        'payment_item_code': 'paymentItemCode',
 129        'payment_item_description': 'paymentItemDescription',
 130        'payment_item_name': 'paymentItemName',
 131        'require_all': 'requireAll',
 132        'required': 'required',
 133        'require_initial_on_shared_change': 'requireInitialOnSharedChange',
 134        'scale_value': 'scaleValue',
 135        'selected': 'selected',
 136        'shared': 'shared',
 137        'signature_provider_id': 'signatureProviderId',
 138        'stamp_type': 'stampType',
 139        'stamp_type_metadata': 'stampTypeMetadata',
 140        'tab_label': 'tabLabel',
 141        'type': 'type',
 142        'underline': 'underline',
 143        'validation_message': 'validationMessage',
 144        'validation_pattern': 'validationPattern',
 145        'validation_type': 'validationType',
 146        'width': 'width'
 147    }
 148
 149    def __init__(self, _configuration=None, **kwargs):  # noqa: E501
 150        """TabMetadata - a model defined in Swagger"""  # noqa: E501
 151        if _configuration is None:
 152            _configuration = Configuration()
 153        self._configuration = _configuration
 154
 155        self._anchor = None
 156        self._anchor_case_sensitive = None
 157        self._anchor_horizontal_alignment = None
 158        self._anchor_ignore_if_not_present = None
 159        self._anchor_match_whole_word = None
 160        self._anchor_units = None
 161        self._anchor_x_offset = None
 162        self._anchor_y_offset = None
 163        self._bold = None
 164        self._collaborative = None
 165        self._conceal_value_on_document = None
 166        self._created_by_display_name = None
 167        self._created_by_user_id = None
 168        self._custom_tab_id = None
 169        self._disable_auto_size = None
 170        self._editable = None
 171        self._font = None
 172        self._font_color = None
 173        self._font_size = None
 174        self._height = None
 175        self._included_in_email = None
 176        self._initial_value = None
 177        self._italic = None
 178        self._items = None
 179        self._last_modified = None
 180        self._last_modified_by_display_name = None
 181        self._last_modified_by_user_id = None
 182        self._locale_policy = None
 183        self._locked = None
 184        self._maximum_length = None
 185        self._max_numerical_value = None
 186        self._merge_field = None
 187        self._min_numerical_value = None
 188        self._name = None
 189        self._numerical_value = None
 190        self._payment_item_code = None
 191        self._payment_item_description = None
 192        self._payment_item_name = None
 193        self._require_all = None
 194        self._required = None
 195        self._require_initial_on_shared_change = None
 196        self._scale_value = None
 197        self._selected = None
 198        self._shared = None
 199        self._signature_provider_id = None
 200        self._stamp_type = None
 201        self._stamp_type_metadata = None
 202        self._tab_label = None
 203        self._type = None
 204        self._underline = None
 205        self._validation_message = None
 206        self._validation_pattern = None
 207        self._validation_type = None
 208        self._width = None
 209        self.discriminator = None
 210
 211        setattr(self, "_{}".format('anchor'), kwargs.get('anchor', None))
 212        setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None))
 213        setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None))
 214        setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None))
 215        setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None))
 216        setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None))
 217        setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None))
 218        setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None))
 219        setattr(self, "_{}".format('bold'), kwargs.get('bold', None))
 220        setattr(self, "_{}".format('collaborative'), kwargs.get('collaborative', None))
 221        setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None))
 222        setattr(self, "_{}".format('created_by_display_name'), kwargs.get('created_by_display_name', None))
 223        setattr(self, "_{}".format('created_by_user_id'), kwargs.get('created_by_user_id', None))
 224        setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None))
 225        setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None))
 226        setattr(self, "_{}".format('editable'), kwargs.get('editable', None))
 227        setattr(self, "_{}".format('font'), kwargs.get('font', None))
 228        setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None))
 229        setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None))
 230        setattr(self, "_{}".format('height'), kwargs.get('height', None))
 231        setattr(self, "_{}".format('included_in_email'), kwargs.get('included_in_email', None))
 232        setattr(self, "_{}".format('initial_value'), kwargs.get('initial_value', None))
 233        setattr(self, "_{}".format('italic'), kwargs.get('italic', None))
 234        setattr(self, "_{}".format('items'), kwargs.get('items', None))
 235        setattr(self, "_{}".format('last_modified'), kwargs.get('last_modified', None))
 236        setattr(self, "_{}".format('last_modified_by_display_name'), kwargs.get('last_modified_by_display_name', None))
 237        setattr(self, "_{}".format('last_modified_by_user_id'), kwargs.get('last_modified_by_user_id', None))
 238        setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None))
 239        setattr(self, "_{}".format('locked'), kwargs.get('locked', None))
 240        setattr(self, "_{}".format('maximum_length'), kwargs.get('maximum_length', None))
 241        setattr(self, "_{}".format('max_numerical_value'), kwargs.get('max_numerical_value', None))
 242        setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None))
 243        setattr(self, "_{}".format('min_numerical_value'), kwargs.get('min_numerical_value', None))
 244        setattr(self, "_{}".format('name'), kwargs.get('name', None))
 245        setattr(self, "_{}".format('numerical_value'), kwargs.get('numerical_value', None))
 246        setattr(self, "_{}".format('payment_item_code'), kwargs.get('payment_item_code', None))
 247        setattr(self, "_{}".format('payment_item_description'), kwargs.get('payment_item_description', None))
 248        setattr(self, "_{}".format('payment_item_name'), kwargs.get('payment_item_name', None))
 249        setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None))
 250        setattr(self, "_{}".format('required'), kwargs.get('required', None))
 251        setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None))
 252        setattr(self, "_{}".format('scale_value'), kwargs.get('scale_value', None))
 253        setattr(self, "_{}".format('selected'), kwargs.get('selected', None))
 254        setattr(self, "_{}".format('shared'), kwargs.get('shared', None))
 255        setattr(self, "_{}".format('signature_provider_id'), kwargs.get('signature_provider_id', None))
 256        setattr(self, "_{}".format('stamp_type'), kwargs.get('stamp_type', None))
 257        setattr(self, "_{}".format('stamp_type_metadata'), kwargs.get('stamp_type_metadata', None))
 258        setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None))
 259        setattr(self, "_{}".format('type'), kwargs.get('type', None))
 260        setattr(self, "_{}".format('underline'), kwargs.get('underline', None))
 261        setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None))
 262        setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None))
 263        setattr(self, "_{}".format('validation_type'), kwargs.get('validation_type', None))
 264        setattr(self, "_{}".format('width'), kwargs.get('width', None))
 265
 266    @property
 267    def anchor(self):
 268        """Gets the anchor of this TabMetadata.  # noqa: E501
 269
 270        An optional string that is used to auto-match tabs to strings located in the documents of an envelope.  # noqa: E501
 271
 272        :return: The anchor of this TabMetadata.  # noqa: E501
 273        :rtype: str
 274        """
 275        return self._anchor
 276
 277    @anchor.setter
 278    def anchor(self, anchor):
 279        """Sets the anchor of this TabMetadata.
 280
 281        An optional string that is used to auto-match tabs to strings located in the documents of an envelope.  # noqa: E501
 282
 283        :param anchor: The anchor of this TabMetadata.  # noqa: E501
 284        :type: str
 285        """
 286
 287        self._anchor = anchor
 288
 289    @property
 290    def anchor_case_sensitive(self):
 291        """Gets the anchor_case_sensitive of this TabMetadata.  # noqa: E501
 292
 293        When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.  # noqa: E501
 294
 295        :return: The anchor_case_sensitive of this TabMetadata.  # noqa: E501
 296        :rtype: str
 297        """
 298        return self._anchor_case_sensitive
 299
 300    @anchor_case_sensitive.setter
 301    def anchor_case_sensitive(self, anchor_case_sensitive):
 302        """Sets the anchor_case_sensitive of this TabMetadata.
 303
 304        When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**.  # noqa: E501
 305
 306        :param anchor_case_sensitive: The anchor_case_sensitive of this TabMetadata.  # noqa: E501
 307        :type: str
 308        """
 309
 310        self._anchor_case_sensitive = anchor_case_sensitive
 311
 312    @property
 313    def anchor_horizontal_alignment(self):
 314        """Gets the anchor_horizontal_alignment of this TabMetadata.  # noqa: E501
 315
 316        Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.  # noqa: E501
 317
 318        :return: The anchor_horizontal_alignment of this TabMetadata.  # noqa: E501
 319        :rtype: str
 320        """
 321        return self._anchor_horizontal_alignment
 322
 323    @anchor_horizontal_alignment.setter
 324    def anchor_horizontal_alignment(self, anchor_horizontal_alignment):
 325        """Sets the anchor_horizontal_alignment of this TabMetadata.
 326
 327        Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**.  # noqa: E501
 328
 329        :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this TabMetadata.  # noqa: E501
 330        :type: str
 331        """
 332
 333        self._anchor_horizontal_alignment = anchor_horizontal_alignment
 334
 335    @property
 336    def anchor_ignore_if_not_present(self):
 337        """Gets the anchor_ignore_if_not_present of this TabMetadata.  # noqa: E501
 338
 339        When set to **true**, this tab is ignored if anchorString is not found in the document.  # noqa: E501
 340
 341        :return: The anchor_ignore_if_not_present of this TabMetadata.  # noqa: E501
 342        :rtype: str
 343        """
 344        return self._anchor_ignore_if_not_present
 345
 346    @anchor_ignore_if_not_present.setter
 347    def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present):
 348        """Sets the anchor_ignore_if_not_present of this TabMetadata.
 349
 350        When set to **true**, this tab is ignored if anchorString is not found in the document.  # noqa: E501
 351
 352        :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this TabMetadata.  # noqa: E501
 353        :type: str
 354        """
 355
 356        self._anchor_ignore_if_not_present = anchor_ignore_if_not_present
 357
 358    @property
 359    def anchor_match_whole_word(self):
 360        """Gets the anchor_match_whole_word of this TabMetadata.  # noqa: E501
 361
 362        When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.  # noqa: E501
 363
 364        :return: The anchor_match_whole_word of this TabMetadata.  # noqa: E501
 365        :rtype: str
 366        """
 367        return self._anchor_match_whole_word
 368
 369    @anchor_match_whole_word.setter
 370    def anchor_match_whole_word(self, anchor_match_whole_word):
 371        """Sets the anchor_match_whole_word of this TabMetadata.
 372
 373        When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**.  # noqa: E501
 374
 375        :param anchor_match_whole_word: The anchor_match_whole_word of this TabMetadata.  # noqa: E501
 376        :type: str
 377        """
 378
 379        self._anchor_match_whole_word = anchor_match_whole_word
 380
 381    @property
 382    def anchor_units(self):
 383        """Gets the anchor_units of this TabMetadata.  # noqa: E501
 384
 385        Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.  # noqa: E501
 386
 387        :return: The anchor_units of this TabMetadata.  # noqa: E501
 388        :rtype: str
 389        """
 390        return self._anchor_units
 391
 392    @anchor_units.setter
 393    def anchor_units(self, anchor_units):
 394        """Sets the anchor_units of this TabMetadata.
 395
 396        Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.  # noqa: E501
 397
 398        :param anchor_units: The anchor_units of this TabMetadata.  # noqa: E501
 399        :type: str
 400        """
 401
 402        self._anchor_units = anchor_units
 403
 404    @property
 405    def anchor_x_offset(self):
 406        """Gets the anchor_x_offset of this TabMetadata.  # noqa: E501
 407
 408        Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.  # noqa: E501
 409
 410        :return: The anchor_x_offset of this TabMetadata.  # noqa: E501
 411        :rtype: str
 412        """
 413        return self._anchor_x_offset
 414
 415    @anchor_x_offset.setter
 416    def anchor_x_offset(self, anchor_x_offset):
 417        """Sets the anchor_x_offset of this TabMetadata.
 418
 419        Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.  # noqa: E501
 420
 421        :param anchor_x_offset: The anchor_x_offset of this TabMetadata.  # noqa: E501
 422        :type: str
 423        """
 424
 425        self._anchor_x_offset = anchor_x_offset
 426
 427    @property
 428    def anchor_y_offset(self):
 429        """Gets the anchor_y_offset of this TabMetadata.  # noqa: E501
 430
 431        Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.  # noqa: E501
 432
 433        :return: The anchor_y_offset of this TabMetadata.  # noqa: E501
 434        :rtype: str
 435        """
 436        return self._anchor_y_offset
 437
 438    @anchor_y_offset.setter
 439    def anchor_y_offset(self, anchor_y_offset):
 440        """Sets the anchor_y_offset of this TabMetadata.
 441
 442        Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.  # noqa: E501
 443
 444        :param anchor_y_offset: The anchor_y_offset of this TabMetadata.  # noqa: E501
 445        :type: str
 446        """
 447
 448        self._anchor_y_offset = anchor_y_offset
 449
 450    @property
 451    def bold(self):
 452        """Gets the bold of this TabMetadata.  # noqa: E501
 453
 454        When set to **true**, the information in the tab is bold.  # noqa: E501
 455
 456        :return: The bold of this TabMetadata.  # noqa: E501
 457        :rtype: str
 458        """
 459        return self._bold
 460
 461    @bold.setter
 462    def bold(self, bold):
 463        """Sets the bold of this TabMetadata.
 464
 465        When set to **true**, the information in the tab is bold.  # noqa: E501
 466
 467        :param bold: The bold of this TabMetadata.  # noqa: E501
 468        :type: str
 469        """
 470
 471        self._bold = bold
 472
 473    @property
 474    def collaborative(self):
 475        """Gets the collaborative of this TabMetadata.  # noqa: E501
 476
 477          # noqa: E501
 478
 479        :return: The collaborative of this TabMetadata.  # noqa: E501
 480        :rtype: str
 481        """
 482        return self._collaborative
 483
 484    @collaborative.setter
 485    def collaborative(self, collaborative):
 486        """Sets the collaborative of this TabMetadata.
 487
 488          # noqa: E501
 489
 490        :param collaborative: The collaborative of this TabMetadata.  # noqa: E501
 491        :type: str
 492        """
 493
 494        self._collaborative = collaborative
 495
 496    @property
 497    def conceal_value_on_document(self):
 498        """Gets the conceal_value_on_document of this TabMetadata.  # noqa: E501
 499
 500        When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.  When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.  This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.  # noqa: E501
 501
 502        :return: The conceal_value_on_document of this TabMetadata.  # noqa: E501
 503        :rtype: str
 504        """
 505        return self._conceal_value_on_document
 506
 507    @conceal_value_on_document.setter
 508    def conceal_value_on_document(self, conceal_value_on_document):
 509        """Sets the conceal_value_on_document of this TabMetadata.
 510
 511        When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.  When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.  This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.  # noqa: E501
 512
 513        :param conceal_value_on_document: The conceal_value_on_document of this TabMetadata.  # noqa: E501
 514        :type: str
 515        """
 516
 517        self._conceal_value_on_document = conceal_value_on_document
 518
 519    @property
 520    def created_by_display_name(self):
 521        """Gets the created_by_display_name of this TabMetadata.  # noqa: E501
 522
 523        The user name of the DocuSign user who created this object.  # noqa: E501
 524
 525        :return: The created_by_display_name of this TabMetadata.  # noqa: E501
 526        :rtype: str
 527        """
 528        return self._created_by_display_name
 529
 530    @created_by_display_name.setter
 531    def created_by_display_name(self, created_by_display_name):
 532        """Sets the created_by_display_name of this TabMetadata.
 533
 534        The user name of the DocuSign user who created this object.  # noqa: E501
 535
 536        :param created_by_display_name: The created_by_display_name of this TabMetadata.  # noqa: E501
 537        :type: str
 538        """
 539
 540        self._created_by_display_name = created_by_display_name
 541
 542    @property
 543    def created_by_user_id(self):
 544        """Gets the created_by_user_id of this TabMetadata.  # noqa: E501
 545
 546        The userId of the DocuSign user who created this object.  # noqa: E501
 547
 548        :return: The created_by_user_id of this TabMetadata.  # noqa: E501
 549        :rtype: str
 550        """
 551        return self._created_by_user_id
 552
 553    @created_by_user_id.setter
 554    def created_by_user_id(self, created_by_user_id):
 555        """Sets the created_by_user_id of this TabMetadata.
 556
 557        The userId of the DocuSign user who created this object.  # noqa: E501
 558
 559        :param created_by_user_id: The created_by_user_id of this TabMetadata.  # noqa: E501
 560        :type: str
 561        """
 562
 563        self._created_by_user_id = created_by_user_id
 564
 565    @property
 566    def custom_tab_id(self):
 567        """Gets the custom_tab_id of this TabMetadata.  # noqa: E501
 568
 569        The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.  # noqa: E501
 570
 571        :return: The custom_tab_id of this TabMetadata.  # noqa: E501
 572        :rtype: str
 573        """
 574        return self._custom_tab_id
 575
 576    @custom_tab_id.setter
 577    def custom_tab_id(self, custom_tab_id):
 578        """Sets the custom_tab_id of this TabMetadata.
 579
 580        The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.  # noqa: E501
 581
 582        :param custom_tab_id: The custom_tab_id of this TabMetadata.  # noqa: E501
 583        :type: str
 584        """
 585
 586        self._custom_tab_id = custom_tab_id
 587
 588    @property
 589    def disable_auto_size(self):
 590        """Gets the disable_auto_size of this TabMetadata.  # noqa: E501
 591
 592        When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.  # noqa: E501
 593
 594        :return: The disable_auto_size of this TabMetadata.  # noqa: E501
 595        :rtype: str
 596        """
 597        return self._disable_auto_size
 598
 599    @disable_auto_size.setter
 600    def disable_auto_size(self, disable_auto_size):
 601        """Sets the disable_auto_size of this TabMetadata.
 602
 603        When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.  # noqa: E501
 604
 605        :param disable_auto_size: The disable_auto_size of this TabMetadata.  # noqa: E501
 606        :type: str
 607        """
 608
 609        self._disable_auto_size = disable_auto_size
 610
 611    @property
 612    def editable(self):
 613        """Gets the editable of this TabMetadata.  # noqa: E501
 614
 615        When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified.  # noqa: E501
 616
 617        :return: The editable of this TabMetadata.  # noqa: E501
 618        :rtype: str
 619        """
 620        return self._editable
 621
 622    @editable.setter
 623    def editable(self, editable):
 624        """Sets the editable of this TabMetadata.
 625
 626        When set to **true**, the custom tab is editable. Otherwise the custom tab cannot be modified.  # noqa: E501
 627
 628        :param editable: The editable of this TabMetadata.  # noqa: E501
 629        :type: str
 630        """
 631
 632        self._editable = editable
 633
 634    @property
 635    def font(self):
 636        """Gets the font of this TabMetadata.  # noqa: E501
 637
 638        The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica,   LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.  # noqa: E501
 639
 640        :return: The font of this TabMetadata.  # noqa: E501
 641        :rtype: str
 642        """
 643        return self._font
 644
 645    @font.setter
 646    def font(self, font):
 647        """Sets the font of this TabMetadata.
 648
 649        The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica,   LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.  # noqa: E501
 650
 651        :param font: The font of this TabMetadata.  # noqa: E501
 652        :type: str
 653        """
 654
 655        self._font = font
 656
 657    @property
 658    def font_color(self):
 659        """Gets the font_color of this TabMetadata.  # noqa: E501
 660
 661        The font color used for the information in the tab.  Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.  # noqa: E501
 662
 663        :return: The font_color of this TabMetadata.  # noqa: E501
 664        :rtype: str
 665        """
 666        return self._font_color
 667
 668    @font_color.setter
 669    def font_color(self, font_color):
 670        """Sets the font_color of this TabMetadata.
 671
 672        The font color used for the information in the tab.  Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.  # noqa: E501
 673
 674        :param font_color: The font_color of this TabMetadata.  # noqa: E501
 675        :type: str
 676        """
 677
 678        self._font_color = font_color
 679
 680    @property
 681    def font_size(self):
 682        """Gets the font_size of this TabMetadata.  # noqa: E501
 683
 684        The font size used for the information in the tab.  Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.  # noqa: E501
 685
 686        :return: The font_size of this TabMetadata.  # noqa: E501
 687        :rtype: str
 688        """
 689        return self._font_size
 690
 691    @font_size.setter
 692    def font_size(self, font_size):
 693        """Sets the font_size of this TabMetadata.
 694
 695        The font size used for the information in the tab.  Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.  # noqa: E501
 696
 697        :param font_size: The font_size of this TabMetadata.  # noqa: E501
 698        :type: str
 699        """
 700
 701        self._font_size = font_size
 702
 703    @property
 704    def height(self):
 705        """Gets the height of this TabMetadata.  # noqa: E501
 706
 707        Height of the tab in pixels.  # noqa: E501
 708
 709        :return: The height of this TabMetadata.  # noqa: E501
 710        :rtype: str
 711        """
 712        return self._height
 713
 714    @height.setter
 715    def height(self, height):
 716        """Sets the height of this TabMetadata.
 717
 718        Height of the tab in pixels.  # noqa: E501
 719
 720        :param height: The height of this TabMetadata.  # noqa: E501
 721        :type: str
 722        """
 723
 724        self._height = height
 725
 726    @property
 727    def included_in_email(self):
 728        """Gets the included_in_email of this TabMetadata.  # noqa: E501
 729
 730        When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.  # noqa: E501
 731
 732        :return: The included_in_email of this TabMetadata.  # noqa: E501
 733        :rtype: str
 734        """
 735        return self._included_in_email
 736
 737    @included_in_email.setter
 738    def included_in_email(self, included_in_email):
 739        """Sets the included_in_email of this TabMetadata.
 740
 741        When set to **true**, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.  # noqa: E501
 742
 743        :param included_in_email: The included_in_email of this TabMetadata.  # noqa: E501
 744        :type: str
 745        """
 746
 747        self._included_in_email = included_in_email
 748
 749    @property
 750    def initial_value(self):
 751        """Gets the initial_value of this TabMetadata.  # noqa: E501
 752
 753        The original value of the tab.  # noqa: E501
 754
 755        :return: The initial_value of this TabMetadata.  # noqa: E501
 756        :rtype: str
 757        """
 758        return self._initial_value
 759
 760    @initial_value.setter
 761    def initial_value(self, initial_value):
 762        """Sets the initial_value of this TabMetadata.
 763
 764        The original value of the tab.  # noqa: E501
 765
 766        :param initial_value: The initial_value of this TabMetadata.  # noqa: E501
 767        :type: str
 768        """
 769
 770        self._initial_value = initial_value
 771
 772    @property
 773    def italic(self):
 774        """Gets the italic of this TabMetadata.  # noqa: E501
 775
 776        When set to **true**, the information in the tab is italic.  # noqa: E501
 777
 778        :return: The italic of this TabMetadata.  # noqa: E501
 779        :rtype: str
 780        """
 781        return self._italic
 782
 783    @italic.setter
 784    def italic(self, italic):
 785        """Sets the italic of this TabMetadata.
 786
 787        When set to **true**, the information in the tab is italic.  # noqa: E501
 788
 789        :param italic: The italic of this TabMetadata.  # noqa: E501
 790        :type: str
 791        """
 792
 793        self._italic = italic
 794
 795    @property
 796    def items(self):
 797        """Gets the items of this TabMetadata.  # noqa: E501
 798
 799        If the tab is a list, this represents the values that are possible for the tab.  # noqa: E501
 800
 801        :return: The items of this TabMetadata.  # noqa: E501
 802        :rtype: list[str]
 803        """
 804        return self._items
 805
 806    @items.setter
 807    def items(self, items):
 808        """Sets the items of this TabMetadata.
 809
 810        If the tab is a list, this represents the values that are possible for the tab.  # noqa: E501
 811
 812        :param items: The items of this TabMetadata.  # noqa: E501
 813        :type: list[str]
 814        """
 815
 816        self._items = items
 817
 818    @property
 819    def last_modified(self):
 820        """Gets the last_modified of this TabMetadata.  # noqa: E501
 821
 822        The UTC DateTime this object was last modified. This is in ISO8601 format.  # noqa: E501
 823
 824        :return: The last_modified of this TabMetadata.  # noqa: E501
 825        :rtype: str
 826        """
 827        return self._last_modified
 828
 829    @last_modified.setter
 830    def last_modified(self, last_modified):
 831        """Sets the last_modified of this TabMetadata.
 832
 833        The UTC DateTime this object was last modified. This is in ISO8601 format.  # noqa: E501
 834
 835        :param last_modified: The last_modified of this TabMetadata.  # noqa: E501
 836        :type: str
 837        """
 838
 839        self._last_modified = last_modified
 840
 841    @property
 842    def last_modified_by_display_name(self):
 843        """Gets the last_modified_by_display_name of this TabMetadata.  # noqa: E501
 844
 845        The User Name of the DocuSign user who last modified this object.  # noqa: E501
 846
 847        :return: The last_modified_by_display_name of this TabMetadata.  # noqa: E501
 848        :rtype: str
 849        """
 850        return self._last_modified_by_display_name
 851
 852    @last_modified_by_display_name.setter
 853    def last_modified_by_display_name(self, last_modified_by_display_name):
 854        """Sets the last_modified_by_display_name of this TabMetadata.
 855
 856        The User Name of the DocuSign user who last modified this object.  # noqa: E501
 857
 858        :param last_modified_by_display_name: The last_modified_by_display_name of this TabMetadata.  # noqa: E501
 859        :type: str
 860        """
 861
 862        self._last_modified_by_display_name = last_modified_by_display_name
 863
 864    @property
 865    def last_modified_by_user_id(self):
 866        """Gets the last_modified_by_user_id of this TabMetadata.  # noqa: E501
 867
 868        The userId of the DocuSign user who last modified this object.  # noqa: E501
 869
 870        :return: The last_modified_by_user_id of this TabMetadata.  # noqa: E501
 871        :rtype: str
 872        """
 873        return self._last_modified_by_user_id
 874
 875    @last_modified_by_user_id.setter
 876    def last_modified_by_user_id(self, last_modified_by_user_id):
 877        """Sets the last_modified_by_user_id of this TabMetadata.
 878
 879        The userId of the DocuSign user who last modified this object.  # noqa: E501
 880
 881        :param last_modified_by_user_id: The last_modified_by_user_id of this TabMetadata.  # noqa: E501
 882        :type: str
 883        """
 884
 885        self._last_modified_by_user_id = last_modified_by_user_id
 886
 887    @property
 888    def locale_policy(self):
 889        """Gets the locale_policy of this TabMetadata.  # noqa: E501
 890
 891        Reserved for DocuSign.  # noqa: E501
 892
 893        :return: The locale_policy of this TabMetadata.  # noqa: E501
 894        :rtype: LocalePolicyTab
 895        """
 896        return self._locale_policy
 897
 898    @locale_policy.setter
 899    def locale_policy(self, locale_policy):
 900        """Sets the locale_policy of this TabMetadata.
 901
 902        Reserved for DocuSign.  # noqa: E501
 903
 904        :param locale_policy: The locale_policy of this TabMetadata.  # noqa: E501
 905        :type: LocalePolicyTab
 906        """
 907
 908        self._locale_policy = locale_policy
 909
 910    @property
 911    def locked(self):
 912        """Gets the locked of this TabMetadata.  # noqa: E501
 913
 914        When set to **true**, the signer cannot change the data of the custom tab.  # noqa: E501
 915
 916        :return: The locked of this TabMetadata.  # noqa: E501
 917        :rtype: str
 918        """
 919        return self._locked
 920
 921    @locked.setter
 922    def locked(self, locked):
 923        """Sets the locked of this TabMetadata.
 924
 925        When set to **true**, the signer cannot change the data of the custom tab.  # noqa: E501
 926
 927        :param locked: The locked of this TabMetadata.  # noqa: E501
 928        :type: str
 929        """
 930
 931        self._locked = locked
 932
 933    @property
 934    def maximum_length(self):
 935        """Gets the maximum_length of this TabMetadata.  # noqa: E501
 936
 937        The maximum number of entry characters supported by the custom tab.  # noqa: E501
 938
 939        :return: The maximum_length of this TabMetadata.  # noqa: E501
 940        :rtype: str
 941        """
 942        return self._maximum_length
 943
 944    @maximum_length.setter
 945    def maximum_length(self, maximum_length):
 946        """Sets the maximum_length of this TabMetadata.
 947
 948        The maximum number of entry characters supported by the custom tab.  # noqa: E501
 949
 950        :param maximum_length: The maximum_length of this TabMetadata.  # noqa: E501
 951        :type: str
 952        """
 953
 954        self._maximum_length = maximum_length
 955
 956    @property
 957    def max_numerical_value(self):
 958        """Gets the max_numerical_value of this TabMetadata.  # noqa: E501
 959
 960          # noqa: E501
 961
 962        :return: The max_numerical_value of this TabMetadata.  # noqa: E501
 963        :rtype: str
 964        """
 965        return self._max_numerical_value
 966
 967    @max_numerical_value.setter
 968    def max_numerical_value(self, max_numerical_value):
 969        """Sets the max_numerical_value of this TabMetadata.
 970
 971          # noqa: E501
 972
 973        :param max_numerical_value: The max_numerical_value of this TabMetadata.  # noqa: E501
 974        :type: str
 975        """
 976
 977        self._max_numerical_value = max_numerical_value
 978
 979    @property
 980    def merge_field(self):
 981        """Gets the merge_field of this TabMetadata.  # noqa: E501
 982
 983        Contains the information necessary to map the tab to a field in SalesForce.  # noqa: E501
 984
 985        :return: The merge_field of this TabMetadata.  # noqa: E501
 986        :rtype: MergeField
 987        """
 988        return self._merge_field
 989
 990    @merge_field.setter
 991    def merge_field(self, merge_field):
 992        """Sets the merge_field of this TabMetadata.
 993
 994        Contains the information necessary to map the tab to a field in SalesForce.  # noqa: E501
 995
 996        :param merge_field: The merge_field of this TabMetadata.  # noqa: E501
 997        :type: MergeField
 998        """
 999
1000        self._merge_field = merge_field
1001
1002    @property
1003    def min_numerical_value(self):
1004        """Gets the min_numerical_value of this TabMetadata.  # noqa: E501
1005
1006          # noqa: E501
1007
1008        :return: The min_numerical_value of this TabMetadata.  # noqa: E501
1009        :rtype: str
1010        """
1011        return self._min_numerical_value
1012
1013    @min_numerical_value.setter
1014    def min_numerical_value(self, min_numerical_value):
1015        """Sets the min_numerical_value of this TabMetadata.
1016
1017          # noqa: E501
1018
1019        :param min_numerical_value: The min_numerical_value of this TabMetadata.  # noqa: E501
1020        :type: str
1021        """
1022
1023        self._min_numerical_value = min_numerical_value
1024
1025    @property
1026    def name(self):
1027        """Gets the name of this TabMetadata.  # noqa: E501
1028
1029          # noqa: E501
1030
1031        :return: The name of this TabMetadata.  # noqa: E501
1032        :rtype: str
1033        """
1034        return self._name
1035
1036    @name.setter
1037    def name(self, name):
1038        """Sets the name of this TabMetadata.
1039
1040          # noqa: E501
1041
1042        :param name: The name of this TabMetadata.  # noqa: E501
1043        :type: str
1044        """
1045
1046        self._name = name
1047
1048    @property
1049    def numerical_value(self):
1050        """Gets the numerical_value of this TabMetadata.  # noqa: E501
1051
1052          # noqa: E501
1053
1054        :return: The numerical_value of this TabMetadata.  # noqa: E501
1055        :rtype: str
1056        """
1057        return self._numerical_value
1058
1059    @numerical_value.setter
1060    def numerical_value(self, numerical_value):
1061        """Sets the numerical_value of this TabMetadata.
1062
1063          # noqa: E501
1064
1065        :param numerical_value: The numerical_value of this TabMetadata.  # noqa: E501
1066        :type: str
1067        """
1068
1069        self._numerical_value = numerical_value
1070
1071    @property
1072    def payment_item_code(self):
1073        """Gets the payment_item_code of this TabMetadata.  # noqa: E501
1074
1075          # noqa: E501
1076
1077        :return: The payment_item_code of this TabMetadata.  # noqa: E501
1078        :rtype: str
1079        """
1080        return self._payment_item_code
1081
1082    @payment_item_code.setter
1083    def payment_item_code(self, payment_item_code):
1084        """Sets the payment_item_code of this TabMetadata.
1085
1086          # noqa: E501
1087
1088        :param payment_item_code: The payment_item_code of this TabMetadata.  # noqa: E501
1089        :type: str
1090        """
1091
1092        self._payment_item_code = payment_item_code
1093
1094    @property
1095    def payment_item_description(self):
1096        """Gets the payment_item_description of this TabMetadata.  # noqa: E501
1097
1098          # noqa: E501
1099
1100        :return: The payment_item_description of this TabMetadata.  # noqa: E501
1101        :rtype: str
1102        """
1103        return self._payment_item_description
1104
1105    @payment_item_description.setter
1106    def payment_item_description(self, payment_item_description):
1107        """Sets the payment_item_description of this TabMetadata.
1108
1109          # noqa: E501
1110
1111        :param payment_item_description: The payment_item_description of this TabMetadata.  # noqa: E501
1112        :type: str
1113        """
1114
1115        self._payment_item_description = payment_item_description
1116
1117    @property
1118    def payment_item_name(self):
1119        """Gets the payment_item_name of this TabMetadata.  # noqa: E501
1120
1121          # noqa: E501
1122
1123        :return: The payment_item_name of this TabMetadata.  # noqa: E501
1124        :rtype: str
1125        """
1126        return self._payment_item_name
1127
1128    @payment_item_name.setter
1129    def payment_item_name(self, payment_item_name):
1130        """Sets the payment_item_name of this TabMetadata.
1131
1132          # noqa: E501
1133
1134        :param payment_item_name: The payment_item_name of this TabMetadata.  # noqa: E501
1135        :type: str
1136        """
1137
1138        self._payment_item_name = payment_item_name
1139
1140    @property
1141    def require_all(self):
1142        """Gets the require_all of this TabMetadata.  # noqa: E501
1143
1144        When set to **true** and shared is true, information must be entered in this field to complete the envelope.   # noqa: E501
1145
1146        :return: The require_all of this TabMetadata.  # noqa: E501
1147        :rtype: str
1148        """
1149        return self._require_all
1150
1151    @require_all.setter
1152    def require_all(self, require_all):
1153        """Sets the require_all of this TabMetadata.
1154
1155        When set to **true** and shared is true, information must be entered in this field to complete the envelope.   # noqa: E501
1156
1157        :param require_all: The require_all of this TabMetadata.  # noqa: E501
1158        :type: str
1159        """
1160
1161        self._require_all = require_all
1162
1163    @property
1164    def required(self):
1165        """Gets the required of this TabMetadata.  # noqa: E501
1166
1167        When set to **true**, the signer is required to fill out this tab  # noqa: E501
1168
1169        :return: The required of this TabMetadata.  # noqa: E501
1170        :rtype: str
1171        """
1172        return self._required
1173
1174    @required.setter
1175    def required(self, required):
1176        """Sets the required of this TabMetadata.
1177
1178        When set to **true**, the signer is required to fill out this tab  # noqa: E501
1179
1180        :param required: The required of this TabMetadata.  # noqa: E501
1181        :type: str
1182        """
1183
1184        self._required = required
1185
1186    @property
1187    def require_initial_on_shared_change(self):
1188        """Gets the require_initial_on_shared_change of this TabMetadata.  # noqa: E501
1189
1190        Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.  # noqa: E501
1191
1192        :return: The require_initial_on_shared_change of this TabMetadata.  # noqa: E501
1193        :rtype: str
1194        """
1195        return self._require_initial_on_shared_change
1196
1197    @require_initial_on_shared_change.setter
1198    def require_initial_on_shared_change(self, require_initial_on_shared_change):
1199        """Sets the require_initial_on_shared_change of this TabMetadata.
1200
1201        Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field.  # noqa: E501
1202
1203        :param require_initial_on_shared_change: The require_initial_on_shared_change of this TabMetadata.  # noqa: E501
1204        :type: str
1205        """
1206
1207        self._require_initial_on_shared_change = require_initial_on_shared_change
1208
1209    @property
1210    def scale_value(self):
1211        """Gets the scale_value of this TabMetadata.  # noqa: E501
1212
1213          # noqa: E501
1214
1215        :return: The scale_value of this TabMetadata.  # noqa: E501
1216        :rtype: str
1217        """
1218        return self._scale_value
1219
1220    @scale_value.setter
1221    def scale_value(self, scale_value):
1222        """Sets the scale_value of this TabMetadata.
1223
1224          # noqa: E501
1225
1226        :param scale_value: The scale_value of this TabMetadata.  # noqa: E501
1227        :type: str
1228        """
1229
1230        self._scale_value = scale_value
1231
1232    @property
1233    def selected(self):
1234        """Gets the selected of this TabMetadata.  # noqa: E501
1235
1236          # noqa: E501
1237
1238        :return: The selected of this TabMetadata.  # noqa: E501
1239        :rtype: str
1240        """
1241        return self._selected
1242
1243    @selected.setter
1244    def selected(self, selected):
1245        """Sets the selected of this TabMetadata.
1246
1247          # noqa: E501
1248
1249        :param selected: The selected of this TabMetadata.  # noqa: E501
1250        :type: str
1251        """
1252
1253        self._selected = selected
1254
1255    @property
1256    def shared(self):
1257        """Gets the shared of this TabMetadata.  # noqa: E501
1258
1259        When set to **true**, this custom tab is shared.  # noqa: E501
1260
1261        :return: The shared of this TabMetadata.  # noqa: E501
1262        :rtype: str
1263        """
1264        return self._shared
1265
1266    @shared.setter
1267    def shared(self, shared):
1268        """Sets the shared of this TabMetadata.
1269
1270        When set to **true**, this custom tab is shared.  # noqa: E501
1271
1272        :param shared: The shared of this TabMetadata.  # noqa: E501
1273        :type: str
1274        """
1275
1276        self._shared = shared
1277
1278    @property
1279    def signature_provider_id(self):
1280        """Gets the signature_provider_id of this TabMetadata.  # noqa: E501
1281
1282          # noqa: E501
1283
1284        :return: The signature_provider_id of this TabMetadata.  # noqa: E501
1285        :rtype: str
1286        """
1287        return self._signature_provider_id
1288
1289    @signature_provider_id.setter
1290    def signature_provider_id(self, signature_provider_id):
1291        """Sets the signature_provider_id of this TabMetadata.
1292
1293          # noqa: E501
1294
1295        :param signature_provider_id: The signature_provider_id of this TabMetadata.  # noqa: E501
1296        :type: str
1297        """
1298
1299        self._signature_provider_id = signature_provider_id
1300
1301    @property
1302    def stamp_type(self):
1303        """Gets the stamp_type of this TabMetadata.  # noqa: E501
1304
1305          # noqa: E501
1306
1307        :return: The stamp_type of this TabMetadata.  # noqa: E501
1308        :rtype: str
1309        """
1310        return self._stamp_type
1311
1312    @stamp_type.setter
1313    def stamp_type(self, stamp_type):
1314        """Sets the stamp_type of this TabMetadata.
1315
1316          # noqa: E501
1317
1318        :param stamp_type: The stamp_type of this TabMetadata.  # noqa: E501
1319        :type: str
1320        """
1321
1322        self._stamp_type = stamp_type
1323
1324    @property
1325    def stamp_type_metadata(self):
1326        """Gets the stamp_type_metadata of this TabMetadata.  # noqa: E501
1327
1328        Metadata that indicates whether the `stampType` property is editable.  # noqa: E501
1329
1330        :return: The stamp_type_metadata of this TabMetadata.  # noqa: E501
1331        :rtype: PropertyMetadata
1332        """
1333        return self._stamp_type_metadata
1334
1335    @stamp_type_metadata.setter
1336    def stamp_type_metadata(self, stamp_type_metadata):
1337        """Sets the stamp_type_metadata of this TabMetadata.
1338
1339        Metadata that indicates whether the `stampType` property is editable.  # noqa: E501
1340
1341        :param stamp_type_metadata: The stamp_type_metadata of this TabMetadata.  # noqa: E501
1342        :type: PropertyMetadata
1343        """
1344
1345        self._stamp_type_metadata = stamp_type_metadata
1346
1347    @property
1348    def tab_label(self):
1349        """Gets the tab_label of this TabMetadata.  # noqa: E501
1350
1351        The label string associated with the tab.  # noqa: E501
1352
1353        :return: The tab_label of this TabMetadata.  # noqa: E501
1354        :rtype: str
1355        """
1356        return self._tab_label
1357
1358    @tab_label.setter
1359    def tab_label(self, tab_label):
1360        """Sets the tab_label of this TabMetadata.
1361
1362        The label string associated with the tab.  # noqa: E501
1363
1364        :param tab_label: The tab_label of this TabMetadata.  # noqa: E501
1365        :type: str
1366        """
1367
1368        self._tab_label = tab_label
1369
1370    @property
1371    def type(self):
1372        """Gets the type of this TabMetadata.  # noqa: E501
1373
1374        The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.  # noqa: E501
1375
1376        :return: The type of this TabMetadata.  # noqa: E501
1377        :rtype: str
1378        """
1379        return self._type
1380
1381    @type.setter
1382    def type(self, type):
1383        """Sets the type of this TabMetadata.
1384
1385        The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.  # noqa: E501
1386
1387        :param type: The type of this TabMetadata.  # noqa: E501
1388        :type: str
1389        """
1390
1391        self._type = type
1392
1393    @property
1394    def underline(self):
1395        """Gets the underline of this TabMetadata.  # noqa: E501
1396
1397        When set to **true**, the information in the tab is underlined.  # noqa: E501
1398
1399        :return: The underline of this TabMetadata.  # noqa: E501
1400        :rtype: str
1401        """
1402        return self._underline
1403
1404    @underline.setter
1405    def underline(self, underline):
1406        """Sets the underline of this TabMetadata.
1407
1408        When set to **true**, the information in the tab is underlined.  # noqa: E501
1409
1410        :param underline: The underline of this TabMetadata.  # noqa: E501
1411        :type: str
1412        """
1413
1414        self._underline = underline
1415
1416    @property
1417    def validation_message(self):
1418        """Gets the validation_message of this TabMetadata.  # noqa: E501
1419
1420        The message displayed if the custom tab fails input validation (either custom of embedded).  # noqa: E501
1421
1422        :return: The validation_message of this TabMetadata.  # noqa: E501
1423        :rtype: str
1424        """
1425        return self._validation_message
1426
1427    @validation_message.setter
1428    def validation_message(self, validation_message):
1429        """Sets the validation_message of this TabMetadata.
1430
1431        The message displayed if the custom tab fails input validation (either custom of embedded).  # noqa: E501
1432
1433        :param validation_message: The validation_message of this TabMetadata.  # noqa: E501
1434        :type: str
1435        """
1436
1437        self._validation_message = validation_message
1438
1439    @property
1440    def validation_pattern(self):
1441        """Gets the validation_pattern of this TabMetadata.  # noqa: E501
1442
1443        A regular expression used to validate input for the tab.  # noqa: E501
1444
1445        :return: The validation_pattern of this TabMetadata.  # noqa: E501
1446        :rtype: str
1447        """
1448        return self._validation_pattern
1449
1450    @validation_pattern.setter
1451    def validation_pattern(self, validation_pattern):
1452        """Sets the validation_pattern of this TabMetadata.
1453
1454        A regular expression used to validate input for the tab.  # noqa: E501
1455
1456        :param validation_pattern: The validation_pattern of this TabMetadata.  # noqa: E501
1457        :type: str
1458        """
1459
1460        self._validation_pattern = validation_pattern
1461
1462    @property
1463    def validation_type(self):
1464        """Gets the validation_type of this TabMetadata.  # noqa: E501
1465
1466          # noqa: E501
1467
1468        :return: The validation_type of this TabMetadata.  # noqa: E501
1469        :rtype: str
1470        """
1471        return self._validation_type
1472
1473    @validation_type.setter
1474    def validation_type(self, validation_type):
1475        """Sets the validation_type of this TabMetadata.
1476
1477          # noqa: E501
1478
1479        :param validation_type: The validation_type of this TabMetadata.  # noqa: E501
1480        :type: str
1481        """
1482
1483        self._validation_type = validation_type
1484
1485    @property
1486    def width(self):
1487        """Gets the width of this TabMetadata.  # noqa: E501
1488
1489        Width of the tab in pixels.  # noqa: E501
1490
1491        :return: The width of this TabMetadata.  # noqa: E501
1492        :rtype: str
1493        """
1494        return self._width
1495
1496    @width.setter
1497    def width(self, width):
1498        """Sets the width of this TabMetadata.
1499
1500        Width of the tab in pixels.  # noqa: E501
1501
1502        :param width: The width of this TabMetadata.  # noqa: E501
1503        :type: str
1504        """
1505
1506        self._width = width
1507
1508    def to_dict(self):
1509        """Returns the model properties as a dict"""
1510        result = {}
1511
1512        for attr, _ in six.iteritems(self.swagger_types):
1513            value = getattr(self, attr)
1514            if isinstance(value, list):
1515                result[attr] = list(map(
1516                    lambda x: x.to_dict() if hasattr(x, "to_dict") else x,
1517                    value
1518                ))
1519            elif hasattr(value, "to_dict"):
1520                result[attr] = value.to_dict()
1521            elif isinstance(value, dict):
1522                result[attr] = dict(map(
1523                    lambda item: (item[0], item[1].to_dict())
1524                    if hasattr(item[1], "to_dict") else item,
1525                    value.items()
1526                ))
1527            else:
1528                result[attr] = value
1529        if issubclass(TabMetadata, dict):
1530            for key, value in self.items():
1531                result[key] = value
1532
1533        return result
1534
1535    def to_str(self):
1536        """Returns the string representation of the model"""
1537        return pprint.pformat(self.to_dict())
1538
1539    def __repr__(self):
1540        """For `print` and `pprint`"""
1541        return self.to_str()
1542
1543    def __eq__(self, other):
1544        """Returns true if both objects are equal"""
1545        if not isinstance(other, TabMetadata):
1546            return False
1547
1548        return self.to_dict() == other.to_dict()
1549
1550    def __ne__(self, other):
1551        """Returns true if both objects are not equal"""
1552        if not isinstance(other, TabMetadata):
1553            return True
1554
1555        return self.to_dict() != other.to_dict()