docusign_esign.models.formula_tab
Docusign eSignature REST API
The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501
OpenAPI spec version: v2.1 Contact: devcenter@docusign.com Generated by: https://github.com/swagger-api/swagger-codegen.git
1# coding: utf-8 2 3""" 4 Docusign eSignature REST API 5 6 The Docusign eSignature REST API provides you with a powerful, convenient, and simple Web services API for interacting with Docusign. # noqa: E501 7 8 OpenAPI spec version: v2.1 9 Contact: devcenter@docusign.com 10 Generated by: https://github.com/swagger-api/swagger-codegen.git 11""" 12 13 14import pprint 15import re # noqa: F401 16 17import six 18 19from docusign_esign.client.configuration import Configuration 20 21 22class FormulaTab(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 'agreement_attribute': 'str', 37 'agreement_attribute_locked': 'str', 38 'anchor_allow_white_space_in_characters': 'str', 39 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 40 'anchor_case_sensitive': 'str', 41 'anchor_case_sensitive_metadata': 'PropertyMetadata', 42 'anchor_horizontal_alignment': 'str', 43 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 44 'anchor_ignore_if_not_present': 'str', 45 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 46 'anchor_match_whole_word': 'str', 47 'anchor_match_whole_word_metadata': 'PropertyMetadata', 48 'anchor_string': 'str', 49 'anchor_string_metadata': 'PropertyMetadata', 50 'anchor_tab_processor_version': 'str', 51 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 52 'anchor_tab_scope': 'str', 53 'anchor_units': 'str', 54 'anchor_units_metadata': 'PropertyMetadata', 55 'anchor_x_offset': 'str', 56 'anchor_x_offset_metadata': 'PropertyMetadata', 57 'anchor_y_offset': 'str', 58 'anchor_y_offset_metadata': 'PropertyMetadata', 59 'bold': 'str', 60 'bold_metadata': 'PropertyMetadata', 61 'caption': 'str', 62 'caption_metadata': 'PropertyMetadata', 63 'conceal_value_on_document': 'str', 64 'conceal_value_on_document_metadata': 'PropertyMetadata', 65 'conditional_parent_label': 'str', 66 'conditional_parent_label_metadata': 'PropertyMetadata', 67 'conditional_parent_value': 'str', 68 'conditional_parent_value_metadata': 'PropertyMetadata', 69 'connected_object_details': 'ConnectedObjectDetails', 70 'custom_tab_id': 'str', 71 'custom_tab_id_metadata': 'PropertyMetadata', 72 'disable_auto_size': 'str', 73 'disable_auto_size_metadata': 'PropertyMetadata', 74 'document_id': 'str', 75 'document_id_metadata': 'PropertyMetadata', 76 'error_details': 'ErrorDetails', 77 'extension_data': 'ExtensionData', 78 'font': 'str', 79 'font_color': 'str', 80 'font_color_metadata': 'PropertyMetadata', 81 'font_metadata': 'PropertyMetadata', 82 'font_size': 'str', 83 'font_size_metadata': 'PropertyMetadata', 84 'form_order': 'str', 85 'form_order_metadata': 'PropertyMetadata', 86 'form_page_label': 'str', 87 'form_page_label_metadata': 'PropertyMetadata', 88 'form_page_number': 'str', 89 'form_page_number_metadata': 'PropertyMetadata', 90 'formula': 'str', 91 'formula_metadata': 'PropertyMetadata', 92 'height': 'str', 93 'height_metadata': 'PropertyMetadata', 94 'hidden': 'str', 95 'hidden_metadata': 'PropertyMetadata', 96 'is_payment_amount': 'str', 97 'is_payment_amount_metadata': 'PropertyMetadata', 98 'italic': 'str', 99 'italic_metadata': 'PropertyMetadata', 100 'locale_policy': 'LocalePolicyTab', 101 'locked': 'str', 102 'locked_metadata': 'PropertyMetadata', 103 'max_length': 'str', 104 'max_length_metadata': 'PropertyMetadata', 105 'merge_field': 'MergeField', 106 'merge_field_xml': 'str', 107 'name': 'str', 108 'name_metadata': 'PropertyMetadata', 109 'original_value': 'str', 110 'original_value_metadata': 'PropertyMetadata', 111 'page_number': 'str', 112 'page_number_metadata': 'PropertyMetadata', 113 'payment_details': 'PaymentDetails', 114 'recipient_id': 'str', 115 'recipient_id_guid': 'str', 116 'recipient_id_guid_metadata': 'PropertyMetadata', 117 'recipient_id_metadata': 'PropertyMetadata', 118 'require_all': 'str', 119 'require_all_metadata': 'PropertyMetadata', 120 'required': 'str', 121 'required_metadata': 'PropertyMetadata', 122 'require_initial_on_shared_change': 'str', 123 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 124 'round_decimal_places': 'str', 125 'round_decimal_places_metadata': 'PropertyMetadata', 126 'sender_required': 'str', 127 'sender_required_metadata': 'PropertyMetadata', 128 'shared': 'str', 129 'shared_metadata': 'PropertyMetadata', 130 'share_to_recipients': 'str', 131 'share_to_recipients_metadata': 'PropertyMetadata', 132 'smart_contract_information': 'SmartContractInformation', 133 'source': 'str', 134 'status': 'str', 135 'status_metadata': 'PropertyMetadata', 136 'tab_fully_qualified_path': 'str', 137 'tab_group_labels': 'list[str]', 138 'tab_group_labels_metadata': 'PropertyMetadata', 139 'tab_id': 'str', 140 'tab_id_metadata': 'PropertyMetadata', 141 'tab_label': 'str', 142 'tab_label_metadata': 'PropertyMetadata', 143 'tab_order': 'str', 144 'tab_order_metadata': 'PropertyMetadata', 145 'tab_type': 'str', 146 'tab_type_metadata': 'PropertyMetadata', 147 'template_locked': 'str', 148 'template_locked_metadata': 'PropertyMetadata', 149 'template_required': 'str', 150 'template_required_metadata': 'PropertyMetadata', 151 'tooltip': 'str', 152 'tool_tip_metadata': 'PropertyMetadata', 153 'underline': 'str', 154 'underline_metadata': 'PropertyMetadata', 155 'validation_message': 'str', 156 'validation_message_metadata': 'PropertyMetadata', 157 'validation_pattern': 'str', 158 'validation_pattern_metadata': 'PropertyMetadata', 159 'value': 'str', 160 'value_metadata': 'PropertyMetadata', 161 'warning_details': 'ErrorDetails', 162 'width': 'str', 163 'width_metadata': 'PropertyMetadata', 164 'x_position': 'str', 165 'x_position_metadata': 'PropertyMetadata', 166 'y_position': 'str', 167 'y_position_metadata': 'PropertyMetadata' 168 } 169 170 attribute_map = { 171 'agreement_attribute': 'agreementAttribute', 172 'agreement_attribute_locked': 'agreementAttributeLocked', 173 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 174 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 175 'anchor_case_sensitive': 'anchorCaseSensitive', 176 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 177 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 178 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 179 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 180 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 181 'anchor_match_whole_word': 'anchorMatchWholeWord', 182 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 183 'anchor_string': 'anchorString', 184 'anchor_string_metadata': 'anchorStringMetadata', 185 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 186 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 187 'anchor_tab_scope': 'anchorTabScope', 188 'anchor_units': 'anchorUnits', 189 'anchor_units_metadata': 'anchorUnitsMetadata', 190 'anchor_x_offset': 'anchorXOffset', 191 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 192 'anchor_y_offset': 'anchorYOffset', 193 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 194 'bold': 'bold', 195 'bold_metadata': 'boldMetadata', 196 'caption': 'caption', 197 'caption_metadata': 'captionMetadata', 198 'conceal_value_on_document': 'concealValueOnDocument', 199 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 200 'conditional_parent_label': 'conditionalParentLabel', 201 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 202 'conditional_parent_value': 'conditionalParentValue', 203 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 204 'connected_object_details': 'connectedObjectDetails', 205 'custom_tab_id': 'customTabId', 206 'custom_tab_id_metadata': 'customTabIdMetadata', 207 'disable_auto_size': 'disableAutoSize', 208 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 209 'document_id': 'documentId', 210 'document_id_metadata': 'documentIdMetadata', 211 'error_details': 'errorDetails', 212 'extension_data': 'extensionData', 213 'font': 'font', 214 'font_color': 'fontColor', 215 'font_color_metadata': 'fontColorMetadata', 216 'font_metadata': 'fontMetadata', 217 'font_size': 'fontSize', 218 'font_size_metadata': 'fontSizeMetadata', 219 'form_order': 'formOrder', 220 'form_order_metadata': 'formOrderMetadata', 221 'form_page_label': 'formPageLabel', 222 'form_page_label_metadata': 'formPageLabelMetadata', 223 'form_page_number': 'formPageNumber', 224 'form_page_number_metadata': 'formPageNumberMetadata', 225 'formula': 'formula', 226 'formula_metadata': 'formulaMetadata', 227 'height': 'height', 228 'height_metadata': 'heightMetadata', 229 'hidden': 'hidden', 230 'hidden_metadata': 'hiddenMetadata', 231 'is_payment_amount': 'isPaymentAmount', 232 'is_payment_amount_metadata': 'isPaymentAmountMetadata', 233 'italic': 'italic', 234 'italic_metadata': 'italicMetadata', 235 'locale_policy': 'localePolicy', 236 'locked': 'locked', 237 'locked_metadata': 'lockedMetadata', 238 'max_length': 'maxLength', 239 'max_length_metadata': 'maxLengthMetadata', 240 'merge_field': 'mergeField', 241 'merge_field_xml': 'mergeFieldXml', 242 'name': 'name', 243 'name_metadata': 'nameMetadata', 244 'original_value': 'originalValue', 245 'original_value_metadata': 'originalValueMetadata', 246 'page_number': 'pageNumber', 247 'page_number_metadata': 'pageNumberMetadata', 248 'payment_details': 'paymentDetails', 249 'recipient_id': 'recipientId', 250 'recipient_id_guid': 'recipientIdGuid', 251 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 252 'recipient_id_metadata': 'recipientIdMetadata', 253 'require_all': 'requireAll', 254 'require_all_metadata': 'requireAllMetadata', 255 'required': 'required', 256 'required_metadata': 'requiredMetadata', 257 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 258 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 259 'round_decimal_places': 'roundDecimalPlaces', 260 'round_decimal_places_metadata': 'roundDecimalPlacesMetadata', 261 'sender_required': 'senderRequired', 262 'sender_required_metadata': 'senderRequiredMetadata', 263 'shared': 'shared', 264 'shared_metadata': 'sharedMetadata', 265 'share_to_recipients': 'shareToRecipients', 266 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 267 'smart_contract_information': 'smartContractInformation', 268 'source': 'source', 269 'status': 'status', 270 'status_metadata': 'statusMetadata', 271 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 272 'tab_group_labels': 'tabGroupLabels', 273 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 274 'tab_id': 'tabId', 275 'tab_id_metadata': 'tabIdMetadata', 276 'tab_label': 'tabLabel', 277 'tab_label_metadata': 'tabLabelMetadata', 278 'tab_order': 'tabOrder', 279 'tab_order_metadata': 'tabOrderMetadata', 280 'tab_type': 'tabType', 281 'tab_type_metadata': 'tabTypeMetadata', 282 'template_locked': 'templateLocked', 283 'template_locked_metadata': 'templateLockedMetadata', 284 'template_required': 'templateRequired', 285 'template_required_metadata': 'templateRequiredMetadata', 286 'tooltip': 'tooltip', 287 'tool_tip_metadata': 'toolTipMetadata', 288 'underline': 'underline', 289 'underline_metadata': 'underlineMetadata', 290 'validation_message': 'validationMessage', 291 'validation_message_metadata': 'validationMessageMetadata', 292 'validation_pattern': 'validationPattern', 293 'validation_pattern_metadata': 'validationPatternMetadata', 294 'value': 'value', 295 'value_metadata': 'valueMetadata', 296 'warning_details': 'warningDetails', 297 'width': 'width', 298 'width_metadata': 'widthMetadata', 299 'x_position': 'xPosition', 300 'x_position_metadata': 'xPositionMetadata', 301 'y_position': 'yPosition', 302 'y_position_metadata': 'yPositionMetadata' 303 } 304 305 def __init__(self, _configuration=None, **kwargs): # noqa: E501 306 """FormulaTab - a model defined in Swagger""" # noqa: E501 307 if _configuration is None: 308 _configuration = Configuration() 309 self._configuration = _configuration 310 311 self._agreement_attribute = None 312 self._agreement_attribute_locked = None 313 self._anchor_allow_white_space_in_characters = None 314 self._anchor_allow_white_space_in_characters_metadata = None 315 self._anchor_case_sensitive = None 316 self._anchor_case_sensitive_metadata = None 317 self._anchor_horizontal_alignment = None 318 self._anchor_horizontal_alignment_metadata = None 319 self._anchor_ignore_if_not_present = None 320 self._anchor_ignore_if_not_present_metadata = None 321 self._anchor_match_whole_word = None 322 self._anchor_match_whole_word_metadata = None 323 self._anchor_string = None 324 self._anchor_string_metadata = None 325 self._anchor_tab_processor_version = None 326 self._anchor_tab_processor_version_metadata = None 327 self._anchor_tab_scope = None 328 self._anchor_units = None 329 self._anchor_units_metadata = None 330 self._anchor_x_offset = None 331 self._anchor_x_offset_metadata = None 332 self._anchor_y_offset = None 333 self._anchor_y_offset_metadata = None 334 self._bold = None 335 self._bold_metadata = None 336 self._caption = None 337 self._caption_metadata = None 338 self._conceal_value_on_document = None 339 self._conceal_value_on_document_metadata = None 340 self._conditional_parent_label = None 341 self._conditional_parent_label_metadata = None 342 self._conditional_parent_value = None 343 self._conditional_parent_value_metadata = None 344 self._connected_object_details = None 345 self._custom_tab_id = None 346 self._custom_tab_id_metadata = None 347 self._disable_auto_size = None 348 self._disable_auto_size_metadata = None 349 self._document_id = None 350 self._document_id_metadata = None 351 self._error_details = None 352 self._extension_data = None 353 self._font = None 354 self._font_color = None 355 self._font_color_metadata = None 356 self._font_metadata = None 357 self._font_size = None 358 self._font_size_metadata = None 359 self._form_order = None 360 self._form_order_metadata = None 361 self._form_page_label = None 362 self._form_page_label_metadata = None 363 self._form_page_number = None 364 self._form_page_number_metadata = None 365 self._formula = None 366 self._formula_metadata = None 367 self._height = None 368 self._height_metadata = None 369 self._hidden = None 370 self._hidden_metadata = None 371 self._is_payment_amount = None 372 self._is_payment_amount_metadata = None 373 self._italic = None 374 self._italic_metadata = None 375 self._locale_policy = None 376 self._locked = None 377 self._locked_metadata = None 378 self._max_length = None 379 self._max_length_metadata = None 380 self._merge_field = None 381 self._merge_field_xml = None 382 self._name = None 383 self._name_metadata = None 384 self._original_value = None 385 self._original_value_metadata = None 386 self._page_number = None 387 self._page_number_metadata = None 388 self._payment_details = None 389 self._recipient_id = None 390 self._recipient_id_guid = None 391 self._recipient_id_guid_metadata = None 392 self._recipient_id_metadata = None 393 self._require_all = None 394 self._require_all_metadata = None 395 self._required = None 396 self._required_metadata = None 397 self._require_initial_on_shared_change = None 398 self._require_initial_on_shared_change_metadata = None 399 self._round_decimal_places = None 400 self._round_decimal_places_metadata = None 401 self._sender_required = None 402 self._sender_required_metadata = None 403 self._shared = None 404 self._shared_metadata = None 405 self._share_to_recipients = None 406 self._share_to_recipients_metadata = None 407 self._smart_contract_information = None 408 self._source = None 409 self._status = None 410 self._status_metadata = None 411 self._tab_fully_qualified_path = None 412 self._tab_group_labels = None 413 self._tab_group_labels_metadata = None 414 self._tab_id = None 415 self._tab_id_metadata = None 416 self._tab_label = None 417 self._tab_label_metadata = None 418 self._tab_order = None 419 self._tab_order_metadata = None 420 self._tab_type = None 421 self._tab_type_metadata = None 422 self._template_locked = None 423 self._template_locked_metadata = None 424 self._template_required = None 425 self._template_required_metadata = None 426 self._tooltip = None 427 self._tool_tip_metadata = None 428 self._underline = None 429 self._underline_metadata = None 430 self._validation_message = None 431 self._validation_message_metadata = None 432 self._validation_pattern = None 433 self._validation_pattern_metadata = None 434 self._value = None 435 self._value_metadata = None 436 self._warning_details = None 437 self._width = None 438 self._width_metadata = None 439 self._x_position = None 440 self._x_position_metadata = None 441 self._y_position = None 442 self._y_position_metadata = None 443 self.discriminator = None 444 445 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 446 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 447 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 448 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 449 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 450 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 451 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 452 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 453 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 454 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 455 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 456 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 457 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 458 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 459 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 460 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 461 setattr(self, "_{}".format('anchor_tab_scope'), kwargs.get('anchor_tab_scope', None)) 462 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 463 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 464 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 465 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 466 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 467 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 468 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 469 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 470 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 471 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 472 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 473 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 474 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 475 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 476 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 477 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 478 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 479 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 480 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 481 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 482 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 483 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 484 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 485 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 486 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 487 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 488 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 489 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 490 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 491 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 492 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 493 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 494 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 495 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 496 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 497 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 498 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 499 setattr(self, "_{}".format('formula'), kwargs.get('formula', None)) 500 setattr(self, "_{}".format('formula_metadata'), kwargs.get('formula_metadata', None)) 501 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 502 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 503 setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None)) 504 setattr(self, "_{}".format('hidden_metadata'), kwargs.get('hidden_metadata', None)) 505 setattr(self, "_{}".format('is_payment_amount'), kwargs.get('is_payment_amount', None)) 506 setattr(self, "_{}".format('is_payment_amount_metadata'), kwargs.get('is_payment_amount_metadata', None)) 507 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 508 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 509 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 510 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 511 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 512 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 513 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 514 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 515 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 516 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 517 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 518 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 519 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 520 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 521 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 522 setattr(self, "_{}".format('payment_details'), kwargs.get('payment_details', None)) 523 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 524 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 525 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 526 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 527 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 528 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 529 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 530 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 531 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 532 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 533 setattr(self, "_{}".format('round_decimal_places'), kwargs.get('round_decimal_places', None)) 534 setattr(self, "_{}".format('round_decimal_places_metadata'), kwargs.get('round_decimal_places_metadata', None)) 535 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 536 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 537 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 538 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 539 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 540 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 541 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 542 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 543 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 544 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 545 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 546 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 547 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 548 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 549 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 550 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 551 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 552 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 553 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 554 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 555 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 556 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 557 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 558 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 559 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 560 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 561 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 562 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 563 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 564 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 565 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 566 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 567 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 568 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 569 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 570 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 571 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 572 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 573 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 574 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 575 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 576 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 577 578 @property 579 def agreement_attribute(self): 580 """Gets the agreement_attribute of this FormulaTab. # noqa: E501 581 582 # noqa: E501 583 584 :return: The agreement_attribute of this FormulaTab. # noqa: E501 585 :rtype: str 586 """ 587 return self._agreement_attribute 588 589 @agreement_attribute.setter 590 def agreement_attribute(self, agreement_attribute): 591 """Sets the agreement_attribute of this FormulaTab. 592 593 # noqa: E501 594 595 :param agreement_attribute: The agreement_attribute of this FormulaTab. # noqa: E501 596 :type: str 597 """ 598 599 self._agreement_attribute = agreement_attribute 600 601 @property 602 def agreement_attribute_locked(self): 603 """Gets the agreement_attribute_locked of this FormulaTab. # noqa: E501 604 605 # noqa: E501 606 607 :return: The agreement_attribute_locked of this FormulaTab. # noqa: E501 608 :rtype: str 609 """ 610 return self._agreement_attribute_locked 611 612 @agreement_attribute_locked.setter 613 def agreement_attribute_locked(self, agreement_attribute_locked): 614 """Sets the agreement_attribute_locked of this FormulaTab. 615 616 # noqa: E501 617 618 :param agreement_attribute_locked: The agreement_attribute_locked of this FormulaTab. # noqa: E501 619 :type: str 620 """ 621 622 self._agreement_attribute_locked = agreement_attribute_locked 623 624 @property 625 def anchor_allow_white_space_in_characters(self): 626 """Gets the anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 627 628 # noqa: E501 629 630 :return: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 631 :rtype: str 632 """ 633 return self._anchor_allow_white_space_in_characters 634 635 @anchor_allow_white_space_in_characters.setter 636 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 637 """Sets the anchor_allow_white_space_in_characters of this FormulaTab. 638 639 # noqa: E501 640 641 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 642 :type: str 643 """ 644 645 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 646 647 @property 648 def anchor_allow_white_space_in_characters_metadata(self): 649 """Gets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 650 651 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 652 653 :return: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 654 :rtype: PropertyMetadata 655 """ 656 return self._anchor_allow_white_space_in_characters_metadata 657 658 @anchor_allow_white_space_in_characters_metadata.setter 659 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 660 """Sets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. 661 662 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 663 664 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 665 :type: PropertyMetadata 666 """ 667 668 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 669 670 @property 671 def anchor_case_sensitive(self): 672 """Gets the anchor_case_sensitive of this FormulaTab. # noqa: E501 673 674 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 675 676 :return: The anchor_case_sensitive of this FormulaTab. # noqa: E501 677 :rtype: str 678 """ 679 return self._anchor_case_sensitive 680 681 @anchor_case_sensitive.setter 682 def anchor_case_sensitive(self, anchor_case_sensitive): 683 """Sets the anchor_case_sensitive of this FormulaTab. 684 685 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 686 687 :param anchor_case_sensitive: The anchor_case_sensitive of this FormulaTab. # noqa: E501 688 :type: str 689 """ 690 691 self._anchor_case_sensitive = anchor_case_sensitive 692 693 @property 694 def anchor_case_sensitive_metadata(self): 695 """Gets the anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 696 697 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 698 699 :return: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 700 :rtype: PropertyMetadata 701 """ 702 return self._anchor_case_sensitive_metadata 703 704 @anchor_case_sensitive_metadata.setter 705 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 706 """Sets the anchor_case_sensitive_metadata of this FormulaTab. 707 708 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 709 710 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 711 :type: PropertyMetadata 712 """ 713 714 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 715 716 @property 717 def anchor_horizontal_alignment(self): 718 """Gets the anchor_horizontal_alignment of this FormulaTab. # noqa: E501 719 720 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 721 722 :return: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 723 :rtype: str 724 """ 725 return self._anchor_horizontal_alignment 726 727 @anchor_horizontal_alignment.setter 728 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 729 """Sets the anchor_horizontal_alignment of this FormulaTab. 730 731 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 732 733 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 734 :type: str 735 """ 736 737 self._anchor_horizontal_alignment = anchor_horizontal_alignment 738 739 @property 740 def anchor_horizontal_alignment_metadata(self): 741 """Gets the anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 742 743 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 744 745 :return: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 746 :rtype: PropertyMetadata 747 """ 748 return self._anchor_horizontal_alignment_metadata 749 750 @anchor_horizontal_alignment_metadata.setter 751 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 752 """Sets the anchor_horizontal_alignment_metadata of this FormulaTab. 753 754 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 755 756 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 757 :type: PropertyMetadata 758 """ 759 760 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 761 762 @property 763 def anchor_ignore_if_not_present(self): 764 """Gets the anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 765 766 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 767 768 :return: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 769 :rtype: str 770 """ 771 return self._anchor_ignore_if_not_present 772 773 @anchor_ignore_if_not_present.setter 774 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 775 """Sets the anchor_ignore_if_not_present of this FormulaTab. 776 777 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 778 779 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 780 :type: str 781 """ 782 783 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 784 785 @property 786 def anchor_ignore_if_not_present_metadata(self): 787 """Gets the anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 788 789 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 790 791 :return: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 792 :rtype: PropertyMetadata 793 """ 794 return self._anchor_ignore_if_not_present_metadata 795 796 @anchor_ignore_if_not_present_metadata.setter 797 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 798 """Sets the anchor_ignore_if_not_present_metadata of this FormulaTab. 799 800 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 801 802 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 803 :type: PropertyMetadata 804 """ 805 806 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 807 808 @property 809 def anchor_match_whole_word(self): 810 """Gets the anchor_match_whole_word of this FormulaTab. # noqa: E501 811 812 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 813 814 :return: The anchor_match_whole_word of this FormulaTab. # noqa: E501 815 :rtype: str 816 """ 817 return self._anchor_match_whole_word 818 819 @anchor_match_whole_word.setter 820 def anchor_match_whole_word(self, anchor_match_whole_word): 821 """Sets the anchor_match_whole_word of this FormulaTab. 822 823 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 824 825 :param anchor_match_whole_word: The anchor_match_whole_word of this FormulaTab. # noqa: E501 826 :type: str 827 """ 828 829 self._anchor_match_whole_word = anchor_match_whole_word 830 831 @property 832 def anchor_match_whole_word_metadata(self): 833 """Gets the anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 834 835 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 836 837 :return: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 838 :rtype: PropertyMetadata 839 """ 840 return self._anchor_match_whole_word_metadata 841 842 @anchor_match_whole_word_metadata.setter 843 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 844 """Sets the anchor_match_whole_word_metadata of this FormulaTab. 845 846 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 847 848 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 849 :type: PropertyMetadata 850 """ 851 852 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 853 854 @property 855 def anchor_string(self): 856 """Gets the anchor_string of this FormulaTab. # noqa: E501 857 858 Anchor text information for a radio button. # noqa: E501 859 860 :return: The anchor_string of this FormulaTab. # noqa: E501 861 :rtype: str 862 """ 863 return self._anchor_string 864 865 @anchor_string.setter 866 def anchor_string(self, anchor_string): 867 """Sets the anchor_string of this FormulaTab. 868 869 Anchor text information for a radio button. # noqa: E501 870 871 :param anchor_string: The anchor_string of this FormulaTab. # noqa: E501 872 :type: str 873 """ 874 875 self._anchor_string = anchor_string 876 877 @property 878 def anchor_string_metadata(self): 879 """Gets the anchor_string_metadata of this FormulaTab. # noqa: E501 880 881 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 882 883 :return: The anchor_string_metadata of this FormulaTab. # noqa: E501 884 :rtype: PropertyMetadata 885 """ 886 return self._anchor_string_metadata 887 888 @anchor_string_metadata.setter 889 def anchor_string_metadata(self, anchor_string_metadata): 890 """Sets the anchor_string_metadata of this FormulaTab. 891 892 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 893 894 :param anchor_string_metadata: The anchor_string_metadata of this FormulaTab. # noqa: E501 895 :type: PropertyMetadata 896 """ 897 898 self._anchor_string_metadata = anchor_string_metadata 899 900 @property 901 def anchor_tab_processor_version(self): 902 """Gets the anchor_tab_processor_version of this FormulaTab. # noqa: E501 903 904 # noqa: E501 905 906 :return: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 907 :rtype: str 908 """ 909 return self._anchor_tab_processor_version 910 911 @anchor_tab_processor_version.setter 912 def anchor_tab_processor_version(self, anchor_tab_processor_version): 913 """Sets the anchor_tab_processor_version of this FormulaTab. 914 915 # noqa: E501 916 917 :param anchor_tab_processor_version: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 918 :type: str 919 """ 920 921 self._anchor_tab_processor_version = anchor_tab_processor_version 922 923 @property 924 def anchor_tab_processor_version_metadata(self): 925 """Gets the anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 926 927 Reserved for DocuSign. # noqa: E501 928 929 :return: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 930 :rtype: PropertyMetadata 931 """ 932 return self._anchor_tab_processor_version_metadata 933 934 @anchor_tab_processor_version_metadata.setter 935 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 936 """Sets the anchor_tab_processor_version_metadata of this FormulaTab. 937 938 Reserved for DocuSign. # noqa: E501 939 940 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 941 :type: PropertyMetadata 942 """ 943 944 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 945 946 @property 947 def anchor_tab_scope(self): 948 """Gets the anchor_tab_scope of this FormulaTab. # noqa: E501 949 950 # noqa: E501 951 952 :return: The anchor_tab_scope of this FormulaTab. # noqa: E501 953 :rtype: str 954 """ 955 return self._anchor_tab_scope 956 957 @anchor_tab_scope.setter 958 def anchor_tab_scope(self, anchor_tab_scope): 959 """Sets the anchor_tab_scope of this FormulaTab. 960 961 # noqa: E501 962 963 :param anchor_tab_scope: The anchor_tab_scope of this FormulaTab. # noqa: E501 964 :type: str 965 """ 966 967 self._anchor_tab_scope = anchor_tab_scope 968 969 @property 970 def anchor_units(self): 971 """Gets the anchor_units of this FormulaTab. # noqa: E501 972 973 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 974 975 :return: The anchor_units of this FormulaTab. # noqa: E501 976 :rtype: str 977 """ 978 return self._anchor_units 979 980 @anchor_units.setter 981 def anchor_units(self, anchor_units): 982 """Sets the anchor_units of this FormulaTab. 983 984 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 985 986 :param anchor_units: The anchor_units of this FormulaTab. # noqa: E501 987 :type: str 988 """ 989 990 self._anchor_units = anchor_units 991 992 @property 993 def anchor_units_metadata(self): 994 """Gets the anchor_units_metadata of this FormulaTab. # noqa: E501 995 996 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 997 998 :return: The anchor_units_metadata of this FormulaTab. # noqa: E501 999 :rtype: PropertyMetadata 1000 """ 1001 return self._anchor_units_metadata 1002 1003 @anchor_units_metadata.setter 1004 def anchor_units_metadata(self, anchor_units_metadata): 1005 """Sets the anchor_units_metadata of this FormulaTab. 1006 1007 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 1008 1009 :param anchor_units_metadata: The anchor_units_metadata of this FormulaTab. # noqa: E501 1010 :type: PropertyMetadata 1011 """ 1012 1013 self._anchor_units_metadata = anchor_units_metadata 1014 1015 @property 1016 def anchor_x_offset(self): 1017 """Gets the anchor_x_offset of this FormulaTab. # noqa: E501 1018 1019 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1020 1021 :return: The anchor_x_offset of this FormulaTab. # noqa: E501 1022 :rtype: str 1023 """ 1024 return self._anchor_x_offset 1025 1026 @anchor_x_offset.setter 1027 def anchor_x_offset(self, anchor_x_offset): 1028 """Sets the anchor_x_offset of this FormulaTab. 1029 1030 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1031 1032 :param anchor_x_offset: The anchor_x_offset of this FormulaTab. # noqa: E501 1033 :type: str 1034 """ 1035 1036 self._anchor_x_offset = anchor_x_offset 1037 1038 @property 1039 def anchor_x_offset_metadata(self): 1040 """Gets the anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1041 1042 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1043 1044 :return: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1045 :rtype: PropertyMetadata 1046 """ 1047 return self._anchor_x_offset_metadata 1048 1049 @anchor_x_offset_metadata.setter 1050 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 1051 """Sets the anchor_x_offset_metadata of this FormulaTab. 1052 1053 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1054 1055 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1056 :type: PropertyMetadata 1057 """ 1058 1059 self._anchor_x_offset_metadata = anchor_x_offset_metadata 1060 1061 @property 1062 def anchor_y_offset(self): 1063 """Gets the anchor_y_offset of this FormulaTab. # noqa: E501 1064 1065 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1066 1067 :return: The anchor_y_offset of this FormulaTab. # noqa: E501 1068 :rtype: str 1069 """ 1070 return self._anchor_y_offset 1071 1072 @anchor_y_offset.setter 1073 def anchor_y_offset(self, anchor_y_offset): 1074 """Sets the anchor_y_offset of this FormulaTab. 1075 1076 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1077 1078 :param anchor_y_offset: The anchor_y_offset of this FormulaTab. # noqa: E501 1079 :type: str 1080 """ 1081 1082 self._anchor_y_offset = anchor_y_offset 1083 1084 @property 1085 def anchor_y_offset_metadata(self): 1086 """Gets the anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1087 1088 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1089 1090 :return: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1091 :rtype: PropertyMetadata 1092 """ 1093 return self._anchor_y_offset_metadata 1094 1095 @anchor_y_offset_metadata.setter 1096 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 1097 """Sets the anchor_y_offset_metadata of this FormulaTab. 1098 1099 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1100 1101 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1102 :type: PropertyMetadata 1103 """ 1104 1105 self._anchor_y_offset_metadata = anchor_y_offset_metadata 1106 1107 @property 1108 def bold(self): 1109 """Gets the bold of this FormulaTab. # noqa: E501 1110 1111 When set to **true**, the information in the tab is bold. # noqa: E501 1112 1113 :return: The bold of this FormulaTab. # noqa: E501 1114 :rtype: str 1115 """ 1116 return self._bold 1117 1118 @bold.setter 1119 def bold(self, bold): 1120 """Sets the bold of this FormulaTab. 1121 1122 When set to **true**, the information in the tab is bold. # noqa: E501 1123 1124 :param bold: The bold of this FormulaTab. # noqa: E501 1125 :type: str 1126 """ 1127 1128 self._bold = bold 1129 1130 @property 1131 def bold_metadata(self): 1132 """Gets the bold_metadata of this FormulaTab. # noqa: E501 1133 1134 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1135 1136 :return: The bold_metadata of this FormulaTab. # noqa: E501 1137 :rtype: PropertyMetadata 1138 """ 1139 return self._bold_metadata 1140 1141 @bold_metadata.setter 1142 def bold_metadata(self, bold_metadata): 1143 """Sets the bold_metadata of this FormulaTab. 1144 1145 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1146 1147 :param bold_metadata: The bold_metadata of this FormulaTab. # noqa: E501 1148 :type: PropertyMetadata 1149 """ 1150 1151 self._bold_metadata = bold_metadata 1152 1153 @property 1154 def caption(self): 1155 """Gets the caption of this FormulaTab. # noqa: E501 1156 1157 # noqa: E501 1158 1159 :return: The caption of this FormulaTab. # noqa: E501 1160 :rtype: str 1161 """ 1162 return self._caption 1163 1164 @caption.setter 1165 def caption(self, caption): 1166 """Sets the caption of this FormulaTab. 1167 1168 # noqa: E501 1169 1170 :param caption: The caption of this FormulaTab. # noqa: E501 1171 :type: str 1172 """ 1173 1174 self._caption = caption 1175 1176 @property 1177 def caption_metadata(self): 1178 """Gets the caption_metadata of this FormulaTab. # noqa: E501 1179 1180 # noqa: E501 1181 1182 :return: The caption_metadata of this FormulaTab. # noqa: E501 1183 :rtype: PropertyMetadata 1184 """ 1185 return self._caption_metadata 1186 1187 @caption_metadata.setter 1188 def caption_metadata(self, caption_metadata): 1189 """Sets the caption_metadata of this FormulaTab. 1190 1191 # noqa: E501 1192 1193 :param caption_metadata: The caption_metadata of this FormulaTab. # noqa: E501 1194 :type: PropertyMetadata 1195 """ 1196 1197 self._caption_metadata = caption_metadata 1198 1199 @property 1200 def conceal_value_on_document(self): 1201 """Gets the conceal_value_on_document of this FormulaTab. # noqa: E501 1202 1203 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 1204 1205 :return: The conceal_value_on_document of this FormulaTab. # noqa: E501 1206 :rtype: str 1207 """ 1208 return self._conceal_value_on_document 1209 1210 @conceal_value_on_document.setter 1211 def conceal_value_on_document(self, conceal_value_on_document): 1212 """Sets the conceal_value_on_document of this FormulaTab. 1213 1214 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 1215 1216 :param conceal_value_on_document: The conceal_value_on_document of this FormulaTab. # noqa: E501 1217 :type: str 1218 """ 1219 1220 self._conceal_value_on_document = conceal_value_on_document 1221 1222 @property 1223 def conceal_value_on_document_metadata(self): 1224 """Gets the conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1225 1226 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1227 1228 :return: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1229 :rtype: PropertyMetadata 1230 """ 1231 return self._conceal_value_on_document_metadata 1232 1233 @conceal_value_on_document_metadata.setter 1234 def conceal_value_on_document_metadata(self, conceal_value_on_document_metadata): 1235 """Sets the conceal_value_on_document_metadata of this FormulaTab. 1236 1237 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1238 1239 :param conceal_value_on_document_metadata: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1240 :type: PropertyMetadata 1241 """ 1242 1243 self._conceal_value_on_document_metadata = conceal_value_on_document_metadata 1244 1245 @property 1246 def conditional_parent_label(self): 1247 """Gets the conditional_parent_label of this FormulaTab. # noqa: E501 1248 1249 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1250 1251 :return: The conditional_parent_label of this FormulaTab. # noqa: E501 1252 :rtype: str 1253 """ 1254 return self._conditional_parent_label 1255 1256 @conditional_parent_label.setter 1257 def conditional_parent_label(self, conditional_parent_label): 1258 """Sets the conditional_parent_label of this FormulaTab. 1259 1260 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1261 1262 :param conditional_parent_label: The conditional_parent_label of this FormulaTab. # noqa: E501 1263 :type: str 1264 """ 1265 1266 self._conditional_parent_label = conditional_parent_label 1267 1268 @property 1269 def conditional_parent_label_metadata(self): 1270 """Gets the conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1271 1272 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1273 1274 :return: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1275 :rtype: PropertyMetadata 1276 """ 1277 return self._conditional_parent_label_metadata 1278 1279 @conditional_parent_label_metadata.setter 1280 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 1281 """Sets the conditional_parent_label_metadata of this FormulaTab. 1282 1283 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1284 1285 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1286 :type: PropertyMetadata 1287 """ 1288 1289 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1290 1291 @property 1292 def conditional_parent_value(self): 1293 """Gets the conditional_parent_value of this FormulaTab. # noqa: E501 1294 1295 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1296 1297 :return: The conditional_parent_value of this FormulaTab. # noqa: E501 1298 :rtype: str 1299 """ 1300 return self._conditional_parent_value 1301 1302 @conditional_parent_value.setter 1303 def conditional_parent_value(self, conditional_parent_value): 1304 """Sets the conditional_parent_value of this FormulaTab. 1305 1306 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1307 1308 :param conditional_parent_value: The conditional_parent_value of this FormulaTab. # noqa: E501 1309 :type: str 1310 """ 1311 1312 self._conditional_parent_value = conditional_parent_value 1313 1314 @property 1315 def conditional_parent_value_metadata(self): 1316 """Gets the conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1317 1318 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1319 1320 :return: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1321 :rtype: PropertyMetadata 1322 """ 1323 return self._conditional_parent_value_metadata 1324 1325 @conditional_parent_value_metadata.setter 1326 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1327 """Sets the conditional_parent_value_metadata of this FormulaTab. 1328 1329 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1330 1331 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1332 :type: PropertyMetadata 1333 """ 1334 1335 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1336 1337 @property 1338 def connected_object_details(self): 1339 """Gets the connected_object_details of this FormulaTab. # noqa: E501 1340 1341 # noqa: E501 1342 1343 :return: The connected_object_details of this FormulaTab. # noqa: E501 1344 :rtype: ConnectedObjectDetails 1345 """ 1346 return self._connected_object_details 1347 1348 @connected_object_details.setter 1349 def connected_object_details(self, connected_object_details): 1350 """Sets the connected_object_details of this FormulaTab. 1351 1352 # noqa: E501 1353 1354 :param connected_object_details: The connected_object_details of this FormulaTab. # noqa: E501 1355 :type: ConnectedObjectDetails 1356 """ 1357 1358 self._connected_object_details = connected_object_details 1359 1360 @property 1361 def custom_tab_id(self): 1362 """Gets the custom_tab_id of this FormulaTab. # noqa: E501 1363 1364 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 1365 1366 :return: The custom_tab_id of this FormulaTab. # noqa: E501 1367 :rtype: str 1368 """ 1369 return self._custom_tab_id 1370 1371 @custom_tab_id.setter 1372 def custom_tab_id(self, custom_tab_id): 1373 """Sets the custom_tab_id of this FormulaTab. 1374 1375 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 1376 1377 :param custom_tab_id: The custom_tab_id of this FormulaTab. # noqa: E501 1378 :type: str 1379 """ 1380 1381 self._custom_tab_id = custom_tab_id 1382 1383 @property 1384 def custom_tab_id_metadata(self): 1385 """Gets the custom_tab_id_metadata of this FormulaTab. # noqa: E501 1386 1387 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1388 1389 :return: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1390 :rtype: PropertyMetadata 1391 """ 1392 return self._custom_tab_id_metadata 1393 1394 @custom_tab_id_metadata.setter 1395 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1396 """Sets the custom_tab_id_metadata of this FormulaTab. 1397 1398 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1399 1400 :param custom_tab_id_metadata: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1401 :type: PropertyMetadata 1402 """ 1403 1404 self._custom_tab_id_metadata = custom_tab_id_metadata 1405 1406 @property 1407 def disable_auto_size(self): 1408 """Gets the disable_auto_size of this FormulaTab. # noqa: E501 1409 1410 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 1411 1412 :return: The disable_auto_size of this FormulaTab. # noqa: E501 1413 :rtype: str 1414 """ 1415 return self._disable_auto_size 1416 1417 @disable_auto_size.setter 1418 def disable_auto_size(self, disable_auto_size): 1419 """Sets the disable_auto_size of this FormulaTab. 1420 1421 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 1422 1423 :param disable_auto_size: The disable_auto_size of this FormulaTab. # noqa: E501 1424 :type: str 1425 """ 1426 1427 self._disable_auto_size = disable_auto_size 1428 1429 @property 1430 def disable_auto_size_metadata(self): 1431 """Gets the disable_auto_size_metadata of this FormulaTab. # noqa: E501 1432 1433 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1434 1435 :return: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1436 :rtype: PropertyMetadata 1437 """ 1438 return self._disable_auto_size_metadata 1439 1440 @disable_auto_size_metadata.setter 1441 def disable_auto_size_metadata(self, disable_auto_size_metadata): 1442 """Sets the disable_auto_size_metadata of this FormulaTab. 1443 1444 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1445 1446 :param disable_auto_size_metadata: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1447 :type: PropertyMetadata 1448 """ 1449 1450 self._disable_auto_size_metadata = disable_auto_size_metadata 1451 1452 @property 1453 def document_id(self): 1454 """Gets the document_id of this FormulaTab. # noqa: E501 1455 1456 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1457 1458 :return: The document_id of this FormulaTab. # noqa: E501 1459 :rtype: str 1460 """ 1461 return self._document_id 1462 1463 @document_id.setter 1464 def document_id(self, document_id): 1465 """Sets the document_id of this FormulaTab. 1466 1467 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1468 1469 :param document_id: The document_id of this FormulaTab. # noqa: E501 1470 :type: str 1471 """ 1472 1473 self._document_id = document_id 1474 1475 @property 1476 def document_id_metadata(self): 1477 """Gets the document_id_metadata of this FormulaTab. # noqa: E501 1478 1479 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1480 1481 :return: The document_id_metadata of this FormulaTab. # noqa: E501 1482 :rtype: PropertyMetadata 1483 """ 1484 return self._document_id_metadata 1485 1486 @document_id_metadata.setter 1487 def document_id_metadata(self, document_id_metadata): 1488 """Sets the document_id_metadata of this FormulaTab. 1489 1490 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1491 1492 :param document_id_metadata: The document_id_metadata of this FormulaTab. # noqa: E501 1493 :type: PropertyMetadata 1494 """ 1495 1496 self._document_id_metadata = document_id_metadata 1497 1498 @property 1499 def error_details(self): 1500 """Gets the error_details of this FormulaTab. # noqa: E501 1501 1502 Array or errors. # noqa: E501 1503 1504 :return: The error_details of this FormulaTab. # noqa: E501 1505 :rtype: ErrorDetails 1506 """ 1507 return self._error_details 1508 1509 @error_details.setter 1510 def error_details(self, error_details): 1511 """Sets the error_details of this FormulaTab. 1512 1513 Array or errors. # noqa: E501 1514 1515 :param error_details: The error_details of this FormulaTab. # noqa: E501 1516 :type: ErrorDetails 1517 """ 1518 1519 self._error_details = error_details 1520 1521 @property 1522 def extension_data(self): 1523 """Gets the extension_data of this FormulaTab. # noqa: E501 1524 1525 # noqa: E501 1526 1527 :return: The extension_data of this FormulaTab. # noqa: E501 1528 :rtype: ExtensionData 1529 """ 1530 return self._extension_data 1531 1532 @extension_data.setter 1533 def extension_data(self, extension_data): 1534 """Sets the extension_data of this FormulaTab. 1535 1536 # noqa: E501 1537 1538 :param extension_data: The extension_data of this FormulaTab. # noqa: E501 1539 :type: ExtensionData 1540 """ 1541 1542 self._extension_data = extension_data 1543 1544 @property 1545 def font(self): 1546 """Gets the font of this FormulaTab. # noqa: E501 1547 1548 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 1549 1550 :return: The font of this FormulaTab. # noqa: E501 1551 :rtype: str 1552 """ 1553 return self._font 1554 1555 @font.setter 1556 def font(self, font): 1557 """Sets the font of this FormulaTab. 1558 1559 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 1560 1561 :param font: The font of this FormulaTab. # noqa: E501 1562 :type: str 1563 """ 1564 1565 self._font = font 1566 1567 @property 1568 def font_color(self): 1569 """Gets the font_color of this FormulaTab. # noqa: E501 1570 1571 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 1572 1573 :return: The font_color of this FormulaTab. # noqa: E501 1574 :rtype: str 1575 """ 1576 return self._font_color 1577 1578 @font_color.setter 1579 def font_color(self, font_color): 1580 """Sets the font_color of this FormulaTab. 1581 1582 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 1583 1584 :param font_color: The font_color of this FormulaTab. # noqa: E501 1585 :type: str 1586 """ 1587 1588 self._font_color = font_color 1589 1590 @property 1591 def font_color_metadata(self): 1592 """Gets the font_color_metadata of this FormulaTab. # noqa: E501 1593 1594 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1595 1596 :return: The font_color_metadata of this FormulaTab. # noqa: E501 1597 :rtype: PropertyMetadata 1598 """ 1599 return self._font_color_metadata 1600 1601 @font_color_metadata.setter 1602 def font_color_metadata(self, font_color_metadata): 1603 """Sets the font_color_metadata of this FormulaTab. 1604 1605 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1606 1607 :param font_color_metadata: The font_color_metadata of this FormulaTab. # noqa: E501 1608 :type: PropertyMetadata 1609 """ 1610 1611 self._font_color_metadata = font_color_metadata 1612 1613 @property 1614 def font_metadata(self): 1615 """Gets the font_metadata of this FormulaTab. # noqa: E501 1616 1617 Metadata that indicates whether the `font` property is editable. # noqa: E501 1618 1619 :return: The font_metadata of this FormulaTab. # noqa: E501 1620 :rtype: PropertyMetadata 1621 """ 1622 return self._font_metadata 1623 1624 @font_metadata.setter 1625 def font_metadata(self, font_metadata): 1626 """Sets the font_metadata of this FormulaTab. 1627 1628 Metadata that indicates whether the `font` property is editable. # noqa: E501 1629 1630 :param font_metadata: The font_metadata of this FormulaTab. # noqa: E501 1631 :type: PropertyMetadata 1632 """ 1633 1634 self._font_metadata = font_metadata 1635 1636 @property 1637 def font_size(self): 1638 """Gets the font_size of this FormulaTab. # noqa: E501 1639 1640 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 1641 1642 :return: The font_size of this FormulaTab. # noqa: E501 1643 :rtype: str 1644 """ 1645 return self._font_size 1646 1647 @font_size.setter 1648 def font_size(self, font_size): 1649 """Sets the font_size of this FormulaTab. 1650 1651 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 1652 1653 :param font_size: The font_size of this FormulaTab. # noqa: E501 1654 :type: str 1655 """ 1656 1657 self._font_size = font_size 1658 1659 @property 1660 def font_size_metadata(self): 1661 """Gets the font_size_metadata of this FormulaTab. # noqa: E501 1662 1663 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1664 1665 :return: The font_size_metadata of this FormulaTab. # noqa: E501 1666 :rtype: PropertyMetadata 1667 """ 1668 return self._font_size_metadata 1669 1670 @font_size_metadata.setter 1671 def font_size_metadata(self, font_size_metadata): 1672 """Sets the font_size_metadata of this FormulaTab. 1673 1674 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1675 1676 :param font_size_metadata: The font_size_metadata of this FormulaTab. # noqa: E501 1677 :type: PropertyMetadata 1678 """ 1679 1680 self._font_size_metadata = font_size_metadata 1681 1682 @property 1683 def form_order(self): 1684 """Gets the form_order of this FormulaTab. # noqa: E501 1685 1686 # noqa: E501 1687 1688 :return: The form_order of this FormulaTab. # noqa: E501 1689 :rtype: str 1690 """ 1691 return self._form_order 1692 1693 @form_order.setter 1694 def form_order(self, form_order): 1695 """Sets the form_order of this FormulaTab. 1696 1697 # noqa: E501 1698 1699 :param form_order: The form_order of this FormulaTab. # noqa: E501 1700 :type: str 1701 """ 1702 1703 self._form_order = form_order 1704 1705 @property 1706 def form_order_metadata(self): 1707 """Gets the form_order_metadata of this FormulaTab. # noqa: E501 1708 1709 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1710 1711 :return: The form_order_metadata of this FormulaTab. # noqa: E501 1712 :rtype: PropertyMetadata 1713 """ 1714 return self._form_order_metadata 1715 1716 @form_order_metadata.setter 1717 def form_order_metadata(self, form_order_metadata): 1718 """Sets the form_order_metadata of this FormulaTab. 1719 1720 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1721 1722 :param form_order_metadata: The form_order_metadata of this FormulaTab. # noqa: E501 1723 :type: PropertyMetadata 1724 """ 1725 1726 self._form_order_metadata = form_order_metadata 1727 1728 @property 1729 def form_page_label(self): 1730 """Gets the form_page_label of this FormulaTab. # noqa: E501 1731 1732 # noqa: E501 1733 1734 :return: The form_page_label of this FormulaTab. # noqa: E501 1735 :rtype: str 1736 """ 1737 return self._form_page_label 1738 1739 @form_page_label.setter 1740 def form_page_label(self, form_page_label): 1741 """Sets the form_page_label of this FormulaTab. 1742 1743 # noqa: E501 1744 1745 :param form_page_label: The form_page_label of this FormulaTab. # noqa: E501 1746 :type: str 1747 """ 1748 1749 self._form_page_label = form_page_label 1750 1751 @property 1752 def form_page_label_metadata(self): 1753 """Gets the form_page_label_metadata of this FormulaTab. # noqa: E501 1754 1755 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1756 1757 :return: The form_page_label_metadata of this FormulaTab. # noqa: E501 1758 :rtype: PropertyMetadata 1759 """ 1760 return self._form_page_label_metadata 1761 1762 @form_page_label_metadata.setter 1763 def form_page_label_metadata(self, form_page_label_metadata): 1764 """Sets the form_page_label_metadata of this FormulaTab. 1765 1766 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1767 1768 :param form_page_label_metadata: The form_page_label_metadata of this FormulaTab. # noqa: E501 1769 :type: PropertyMetadata 1770 """ 1771 1772 self._form_page_label_metadata = form_page_label_metadata 1773 1774 @property 1775 def form_page_number(self): 1776 """Gets the form_page_number of this FormulaTab. # noqa: E501 1777 1778 # noqa: E501 1779 1780 :return: The form_page_number of this FormulaTab. # noqa: E501 1781 :rtype: str 1782 """ 1783 return self._form_page_number 1784 1785 @form_page_number.setter 1786 def form_page_number(self, form_page_number): 1787 """Sets the form_page_number of this FormulaTab. 1788 1789 # noqa: E501 1790 1791 :param form_page_number: The form_page_number of this FormulaTab. # noqa: E501 1792 :type: str 1793 """ 1794 1795 self._form_page_number = form_page_number 1796 1797 @property 1798 def form_page_number_metadata(self): 1799 """Gets the form_page_number_metadata of this FormulaTab. # noqa: E501 1800 1801 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1802 1803 :return: The form_page_number_metadata of this FormulaTab. # noqa: E501 1804 :rtype: PropertyMetadata 1805 """ 1806 return self._form_page_number_metadata 1807 1808 @form_page_number_metadata.setter 1809 def form_page_number_metadata(self, form_page_number_metadata): 1810 """Sets the form_page_number_metadata of this FormulaTab. 1811 1812 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1813 1814 :param form_page_number_metadata: The form_page_number_metadata of this FormulaTab. # noqa: E501 1815 :type: PropertyMetadata 1816 """ 1817 1818 self._form_page_number_metadata = form_page_number_metadata 1819 1820 @property 1821 def formula(self): 1822 """Gets the formula of this FormulaTab. # noqa: E501 1823 1824 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1825 1826 :return: The formula of this FormulaTab. # noqa: E501 1827 :rtype: str 1828 """ 1829 return self._formula 1830 1831 @formula.setter 1832 def formula(self, formula): 1833 """Sets the formula of this FormulaTab. 1834 1835 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1836 1837 :param formula: The formula of this FormulaTab. # noqa: E501 1838 :type: str 1839 """ 1840 1841 self._formula = formula 1842 1843 @property 1844 def formula_metadata(self): 1845 """Gets the formula_metadata of this FormulaTab. # noqa: E501 1846 1847 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1848 1849 :return: The formula_metadata of this FormulaTab. # noqa: E501 1850 :rtype: PropertyMetadata 1851 """ 1852 return self._formula_metadata 1853 1854 @formula_metadata.setter 1855 def formula_metadata(self, formula_metadata): 1856 """Sets the formula_metadata of this FormulaTab. 1857 1858 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1859 1860 :param formula_metadata: The formula_metadata of this FormulaTab. # noqa: E501 1861 :type: PropertyMetadata 1862 """ 1863 1864 self._formula_metadata = formula_metadata 1865 1866 @property 1867 def height(self): 1868 """Gets the height of this FormulaTab. # noqa: E501 1869 1870 Height of the tab in pixels. # noqa: E501 1871 1872 :return: The height of this FormulaTab. # noqa: E501 1873 :rtype: str 1874 """ 1875 return self._height 1876 1877 @height.setter 1878 def height(self, height): 1879 """Sets the height of this FormulaTab. 1880 1881 Height of the tab in pixels. # noqa: E501 1882 1883 :param height: The height of this FormulaTab. # noqa: E501 1884 :type: str 1885 """ 1886 1887 self._height = height 1888 1889 @property 1890 def height_metadata(self): 1891 """Gets the height_metadata of this FormulaTab. # noqa: E501 1892 1893 Metadata that indicates whether the `height` property is editable. # noqa: E501 1894 1895 :return: The height_metadata of this FormulaTab. # noqa: E501 1896 :rtype: PropertyMetadata 1897 """ 1898 return self._height_metadata 1899 1900 @height_metadata.setter 1901 def height_metadata(self, height_metadata): 1902 """Sets the height_metadata of this FormulaTab. 1903 1904 Metadata that indicates whether the `height` property is editable. # noqa: E501 1905 1906 :param height_metadata: The height_metadata of this FormulaTab. # noqa: E501 1907 :type: PropertyMetadata 1908 """ 1909 1910 self._height_metadata = height_metadata 1911 1912 @property 1913 def hidden(self): 1914 """Gets the hidden of this FormulaTab. # noqa: E501 1915 1916 # noqa: E501 1917 1918 :return: The hidden of this FormulaTab. # noqa: E501 1919 :rtype: str 1920 """ 1921 return self._hidden 1922 1923 @hidden.setter 1924 def hidden(self, hidden): 1925 """Sets the hidden of this FormulaTab. 1926 1927 # noqa: E501 1928 1929 :param hidden: The hidden of this FormulaTab. # noqa: E501 1930 :type: str 1931 """ 1932 1933 self._hidden = hidden 1934 1935 @property 1936 def hidden_metadata(self): 1937 """Gets the hidden_metadata of this FormulaTab. # noqa: E501 1938 1939 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1940 1941 :return: The hidden_metadata of this FormulaTab. # noqa: E501 1942 :rtype: PropertyMetadata 1943 """ 1944 return self._hidden_metadata 1945 1946 @hidden_metadata.setter 1947 def hidden_metadata(self, hidden_metadata): 1948 """Sets the hidden_metadata of this FormulaTab. 1949 1950 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1951 1952 :param hidden_metadata: The hidden_metadata of this FormulaTab. # noqa: E501 1953 :type: PropertyMetadata 1954 """ 1955 1956 self._hidden_metadata = hidden_metadata 1957 1958 @property 1959 def is_payment_amount(self): 1960 """Gets the is_payment_amount of this FormulaTab. # noqa: E501 1961 1962 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1963 1964 :return: The is_payment_amount of this FormulaTab. # noqa: E501 1965 :rtype: str 1966 """ 1967 return self._is_payment_amount 1968 1969 @is_payment_amount.setter 1970 def is_payment_amount(self, is_payment_amount): 1971 """Sets the is_payment_amount of this FormulaTab. 1972 1973 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1974 1975 :param is_payment_amount: The is_payment_amount of this FormulaTab. # noqa: E501 1976 :type: str 1977 """ 1978 1979 self._is_payment_amount = is_payment_amount 1980 1981 @property 1982 def is_payment_amount_metadata(self): 1983 """Gets the is_payment_amount_metadata of this FormulaTab. # noqa: E501 1984 1985 Reserved for DocuSign. # noqa: E501 1986 1987 :return: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1988 :rtype: PropertyMetadata 1989 """ 1990 return self._is_payment_amount_metadata 1991 1992 @is_payment_amount_metadata.setter 1993 def is_payment_amount_metadata(self, is_payment_amount_metadata): 1994 """Sets the is_payment_amount_metadata of this FormulaTab. 1995 1996 Reserved for DocuSign. # noqa: E501 1997 1998 :param is_payment_amount_metadata: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1999 :type: PropertyMetadata 2000 """ 2001 2002 self._is_payment_amount_metadata = is_payment_amount_metadata 2003 2004 @property 2005 def italic(self): 2006 """Gets the italic of this FormulaTab. # noqa: E501 2007 2008 When set to **true**, the information in the tab is italic. # noqa: E501 2009 2010 :return: The italic of this FormulaTab. # noqa: E501 2011 :rtype: str 2012 """ 2013 return self._italic 2014 2015 @italic.setter 2016 def italic(self, italic): 2017 """Sets the italic of this FormulaTab. 2018 2019 When set to **true**, the information in the tab is italic. # noqa: E501 2020 2021 :param italic: The italic of this FormulaTab. # noqa: E501 2022 :type: str 2023 """ 2024 2025 self._italic = italic 2026 2027 @property 2028 def italic_metadata(self): 2029 """Gets the italic_metadata of this FormulaTab. # noqa: E501 2030 2031 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2032 2033 :return: The italic_metadata of this FormulaTab. # noqa: E501 2034 :rtype: PropertyMetadata 2035 """ 2036 return self._italic_metadata 2037 2038 @italic_metadata.setter 2039 def italic_metadata(self, italic_metadata): 2040 """Sets the italic_metadata of this FormulaTab. 2041 2042 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2043 2044 :param italic_metadata: The italic_metadata of this FormulaTab. # noqa: E501 2045 :type: PropertyMetadata 2046 """ 2047 2048 self._italic_metadata = italic_metadata 2049 2050 @property 2051 def locale_policy(self): 2052 """Gets the locale_policy of this FormulaTab. # noqa: E501 2053 2054 Reserved for DocuSign. # noqa: E501 2055 2056 :return: The locale_policy of this FormulaTab. # noqa: E501 2057 :rtype: LocalePolicyTab 2058 """ 2059 return self._locale_policy 2060 2061 @locale_policy.setter 2062 def locale_policy(self, locale_policy): 2063 """Sets the locale_policy of this FormulaTab. 2064 2065 Reserved for DocuSign. # noqa: E501 2066 2067 :param locale_policy: The locale_policy of this FormulaTab. # noqa: E501 2068 :type: LocalePolicyTab 2069 """ 2070 2071 self._locale_policy = locale_policy 2072 2073 @property 2074 def locked(self): 2075 """Gets the locked of this FormulaTab. # noqa: E501 2076 2077 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2078 2079 :return: The locked of this FormulaTab. # noqa: E501 2080 :rtype: str 2081 """ 2082 return self._locked 2083 2084 @locked.setter 2085 def locked(self, locked): 2086 """Sets the locked of this FormulaTab. 2087 2088 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2089 2090 :param locked: The locked of this FormulaTab. # noqa: E501 2091 :type: str 2092 """ 2093 2094 self._locked = locked 2095 2096 @property 2097 def locked_metadata(self): 2098 """Gets the locked_metadata of this FormulaTab. # noqa: E501 2099 2100 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2101 2102 :return: The locked_metadata of this FormulaTab. # noqa: E501 2103 :rtype: PropertyMetadata 2104 """ 2105 return self._locked_metadata 2106 2107 @locked_metadata.setter 2108 def locked_metadata(self, locked_metadata): 2109 """Sets the locked_metadata of this FormulaTab. 2110 2111 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2112 2113 :param locked_metadata: The locked_metadata of this FormulaTab. # noqa: E501 2114 :type: PropertyMetadata 2115 """ 2116 2117 self._locked_metadata = locked_metadata 2118 2119 @property 2120 def max_length(self): 2121 """Gets the max_length of this FormulaTab. # noqa: E501 2122 2123 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2124 2125 :return: The max_length of this FormulaTab. # noqa: E501 2126 :rtype: str 2127 """ 2128 return self._max_length 2129 2130 @max_length.setter 2131 def max_length(self, max_length): 2132 """Sets the max_length of this FormulaTab. 2133 2134 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2135 2136 :param max_length: The max_length of this FormulaTab. # noqa: E501 2137 :type: str 2138 """ 2139 2140 self._max_length = max_length 2141 2142 @property 2143 def max_length_metadata(self): 2144 """Gets the max_length_metadata of this FormulaTab. # noqa: E501 2145 2146 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2147 2148 :return: The max_length_metadata of this FormulaTab. # noqa: E501 2149 :rtype: PropertyMetadata 2150 """ 2151 return self._max_length_metadata 2152 2153 @max_length_metadata.setter 2154 def max_length_metadata(self, max_length_metadata): 2155 """Sets the max_length_metadata of this FormulaTab. 2156 2157 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2158 2159 :param max_length_metadata: The max_length_metadata of this FormulaTab. # noqa: E501 2160 :type: PropertyMetadata 2161 """ 2162 2163 self._max_length_metadata = max_length_metadata 2164 2165 @property 2166 def merge_field(self): 2167 """Gets the merge_field of this FormulaTab. # noqa: E501 2168 2169 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2170 2171 :return: The merge_field of this FormulaTab. # noqa: E501 2172 :rtype: MergeField 2173 """ 2174 return self._merge_field 2175 2176 @merge_field.setter 2177 def merge_field(self, merge_field): 2178 """Sets the merge_field of this FormulaTab. 2179 2180 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2181 2182 :param merge_field: The merge_field of this FormulaTab. # noqa: E501 2183 :type: MergeField 2184 """ 2185 2186 self._merge_field = merge_field 2187 2188 @property 2189 def merge_field_xml(self): 2190 """Gets the merge_field_xml of this FormulaTab. # noqa: E501 2191 2192 # noqa: E501 2193 2194 :return: The merge_field_xml of this FormulaTab. # noqa: E501 2195 :rtype: str 2196 """ 2197 return self._merge_field_xml 2198 2199 @merge_field_xml.setter 2200 def merge_field_xml(self, merge_field_xml): 2201 """Sets the merge_field_xml of this FormulaTab. 2202 2203 # noqa: E501 2204 2205 :param merge_field_xml: The merge_field_xml of this FormulaTab. # noqa: E501 2206 :type: str 2207 """ 2208 2209 self._merge_field_xml = merge_field_xml 2210 2211 @property 2212 def name(self): 2213 """Gets the name of this FormulaTab. # noqa: E501 2214 2215 # noqa: E501 2216 2217 :return: The name of this FormulaTab. # noqa: E501 2218 :rtype: str 2219 """ 2220 return self._name 2221 2222 @name.setter 2223 def name(self, name): 2224 """Sets the name of this FormulaTab. 2225 2226 # noqa: E501 2227 2228 :param name: The name of this FormulaTab. # noqa: E501 2229 :type: str 2230 """ 2231 2232 self._name = name 2233 2234 @property 2235 def name_metadata(self): 2236 """Gets the name_metadata of this FormulaTab. # noqa: E501 2237 2238 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2239 2240 :return: The name_metadata of this FormulaTab. # noqa: E501 2241 :rtype: PropertyMetadata 2242 """ 2243 return self._name_metadata 2244 2245 @name_metadata.setter 2246 def name_metadata(self, name_metadata): 2247 """Sets the name_metadata of this FormulaTab. 2248 2249 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2250 2251 :param name_metadata: The name_metadata of this FormulaTab. # noqa: E501 2252 :type: PropertyMetadata 2253 """ 2254 2255 self._name_metadata = name_metadata 2256 2257 @property 2258 def original_value(self): 2259 """Gets the original_value of this FormulaTab. # noqa: E501 2260 2261 The initial value of the tab when it was sent to the recipient. # noqa: E501 2262 2263 :return: The original_value of this FormulaTab. # noqa: E501 2264 :rtype: str 2265 """ 2266 return self._original_value 2267 2268 @original_value.setter 2269 def original_value(self, original_value): 2270 """Sets the original_value of this FormulaTab. 2271 2272 The initial value of the tab when it was sent to the recipient. # noqa: E501 2273 2274 :param original_value: The original_value of this FormulaTab. # noqa: E501 2275 :type: str 2276 """ 2277 2278 self._original_value = original_value 2279 2280 @property 2281 def original_value_metadata(self): 2282 """Gets the original_value_metadata of this FormulaTab. # noqa: E501 2283 2284 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2285 2286 :return: The original_value_metadata of this FormulaTab. # noqa: E501 2287 :rtype: PropertyMetadata 2288 """ 2289 return self._original_value_metadata 2290 2291 @original_value_metadata.setter 2292 def original_value_metadata(self, original_value_metadata): 2293 """Sets the original_value_metadata of this FormulaTab. 2294 2295 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2296 2297 :param original_value_metadata: The original_value_metadata of this FormulaTab. # noqa: E501 2298 :type: PropertyMetadata 2299 """ 2300 2301 self._original_value_metadata = original_value_metadata 2302 2303 @property 2304 def page_number(self): 2305 """Gets the page_number of this FormulaTab. # noqa: E501 2306 2307 Specifies the page number on which the tab is located. # noqa: E501 2308 2309 :return: The page_number of this FormulaTab. # noqa: E501 2310 :rtype: str 2311 """ 2312 return self._page_number 2313 2314 @page_number.setter 2315 def page_number(self, page_number): 2316 """Sets the page_number of this FormulaTab. 2317 2318 Specifies the page number on which the tab is located. # noqa: E501 2319 2320 :param page_number: The page_number of this FormulaTab. # noqa: E501 2321 :type: str 2322 """ 2323 2324 self._page_number = page_number 2325 2326 @property 2327 def page_number_metadata(self): 2328 """Gets the page_number_metadata of this FormulaTab. # noqa: E501 2329 2330 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2331 2332 :return: The page_number_metadata of this FormulaTab. # noqa: E501 2333 :rtype: PropertyMetadata 2334 """ 2335 return self._page_number_metadata 2336 2337 @page_number_metadata.setter 2338 def page_number_metadata(self, page_number_metadata): 2339 """Sets the page_number_metadata of this FormulaTab. 2340 2341 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2342 2343 :param page_number_metadata: The page_number_metadata of this FormulaTab. # noqa: E501 2344 :type: PropertyMetadata 2345 """ 2346 2347 self._page_number_metadata = page_number_metadata 2348 2349 @property 2350 def payment_details(self): 2351 """Gets the payment_details of this FormulaTab. # noqa: E501 2352 2353 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2354 2355 :return: The payment_details of this FormulaTab. # noqa: E501 2356 :rtype: PaymentDetails 2357 """ 2358 return self._payment_details 2359 2360 @payment_details.setter 2361 def payment_details(self, payment_details): 2362 """Sets the payment_details of this FormulaTab. 2363 2364 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2365 2366 :param payment_details: The payment_details of this FormulaTab. # noqa: E501 2367 :type: PaymentDetails 2368 """ 2369 2370 self._payment_details = payment_details 2371 2372 @property 2373 def recipient_id(self): 2374 """Gets the recipient_id of this FormulaTab. # noqa: E501 2375 2376 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2377 2378 :return: The recipient_id of this FormulaTab. # noqa: E501 2379 :rtype: str 2380 """ 2381 return self._recipient_id 2382 2383 @recipient_id.setter 2384 def recipient_id(self, recipient_id): 2385 """Sets the recipient_id of this FormulaTab. 2386 2387 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2388 2389 :param recipient_id: The recipient_id of this FormulaTab. # noqa: E501 2390 :type: str 2391 """ 2392 2393 self._recipient_id = recipient_id 2394 2395 @property 2396 def recipient_id_guid(self): 2397 """Gets the recipient_id_guid of this FormulaTab. # noqa: E501 2398 2399 # noqa: E501 2400 2401 :return: The recipient_id_guid of this FormulaTab. # noqa: E501 2402 :rtype: str 2403 """ 2404 return self._recipient_id_guid 2405 2406 @recipient_id_guid.setter 2407 def recipient_id_guid(self, recipient_id_guid): 2408 """Sets the recipient_id_guid of this FormulaTab. 2409 2410 # noqa: E501 2411 2412 :param recipient_id_guid: The recipient_id_guid of this FormulaTab. # noqa: E501 2413 :type: str 2414 """ 2415 2416 self._recipient_id_guid = recipient_id_guid 2417 2418 @property 2419 def recipient_id_guid_metadata(self): 2420 """Gets the recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2421 2422 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2423 2424 :return: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2425 :rtype: PropertyMetadata 2426 """ 2427 return self._recipient_id_guid_metadata 2428 2429 @recipient_id_guid_metadata.setter 2430 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 2431 """Sets the recipient_id_guid_metadata of this FormulaTab. 2432 2433 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2434 2435 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2436 :type: PropertyMetadata 2437 """ 2438 2439 self._recipient_id_guid_metadata = recipient_id_guid_metadata 2440 2441 @property 2442 def recipient_id_metadata(self): 2443 """Gets the recipient_id_metadata of this FormulaTab. # noqa: E501 2444 2445 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2446 2447 :return: The recipient_id_metadata of this FormulaTab. # noqa: E501 2448 :rtype: PropertyMetadata 2449 """ 2450 return self._recipient_id_metadata 2451 2452 @recipient_id_metadata.setter 2453 def recipient_id_metadata(self, recipient_id_metadata): 2454 """Sets the recipient_id_metadata of this FormulaTab. 2455 2456 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2457 2458 :param recipient_id_metadata: The recipient_id_metadata of this FormulaTab. # noqa: E501 2459 :type: PropertyMetadata 2460 """ 2461 2462 self._recipient_id_metadata = recipient_id_metadata 2463 2464 @property 2465 def require_all(self): 2466 """Gets the require_all of this FormulaTab. # noqa: E501 2467 2468 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2469 2470 :return: The require_all of this FormulaTab. # noqa: E501 2471 :rtype: str 2472 """ 2473 return self._require_all 2474 2475 @require_all.setter 2476 def require_all(self, require_all): 2477 """Sets the require_all of this FormulaTab. 2478 2479 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2480 2481 :param require_all: The require_all of this FormulaTab. # noqa: E501 2482 :type: str 2483 """ 2484 2485 self._require_all = require_all 2486 2487 @property 2488 def require_all_metadata(self): 2489 """Gets the require_all_metadata of this FormulaTab. # noqa: E501 2490 2491 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2492 2493 :return: The require_all_metadata of this FormulaTab. # noqa: E501 2494 :rtype: PropertyMetadata 2495 """ 2496 return self._require_all_metadata 2497 2498 @require_all_metadata.setter 2499 def require_all_metadata(self, require_all_metadata): 2500 """Sets the require_all_metadata of this FormulaTab. 2501 2502 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2503 2504 :param require_all_metadata: The require_all_metadata of this FormulaTab. # noqa: E501 2505 :type: PropertyMetadata 2506 """ 2507 2508 self._require_all_metadata = require_all_metadata 2509 2510 @property 2511 def required(self): 2512 """Gets the required of this FormulaTab. # noqa: E501 2513 2514 When set to **true**, the signer is required to fill out this tab # noqa: E501 2515 2516 :return: The required of this FormulaTab. # noqa: E501 2517 :rtype: str 2518 """ 2519 return self._required 2520 2521 @required.setter 2522 def required(self, required): 2523 """Sets the required of this FormulaTab. 2524 2525 When set to **true**, the signer is required to fill out this tab # noqa: E501 2526 2527 :param required: The required of this FormulaTab. # noqa: E501 2528 :type: str 2529 """ 2530 2531 self._required = required 2532 2533 @property 2534 def required_metadata(self): 2535 """Gets the required_metadata of this FormulaTab. # noqa: E501 2536 2537 Metadata that indicates whether the `required` property is editable. # noqa: E501 2538 2539 :return: The required_metadata of this FormulaTab. # noqa: E501 2540 :rtype: PropertyMetadata 2541 """ 2542 return self._required_metadata 2543 2544 @required_metadata.setter 2545 def required_metadata(self, required_metadata): 2546 """Sets the required_metadata of this FormulaTab. 2547 2548 Metadata that indicates whether the `required` property is editable. # noqa: E501 2549 2550 :param required_metadata: The required_metadata of this FormulaTab. # noqa: E501 2551 :type: PropertyMetadata 2552 """ 2553 2554 self._required_metadata = required_metadata 2555 2556 @property 2557 def require_initial_on_shared_change(self): 2558 """Gets the require_initial_on_shared_change of this FormulaTab. # noqa: E501 2559 2560 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2561 2562 :return: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2563 :rtype: str 2564 """ 2565 return self._require_initial_on_shared_change 2566 2567 @require_initial_on_shared_change.setter 2568 def require_initial_on_shared_change(self, require_initial_on_shared_change): 2569 """Sets the require_initial_on_shared_change of this FormulaTab. 2570 2571 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2572 2573 :param require_initial_on_shared_change: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2574 :type: str 2575 """ 2576 2577 self._require_initial_on_shared_change = require_initial_on_shared_change 2578 2579 @property 2580 def require_initial_on_shared_change_metadata(self): 2581 """Gets the require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2582 2583 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2584 2585 :return: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2586 :rtype: PropertyMetadata 2587 """ 2588 return self._require_initial_on_shared_change_metadata 2589 2590 @require_initial_on_shared_change_metadata.setter 2591 def require_initial_on_shared_change_metadata(self, require_initial_on_shared_change_metadata): 2592 """Sets the require_initial_on_shared_change_metadata of this FormulaTab. 2593 2594 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2595 2596 :param require_initial_on_shared_change_metadata: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2597 :type: PropertyMetadata 2598 """ 2599 2600 self._require_initial_on_shared_change_metadata = require_initial_on_shared_change_metadata 2601 2602 @property 2603 def round_decimal_places(self): 2604 """Gets the round_decimal_places of this FormulaTab. # noqa: E501 2605 2606 # noqa: E501 2607 2608 :return: The round_decimal_places of this FormulaTab. # noqa: E501 2609 :rtype: str 2610 """ 2611 return self._round_decimal_places 2612 2613 @round_decimal_places.setter 2614 def round_decimal_places(self, round_decimal_places): 2615 """Sets the round_decimal_places of this FormulaTab. 2616 2617 # noqa: E501 2618 2619 :param round_decimal_places: The round_decimal_places of this FormulaTab. # noqa: E501 2620 :type: str 2621 """ 2622 2623 self._round_decimal_places = round_decimal_places 2624 2625 @property 2626 def round_decimal_places_metadata(self): 2627 """Gets the round_decimal_places_metadata of this FormulaTab. # noqa: E501 2628 2629 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2630 2631 :return: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2632 :rtype: PropertyMetadata 2633 """ 2634 return self._round_decimal_places_metadata 2635 2636 @round_decimal_places_metadata.setter 2637 def round_decimal_places_metadata(self, round_decimal_places_metadata): 2638 """Sets the round_decimal_places_metadata of this FormulaTab. 2639 2640 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2641 2642 :param round_decimal_places_metadata: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2643 :type: PropertyMetadata 2644 """ 2645 2646 self._round_decimal_places_metadata = round_decimal_places_metadata 2647 2648 @property 2649 def sender_required(self): 2650 """Gets the sender_required of this FormulaTab. # noqa: E501 2651 2652 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2653 2654 :return: The sender_required of this FormulaTab. # noqa: E501 2655 :rtype: str 2656 """ 2657 return self._sender_required 2658 2659 @sender_required.setter 2660 def sender_required(self, sender_required): 2661 """Sets the sender_required of this FormulaTab. 2662 2663 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2664 2665 :param sender_required: The sender_required of this FormulaTab. # noqa: E501 2666 :type: str 2667 """ 2668 2669 self._sender_required = sender_required 2670 2671 @property 2672 def sender_required_metadata(self): 2673 """Gets the sender_required_metadata of this FormulaTab. # noqa: E501 2674 2675 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2676 2677 :return: The sender_required_metadata of this FormulaTab. # noqa: E501 2678 :rtype: PropertyMetadata 2679 """ 2680 return self._sender_required_metadata 2681 2682 @sender_required_metadata.setter 2683 def sender_required_metadata(self, sender_required_metadata): 2684 """Sets the sender_required_metadata of this FormulaTab. 2685 2686 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2687 2688 :param sender_required_metadata: The sender_required_metadata of this FormulaTab. # noqa: E501 2689 :type: PropertyMetadata 2690 """ 2691 2692 self._sender_required_metadata = sender_required_metadata 2693 2694 @property 2695 def shared(self): 2696 """Gets the shared of this FormulaTab. # noqa: E501 2697 2698 When set to **true**, this custom tab is shared. # noqa: E501 2699 2700 :return: The shared of this FormulaTab. # noqa: E501 2701 :rtype: str 2702 """ 2703 return self._shared 2704 2705 @shared.setter 2706 def shared(self, shared): 2707 """Sets the shared of this FormulaTab. 2708 2709 When set to **true**, this custom tab is shared. # noqa: E501 2710 2711 :param shared: The shared of this FormulaTab. # noqa: E501 2712 :type: str 2713 """ 2714 2715 self._shared = shared 2716 2717 @property 2718 def shared_metadata(self): 2719 """Gets the shared_metadata of this FormulaTab. # noqa: E501 2720 2721 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2722 2723 :return: The shared_metadata of this FormulaTab. # noqa: E501 2724 :rtype: PropertyMetadata 2725 """ 2726 return self._shared_metadata 2727 2728 @shared_metadata.setter 2729 def shared_metadata(self, shared_metadata): 2730 """Sets the shared_metadata of this FormulaTab. 2731 2732 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2733 2734 :param shared_metadata: The shared_metadata of this FormulaTab. # noqa: E501 2735 :type: PropertyMetadata 2736 """ 2737 2738 self._shared_metadata = shared_metadata 2739 2740 @property 2741 def share_to_recipients(self): 2742 """Gets the share_to_recipients of this FormulaTab. # noqa: E501 2743 2744 # noqa: E501 2745 2746 :return: The share_to_recipients of this FormulaTab. # noqa: E501 2747 :rtype: str 2748 """ 2749 return self._share_to_recipients 2750 2751 @share_to_recipients.setter 2752 def share_to_recipients(self, share_to_recipients): 2753 """Sets the share_to_recipients of this FormulaTab. 2754 2755 # noqa: E501 2756 2757 :param share_to_recipients: The share_to_recipients of this FormulaTab. # noqa: E501 2758 :type: str 2759 """ 2760 2761 self._share_to_recipients = share_to_recipients 2762 2763 @property 2764 def share_to_recipients_metadata(self): 2765 """Gets the share_to_recipients_metadata of this FormulaTab. # noqa: E501 2766 2767 Reserved for DocuSign. # noqa: E501 2768 2769 :return: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2770 :rtype: PropertyMetadata 2771 """ 2772 return self._share_to_recipients_metadata 2773 2774 @share_to_recipients_metadata.setter 2775 def share_to_recipients_metadata(self, share_to_recipients_metadata): 2776 """Sets the share_to_recipients_metadata of this FormulaTab. 2777 2778 Reserved for DocuSign. # noqa: E501 2779 2780 :param share_to_recipients_metadata: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2781 :type: PropertyMetadata 2782 """ 2783 2784 self._share_to_recipients_metadata = share_to_recipients_metadata 2785 2786 @property 2787 def smart_contract_information(self): 2788 """Gets the smart_contract_information of this FormulaTab. # noqa: E501 2789 2790 Reserved for DocuSign. # noqa: E501 2791 2792 :return: The smart_contract_information of this FormulaTab. # noqa: E501 2793 :rtype: SmartContractInformation 2794 """ 2795 return self._smart_contract_information 2796 2797 @smart_contract_information.setter 2798 def smart_contract_information(self, smart_contract_information): 2799 """Sets the smart_contract_information of this FormulaTab. 2800 2801 Reserved for DocuSign. # noqa: E501 2802 2803 :param smart_contract_information: The smart_contract_information of this FormulaTab. # noqa: E501 2804 :type: SmartContractInformation 2805 """ 2806 2807 self._smart_contract_information = smart_contract_information 2808 2809 @property 2810 def source(self): 2811 """Gets the source of this FormulaTab. # noqa: E501 2812 2813 # noqa: E501 2814 2815 :return: The source of this FormulaTab. # noqa: E501 2816 :rtype: str 2817 """ 2818 return self._source 2819 2820 @source.setter 2821 def source(self, source): 2822 """Sets the source of this FormulaTab. 2823 2824 # noqa: E501 2825 2826 :param source: The source of this FormulaTab. # noqa: E501 2827 :type: str 2828 """ 2829 2830 self._source = source 2831 2832 @property 2833 def status(self): 2834 """Gets the status of this FormulaTab. # noqa: E501 2835 2836 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 2837 2838 :return: The status of this FormulaTab. # noqa: E501 2839 :rtype: str 2840 """ 2841 return self._status 2842 2843 @status.setter 2844 def status(self, status): 2845 """Sets the status of this FormulaTab. 2846 2847 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 2848 2849 :param status: The status of this FormulaTab. # noqa: E501 2850 :type: str 2851 """ 2852 2853 self._status = status 2854 2855 @property 2856 def status_metadata(self): 2857 """Gets the status_metadata of this FormulaTab. # noqa: E501 2858 2859 Metadata that indicates whether the `status` property is editable. # noqa: E501 2860 2861 :return: The status_metadata of this FormulaTab. # noqa: E501 2862 :rtype: PropertyMetadata 2863 """ 2864 return self._status_metadata 2865 2866 @status_metadata.setter 2867 def status_metadata(self, status_metadata): 2868 """Sets the status_metadata of this FormulaTab. 2869 2870 Metadata that indicates whether the `status` property is editable. # noqa: E501 2871 2872 :param status_metadata: The status_metadata of this FormulaTab. # noqa: E501 2873 :type: PropertyMetadata 2874 """ 2875 2876 self._status_metadata = status_metadata 2877 2878 @property 2879 def tab_fully_qualified_path(self): 2880 """Gets the tab_fully_qualified_path of this FormulaTab. # noqa: E501 2881 2882 # noqa: E501 2883 2884 :return: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2885 :rtype: str 2886 """ 2887 return self._tab_fully_qualified_path 2888 2889 @tab_fully_qualified_path.setter 2890 def tab_fully_qualified_path(self, tab_fully_qualified_path): 2891 """Sets the tab_fully_qualified_path of this FormulaTab. 2892 2893 # noqa: E501 2894 2895 :param tab_fully_qualified_path: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2896 :type: str 2897 """ 2898 2899 self._tab_fully_qualified_path = tab_fully_qualified_path 2900 2901 @property 2902 def tab_group_labels(self): 2903 """Gets the tab_group_labels of this FormulaTab. # noqa: E501 2904 2905 # noqa: E501 2906 2907 :return: The tab_group_labels of this FormulaTab. # noqa: E501 2908 :rtype: list[str] 2909 """ 2910 return self._tab_group_labels 2911 2912 @tab_group_labels.setter 2913 def tab_group_labels(self, tab_group_labels): 2914 """Sets the tab_group_labels of this FormulaTab. 2915 2916 # noqa: E501 2917 2918 :param tab_group_labels: The tab_group_labels of this FormulaTab. # noqa: E501 2919 :type: list[str] 2920 """ 2921 2922 self._tab_group_labels = tab_group_labels 2923 2924 @property 2925 def tab_group_labels_metadata(self): 2926 """Gets the tab_group_labels_metadata of this FormulaTab. # noqa: E501 2927 2928 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2929 2930 :return: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2931 :rtype: PropertyMetadata 2932 """ 2933 return self._tab_group_labels_metadata 2934 2935 @tab_group_labels_metadata.setter 2936 def tab_group_labels_metadata(self, tab_group_labels_metadata): 2937 """Sets the tab_group_labels_metadata of this FormulaTab. 2938 2939 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2940 2941 :param tab_group_labels_metadata: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2942 :type: PropertyMetadata 2943 """ 2944 2945 self._tab_group_labels_metadata = tab_group_labels_metadata 2946 2947 @property 2948 def tab_id(self): 2949 """Gets the tab_id of this FormulaTab. # noqa: E501 2950 2951 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2952 2953 :return: The tab_id of this FormulaTab. # noqa: E501 2954 :rtype: str 2955 """ 2956 return self._tab_id 2957 2958 @tab_id.setter 2959 def tab_id(self, tab_id): 2960 """Sets the tab_id of this FormulaTab. 2961 2962 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2963 2964 :param tab_id: The tab_id of this FormulaTab. # noqa: E501 2965 :type: str 2966 """ 2967 2968 self._tab_id = tab_id 2969 2970 @property 2971 def tab_id_metadata(self): 2972 """Gets the tab_id_metadata of this FormulaTab. # noqa: E501 2973 2974 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2975 2976 :return: The tab_id_metadata of this FormulaTab. # noqa: E501 2977 :rtype: PropertyMetadata 2978 """ 2979 return self._tab_id_metadata 2980 2981 @tab_id_metadata.setter 2982 def tab_id_metadata(self, tab_id_metadata): 2983 """Sets the tab_id_metadata of this FormulaTab. 2984 2985 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2986 2987 :param tab_id_metadata: The tab_id_metadata of this FormulaTab. # noqa: E501 2988 :type: PropertyMetadata 2989 """ 2990 2991 self._tab_id_metadata = tab_id_metadata 2992 2993 @property 2994 def tab_label(self): 2995 """Gets the tab_label of this FormulaTab. # noqa: E501 2996 2997 The label string associated with the tab. # noqa: E501 2998 2999 :return: The tab_label of this FormulaTab. # noqa: E501 3000 :rtype: str 3001 """ 3002 return self._tab_label 3003 3004 @tab_label.setter 3005 def tab_label(self, tab_label): 3006 """Sets the tab_label of this FormulaTab. 3007 3008 The label string associated with the tab. # noqa: E501 3009 3010 :param tab_label: The tab_label of this FormulaTab. # noqa: E501 3011 :type: str 3012 """ 3013 3014 self._tab_label = tab_label 3015 3016 @property 3017 def tab_label_metadata(self): 3018 """Gets the tab_label_metadata of this FormulaTab. # noqa: E501 3019 3020 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 3021 3022 :return: The tab_label_metadata of this FormulaTab. # noqa: E501 3023 :rtype: PropertyMetadata 3024 """ 3025 return self._tab_label_metadata 3026 3027 @tab_label_metadata.setter 3028 def tab_label_metadata(self, tab_label_metadata): 3029 """Sets the tab_label_metadata of this FormulaTab. 3030 3031 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 3032 3033 :param tab_label_metadata: The tab_label_metadata of this FormulaTab. # noqa: E501 3034 :type: PropertyMetadata 3035 """ 3036 3037 self._tab_label_metadata = tab_label_metadata 3038 3039 @property 3040 def tab_order(self): 3041 """Gets the tab_order of this FormulaTab. # noqa: E501 3042 3043 # noqa: E501 3044 3045 :return: The tab_order of this FormulaTab. # noqa: E501 3046 :rtype: str 3047 """ 3048 return self._tab_order 3049 3050 @tab_order.setter 3051 def tab_order(self, tab_order): 3052 """Sets the tab_order of this FormulaTab. 3053 3054 # noqa: E501 3055 3056 :param tab_order: The tab_order of this FormulaTab. # noqa: E501 3057 :type: str 3058 """ 3059 3060 self._tab_order = tab_order 3061 3062 @property 3063 def tab_order_metadata(self): 3064 """Gets the tab_order_metadata of this FormulaTab. # noqa: E501 3065 3066 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3067 3068 :return: The tab_order_metadata of this FormulaTab. # noqa: E501 3069 :rtype: PropertyMetadata 3070 """ 3071 return self._tab_order_metadata 3072 3073 @tab_order_metadata.setter 3074 def tab_order_metadata(self, tab_order_metadata): 3075 """Sets the tab_order_metadata of this FormulaTab. 3076 3077 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3078 3079 :param tab_order_metadata: The tab_order_metadata of this FormulaTab. # noqa: E501 3080 :type: PropertyMetadata 3081 """ 3082 3083 self._tab_order_metadata = tab_order_metadata 3084 3085 @property 3086 def tab_type(self): 3087 """Gets the tab_type of this FormulaTab. # noqa: E501 3088 3089 # noqa: E501 3090 3091 :return: The tab_type of this FormulaTab. # noqa: E501 3092 :rtype: str 3093 """ 3094 return self._tab_type 3095 3096 @tab_type.setter 3097 def tab_type(self, tab_type): 3098 """Sets the tab_type of this FormulaTab. 3099 3100 # noqa: E501 3101 3102 :param tab_type: The tab_type of this FormulaTab. # noqa: E501 3103 :type: str 3104 """ 3105 3106 self._tab_type = tab_type 3107 3108 @property 3109 def tab_type_metadata(self): 3110 """Gets the tab_type_metadata of this FormulaTab. # noqa: E501 3111 3112 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3113 3114 :return: The tab_type_metadata of this FormulaTab. # noqa: E501 3115 :rtype: PropertyMetadata 3116 """ 3117 return self._tab_type_metadata 3118 3119 @tab_type_metadata.setter 3120 def tab_type_metadata(self, tab_type_metadata): 3121 """Sets the tab_type_metadata of this FormulaTab. 3122 3123 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3124 3125 :param tab_type_metadata: The tab_type_metadata of this FormulaTab. # noqa: E501 3126 :type: PropertyMetadata 3127 """ 3128 3129 self._tab_type_metadata = tab_type_metadata 3130 3131 @property 3132 def template_locked(self): 3133 """Gets the template_locked of this FormulaTab. # noqa: E501 3134 3135 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3136 3137 :return: The template_locked of this FormulaTab. # noqa: E501 3138 :rtype: str 3139 """ 3140 return self._template_locked 3141 3142 @template_locked.setter 3143 def template_locked(self, template_locked): 3144 """Sets the template_locked of this FormulaTab. 3145 3146 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3147 3148 :param template_locked: The template_locked of this FormulaTab. # noqa: E501 3149 :type: str 3150 """ 3151 3152 self._template_locked = template_locked 3153 3154 @property 3155 def template_locked_metadata(self): 3156 """Gets the template_locked_metadata of this FormulaTab. # noqa: E501 3157 3158 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3159 3160 :return: The template_locked_metadata of this FormulaTab. # noqa: E501 3161 :rtype: PropertyMetadata 3162 """ 3163 return self._template_locked_metadata 3164 3165 @template_locked_metadata.setter 3166 def template_locked_metadata(self, template_locked_metadata): 3167 """Sets the template_locked_metadata of this FormulaTab. 3168 3169 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3170 3171 :param template_locked_metadata: The template_locked_metadata of this FormulaTab. # noqa: E501 3172 :type: PropertyMetadata 3173 """ 3174 3175 self._template_locked_metadata = template_locked_metadata 3176 3177 @property 3178 def template_required(self): 3179 """Gets the template_required of this FormulaTab. # noqa: E501 3180 3181 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3182 3183 :return: The template_required of this FormulaTab. # noqa: E501 3184 :rtype: str 3185 """ 3186 return self._template_required 3187 3188 @template_required.setter 3189 def template_required(self, template_required): 3190 """Sets the template_required of this FormulaTab. 3191 3192 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3193 3194 :param template_required: The template_required of this FormulaTab. # noqa: E501 3195 :type: str 3196 """ 3197 3198 self._template_required = template_required 3199 3200 @property 3201 def template_required_metadata(self): 3202 """Gets the template_required_metadata of this FormulaTab. # noqa: E501 3203 3204 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3205 3206 :return: The template_required_metadata of this FormulaTab. # noqa: E501 3207 :rtype: PropertyMetadata 3208 """ 3209 return self._template_required_metadata 3210 3211 @template_required_metadata.setter 3212 def template_required_metadata(self, template_required_metadata): 3213 """Sets the template_required_metadata of this FormulaTab. 3214 3215 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3216 3217 :param template_required_metadata: The template_required_metadata of this FormulaTab. # noqa: E501 3218 :type: PropertyMetadata 3219 """ 3220 3221 self._template_required_metadata = template_required_metadata 3222 3223 @property 3224 def tooltip(self): 3225 """Gets the tooltip of this FormulaTab. # noqa: E501 3226 3227 # noqa: E501 3228 3229 :return: The tooltip of this FormulaTab. # noqa: E501 3230 :rtype: str 3231 """ 3232 return self._tooltip 3233 3234 @tooltip.setter 3235 def tooltip(self, tooltip): 3236 """Sets the tooltip of this FormulaTab. 3237 3238 # noqa: E501 3239 3240 :param tooltip: The tooltip of this FormulaTab. # noqa: E501 3241 :type: str 3242 """ 3243 3244 self._tooltip = tooltip 3245 3246 @property 3247 def tool_tip_metadata(self): 3248 """Gets the tool_tip_metadata of this FormulaTab. # noqa: E501 3249 3250 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3251 3252 :return: The tool_tip_metadata of this FormulaTab. # noqa: E501 3253 :rtype: PropertyMetadata 3254 """ 3255 return self._tool_tip_metadata 3256 3257 @tool_tip_metadata.setter 3258 def tool_tip_metadata(self, tool_tip_metadata): 3259 """Sets the tool_tip_metadata of this FormulaTab. 3260 3261 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3262 3263 :param tool_tip_metadata: The tool_tip_metadata of this FormulaTab. # noqa: E501 3264 :type: PropertyMetadata 3265 """ 3266 3267 self._tool_tip_metadata = tool_tip_metadata 3268 3269 @property 3270 def underline(self): 3271 """Gets the underline of this FormulaTab. # noqa: E501 3272 3273 When set to **true**, the information in the tab is underlined. # noqa: E501 3274 3275 :return: The underline of this FormulaTab. # noqa: E501 3276 :rtype: str 3277 """ 3278 return self._underline 3279 3280 @underline.setter 3281 def underline(self, underline): 3282 """Sets the underline of this FormulaTab. 3283 3284 When set to **true**, the information in the tab is underlined. # noqa: E501 3285 3286 :param underline: The underline of this FormulaTab. # noqa: E501 3287 :type: str 3288 """ 3289 3290 self._underline = underline 3291 3292 @property 3293 def underline_metadata(self): 3294 """Gets the underline_metadata of this FormulaTab. # noqa: E501 3295 3296 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3297 3298 :return: The underline_metadata of this FormulaTab. # noqa: E501 3299 :rtype: PropertyMetadata 3300 """ 3301 return self._underline_metadata 3302 3303 @underline_metadata.setter 3304 def underline_metadata(self, underline_metadata): 3305 """Sets the underline_metadata of this FormulaTab. 3306 3307 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3308 3309 :param underline_metadata: The underline_metadata of this FormulaTab. # noqa: E501 3310 :type: PropertyMetadata 3311 """ 3312 3313 self._underline_metadata = underline_metadata 3314 3315 @property 3316 def validation_message(self): 3317 """Gets the validation_message of this FormulaTab. # noqa: E501 3318 3319 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3320 3321 :return: The validation_message of this FormulaTab. # noqa: E501 3322 :rtype: str 3323 """ 3324 return self._validation_message 3325 3326 @validation_message.setter 3327 def validation_message(self, validation_message): 3328 """Sets the validation_message of this FormulaTab. 3329 3330 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3331 3332 :param validation_message: The validation_message of this FormulaTab. # noqa: E501 3333 :type: str 3334 """ 3335 3336 self._validation_message = validation_message 3337 3338 @property 3339 def validation_message_metadata(self): 3340 """Gets the validation_message_metadata of this FormulaTab. # noqa: E501 3341 3342 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3343 3344 :return: The validation_message_metadata of this FormulaTab. # noqa: E501 3345 :rtype: PropertyMetadata 3346 """ 3347 return self._validation_message_metadata 3348 3349 @validation_message_metadata.setter 3350 def validation_message_metadata(self, validation_message_metadata): 3351 """Sets the validation_message_metadata of this FormulaTab. 3352 3353 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3354 3355 :param validation_message_metadata: The validation_message_metadata of this FormulaTab. # noqa: E501 3356 :type: PropertyMetadata 3357 """ 3358 3359 self._validation_message_metadata = validation_message_metadata 3360 3361 @property 3362 def validation_pattern(self): 3363 """Gets the validation_pattern of this FormulaTab. # noqa: E501 3364 3365 A regular expression used to validate input for the tab. # noqa: E501 3366 3367 :return: The validation_pattern of this FormulaTab. # noqa: E501 3368 :rtype: str 3369 """ 3370 return self._validation_pattern 3371 3372 @validation_pattern.setter 3373 def validation_pattern(self, validation_pattern): 3374 """Sets the validation_pattern of this FormulaTab. 3375 3376 A regular expression used to validate input for the tab. # noqa: E501 3377 3378 :param validation_pattern: The validation_pattern of this FormulaTab. # noqa: E501 3379 :type: str 3380 """ 3381 3382 self._validation_pattern = validation_pattern 3383 3384 @property 3385 def validation_pattern_metadata(self): 3386 """Gets the validation_pattern_metadata of this FormulaTab. # noqa: E501 3387 3388 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3389 3390 :return: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3391 :rtype: PropertyMetadata 3392 """ 3393 return self._validation_pattern_metadata 3394 3395 @validation_pattern_metadata.setter 3396 def validation_pattern_metadata(self, validation_pattern_metadata): 3397 """Sets the validation_pattern_metadata of this FormulaTab. 3398 3399 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3400 3401 :param validation_pattern_metadata: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3402 :type: PropertyMetadata 3403 """ 3404 3405 self._validation_pattern_metadata = validation_pattern_metadata 3406 3407 @property 3408 def value(self): 3409 """Gets the value of this FormulaTab. # noqa: E501 3410 3411 Specifies the value of the tab. # noqa: E501 3412 3413 :return: The value of this FormulaTab. # noqa: E501 3414 :rtype: str 3415 """ 3416 return self._value 3417 3418 @value.setter 3419 def value(self, value): 3420 """Sets the value of this FormulaTab. 3421 3422 Specifies the value of the tab. # noqa: E501 3423 3424 :param value: The value of this FormulaTab. # noqa: E501 3425 :type: str 3426 """ 3427 3428 self._value = value 3429 3430 @property 3431 def value_metadata(self): 3432 """Gets the value_metadata of this FormulaTab. # noqa: E501 3433 3434 Metadata that indicates whether the `value` property is editable. # noqa: E501 3435 3436 :return: The value_metadata of this FormulaTab. # noqa: E501 3437 :rtype: PropertyMetadata 3438 """ 3439 return self._value_metadata 3440 3441 @value_metadata.setter 3442 def value_metadata(self, value_metadata): 3443 """Sets the value_metadata of this FormulaTab. 3444 3445 Metadata that indicates whether the `value` property is editable. # noqa: E501 3446 3447 :param value_metadata: The value_metadata of this FormulaTab. # noqa: E501 3448 :type: PropertyMetadata 3449 """ 3450 3451 self._value_metadata = value_metadata 3452 3453 @property 3454 def warning_details(self): 3455 """Gets the warning_details of this FormulaTab. # noqa: E501 3456 3457 # noqa: E501 3458 3459 :return: The warning_details of this FormulaTab. # noqa: E501 3460 :rtype: ErrorDetails 3461 """ 3462 return self._warning_details 3463 3464 @warning_details.setter 3465 def warning_details(self, warning_details): 3466 """Sets the warning_details of this FormulaTab. 3467 3468 # noqa: E501 3469 3470 :param warning_details: The warning_details of this FormulaTab. # noqa: E501 3471 :type: ErrorDetails 3472 """ 3473 3474 self._warning_details = warning_details 3475 3476 @property 3477 def width(self): 3478 """Gets the width of this FormulaTab. # noqa: E501 3479 3480 Width of the tab in pixels. # noqa: E501 3481 3482 :return: The width of this FormulaTab. # noqa: E501 3483 :rtype: str 3484 """ 3485 return self._width 3486 3487 @width.setter 3488 def width(self, width): 3489 """Sets the width of this FormulaTab. 3490 3491 Width of the tab in pixels. # noqa: E501 3492 3493 :param width: The width of this FormulaTab. # noqa: E501 3494 :type: str 3495 """ 3496 3497 self._width = width 3498 3499 @property 3500 def width_metadata(self): 3501 """Gets the width_metadata of this FormulaTab. # noqa: E501 3502 3503 Metadata that indicates whether the `width` property is editable. # noqa: E501 3504 3505 :return: The width_metadata of this FormulaTab. # noqa: E501 3506 :rtype: PropertyMetadata 3507 """ 3508 return self._width_metadata 3509 3510 @width_metadata.setter 3511 def width_metadata(self, width_metadata): 3512 """Sets the width_metadata of this FormulaTab. 3513 3514 Metadata that indicates whether the `width` property is editable. # noqa: E501 3515 3516 :param width_metadata: The width_metadata of this FormulaTab. # noqa: E501 3517 :type: PropertyMetadata 3518 """ 3519 3520 self._width_metadata = width_metadata 3521 3522 @property 3523 def x_position(self): 3524 """Gets the x_position of this FormulaTab. # noqa: E501 3525 3526 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3527 3528 :return: The x_position of this FormulaTab. # noqa: E501 3529 :rtype: str 3530 """ 3531 return self._x_position 3532 3533 @x_position.setter 3534 def x_position(self, x_position): 3535 """Sets the x_position of this FormulaTab. 3536 3537 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3538 3539 :param x_position: The x_position of this FormulaTab. # noqa: E501 3540 :type: str 3541 """ 3542 3543 self._x_position = x_position 3544 3545 @property 3546 def x_position_metadata(self): 3547 """Gets the x_position_metadata of this FormulaTab. # noqa: E501 3548 3549 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3550 3551 :return: The x_position_metadata of this FormulaTab. # noqa: E501 3552 :rtype: PropertyMetadata 3553 """ 3554 return self._x_position_metadata 3555 3556 @x_position_metadata.setter 3557 def x_position_metadata(self, x_position_metadata): 3558 """Sets the x_position_metadata of this FormulaTab. 3559 3560 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3561 3562 :param x_position_metadata: The x_position_metadata of this FormulaTab. # noqa: E501 3563 :type: PropertyMetadata 3564 """ 3565 3566 self._x_position_metadata = x_position_metadata 3567 3568 @property 3569 def y_position(self): 3570 """Gets the y_position of this FormulaTab. # noqa: E501 3571 3572 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3573 3574 :return: The y_position of this FormulaTab. # noqa: E501 3575 :rtype: str 3576 """ 3577 return self._y_position 3578 3579 @y_position.setter 3580 def y_position(self, y_position): 3581 """Sets the y_position of this FormulaTab. 3582 3583 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3584 3585 :param y_position: The y_position of this FormulaTab. # noqa: E501 3586 :type: str 3587 """ 3588 3589 self._y_position = y_position 3590 3591 @property 3592 def y_position_metadata(self): 3593 """Gets the y_position_metadata of this FormulaTab. # noqa: E501 3594 3595 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3596 3597 :return: The y_position_metadata of this FormulaTab. # noqa: E501 3598 :rtype: PropertyMetadata 3599 """ 3600 return self._y_position_metadata 3601 3602 @y_position_metadata.setter 3603 def y_position_metadata(self, y_position_metadata): 3604 """Sets the y_position_metadata of this FormulaTab. 3605 3606 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3607 3608 :param y_position_metadata: The y_position_metadata of this FormulaTab. # noqa: E501 3609 :type: PropertyMetadata 3610 """ 3611 3612 self._y_position_metadata = y_position_metadata 3613 3614 def to_dict(self): 3615 """Returns the model properties as a dict""" 3616 result = {} 3617 3618 for attr, _ in six.iteritems(self.swagger_types): 3619 value = getattr(self, attr) 3620 if isinstance(value, list): 3621 result[attr] = list(map( 3622 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3623 value 3624 )) 3625 elif hasattr(value, "to_dict"): 3626 result[attr] = value.to_dict() 3627 elif isinstance(value, dict): 3628 result[attr] = dict(map( 3629 lambda item: (item[0], item[1].to_dict()) 3630 if hasattr(item[1], "to_dict") else item, 3631 value.items() 3632 )) 3633 else: 3634 result[attr] = value 3635 if issubclass(FormulaTab, dict): 3636 for key, value in self.items(): 3637 result[key] = value 3638 3639 return result 3640 3641 def to_str(self): 3642 """Returns the string representation of the model""" 3643 return pprint.pformat(self.to_dict()) 3644 3645 def __repr__(self): 3646 """For `print` and `pprint`""" 3647 return self.to_str() 3648 3649 def __eq__(self, other): 3650 """Returns true if both objects are equal""" 3651 if not isinstance(other, FormulaTab): 3652 return False 3653 3654 return self.to_dict() == other.to_dict() 3655 3656 def __ne__(self, other): 3657 """Returns true if both objects are not equal""" 3658 if not isinstance(other, FormulaTab): 3659 return True 3660 3661 return self.to_dict() != other.to_dict()
23class FormulaTab(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'agreement_attribute': 'str', 38 'agreement_attribute_locked': 'str', 39 'anchor_allow_white_space_in_characters': 'str', 40 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 41 'anchor_case_sensitive': 'str', 42 'anchor_case_sensitive_metadata': 'PropertyMetadata', 43 'anchor_horizontal_alignment': 'str', 44 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 45 'anchor_ignore_if_not_present': 'str', 46 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 47 'anchor_match_whole_word': 'str', 48 'anchor_match_whole_word_metadata': 'PropertyMetadata', 49 'anchor_string': 'str', 50 'anchor_string_metadata': 'PropertyMetadata', 51 'anchor_tab_processor_version': 'str', 52 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 53 'anchor_tab_scope': 'str', 54 'anchor_units': 'str', 55 'anchor_units_metadata': 'PropertyMetadata', 56 'anchor_x_offset': 'str', 57 'anchor_x_offset_metadata': 'PropertyMetadata', 58 'anchor_y_offset': 'str', 59 'anchor_y_offset_metadata': 'PropertyMetadata', 60 'bold': 'str', 61 'bold_metadata': 'PropertyMetadata', 62 'caption': 'str', 63 'caption_metadata': 'PropertyMetadata', 64 'conceal_value_on_document': 'str', 65 'conceal_value_on_document_metadata': 'PropertyMetadata', 66 'conditional_parent_label': 'str', 67 'conditional_parent_label_metadata': 'PropertyMetadata', 68 'conditional_parent_value': 'str', 69 'conditional_parent_value_metadata': 'PropertyMetadata', 70 'connected_object_details': 'ConnectedObjectDetails', 71 'custom_tab_id': 'str', 72 'custom_tab_id_metadata': 'PropertyMetadata', 73 'disable_auto_size': 'str', 74 'disable_auto_size_metadata': 'PropertyMetadata', 75 'document_id': 'str', 76 'document_id_metadata': 'PropertyMetadata', 77 'error_details': 'ErrorDetails', 78 'extension_data': 'ExtensionData', 79 'font': 'str', 80 'font_color': 'str', 81 'font_color_metadata': 'PropertyMetadata', 82 'font_metadata': 'PropertyMetadata', 83 'font_size': 'str', 84 'font_size_metadata': 'PropertyMetadata', 85 'form_order': 'str', 86 'form_order_metadata': 'PropertyMetadata', 87 'form_page_label': 'str', 88 'form_page_label_metadata': 'PropertyMetadata', 89 'form_page_number': 'str', 90 'form_page_number_metadata': 'PropertyMetadata', 91 'formula': 'str', 92 'formula_metadata': 'PropertyMetadata', 93 'height': 'str', 94 'height_metadata': 'PropertyMetadata', 95 'hidden': 'str', 96 'hidden_metadata': 'PropertyMetadata', 97 'is_payment_amount': 'str', 98 'is_payment_amount_metadata': 'PropertyMetadata', 99 'italic': 'str', 100 'italic_metadata': 'PropertyMetadata', 101 'locale_policy': 'LocalePolicyTab', 102 'locked': 'str', 103 'locked_metadata': 'PropertyMetadata', 104 'max_length': 'str', 105 'max_length_metadata': 'PropertyMetadata', 106 'merge_field': 'MergeField', 107 'merge_field_xml': 'str', 108 'name': 'str', 109 'name_metadata': 'PropertyMetadata', 110 'original_value': 'str', 111 'original_value_metadata': 'PropertyMetadata', 112 'page_number': 'str', 113 'page_number_metadata': 'PropertyMetadata', 114 'payment_details': 'PaymentDetails', 115 'recipient_id': 'str', 116 'recipient_id_guid': 'str', 117 'recipient_id_guid_metadata': 'PropertyMetadata', 118 'recipient_id_metadata': 'PropertyMetadata', 119 'require_all': 'str', 120 'require_all_metadata': 'PropertyMetadata', 121 'required': 'str', 122 'required_metadata': 'PropertyMetadata', 123 'require_initial_on_shared_change': 'str', 124 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 125 'round_decimal_places': 'str', 126 'round_decimal_places_metadata': 'PropertyMetadata', 127 'sender_required': 'str', 128 'sender_required_metadata': 'PropertyMetadata', 129 'shared': 'str', 130 'shared_metadata': 'PropertyMetadata', 131 'share_to_recipients': 'str', 132 'share_to_recipients_metadata': 'PropertyMetadata', 133 'smart_contract_information': 'SmartContractInformation', 134 'source': 'str', 135 'status': 'str', 136 'status_metadata': 'PropertyMetadata', 137 'tab_fully_qualified_path': 'str', 138 'tab_group_labels': 'list[str]', 139 'tab_group_labels_metadata': 'PropertyMetadata', 140 'tab_id': 'str', 141 'tab_id_metadata': 'PropertyMetadata', 142 'tab_label': 'str', 143 'tab_label_metadata': 'PropertyMetadata', 144 'tab_order': 'str', 145 'tab_order_metadata': 'PropertyMetadata', 146 'tab_type': 'str', 147 'tab_type_metadata': 'PropertyMetadata', 148 'template_locked': 'str', 149 'template_locked_metadata': 'PropertyMetadata', 150 'template_required': 'str', 151 'template_required_metadata': 'PropertyMetadata', 152 'tooltip': 'str', 153 'tool_tip_metadata': 'PropertyMetadata', 154 'underline': 'str', 155 'underline_metadata': 'PropertyMetadata', 156 'validation_message': 'str', 157 'validation_message_metadata': 'PropertyMetadata', 158 'validation_pattern': 'str', 159 'validation_pattern_metadata': 'PropertyMetadata', 160 'value': 'str', 161 'value_metadata': 'PropertyMetadata', 162 'warning_details': 'ErrorDetails', 163 'width': 'str', 164 'width_metadata': 'PropertyMetadata', 165 'x_position': 'str', 166 'x_position_metadata': 'PropertyMetadata', 167 'y_position': 'str', 168 'y_position_metadata': 'PropertyMetadata' 169 } 170 171 attribute_map = { 172 'agreement_attribute': 'agreementAttribute', 173 'agreement_attribute_locked': 'agreementAttributeLocked', 174 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 175 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 176 'anchor_case_sensitive': 'anchorCaseSensitive', 177 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 178 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 179 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 180 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 181 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 182 'anchor_match_whole_word': 'anchorMatchWholeWord', 183 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 184 'anchor_string': 'anchorString', 185 'anchor_string_metadata': 'anchorStringMetadata', 186 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 187 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 188 'anchor_tab_scope': 'anchorTabScope', 189 'anchor_units': 'anchorUnits', 190 'anchor_units_metadata': 'anchorUnitsMetadata', 191 'anchor_x_offset': 'anchorXOffset', 192 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 193 'anchor_y_offset': 'anchorYOffset', 194 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 195 'bold': 'bold', 196 'bold_metadata': 'boldMetadata', 197 'caption': 'caption', 198 'caption_metadata': 'captionMetadata', 199 'conceal_value_on_document': 'concealValueOnDocument', 200 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 201 'conditional_parent_label': 'conditionalParentLabel', 202 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 203 'conditional_parent_value': 'conditionalParentValue', 204 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 205 'connected_object_details': 'connectedObjectDetails', 206 'custom_tab_id': 'customTabId', 207 'custom_tab_id_metadata': 'customTabIdMetadata', 208 'disable_auto_size': 'disableAutoSize', 209 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 210 'document_id': 'documentId', 211 'document_id_metadata': 'documentIdMetadata', 212 'error_details': 'errorDetails', 213 'extension_data': 'extensionData', 214 'font': 'font', 215 'font_color': 'fontColor', 216 'font_color_metadata': 'fontColorMetadata', 217 'font_metadata': 'fontMetadata', 218 'font_size': 'fontSize', 219 'font_size_metadata': 'fontSizeMetadata', 220 'form_order': 'formOrder', 221 'form_order_metadata': 'formOrderMetadata', 222 'form_page_label': 'formPageLabel', 223 'form_page_label_metadata': 'formPageLabelMetadata', 224 'form_page_number': 'formPageNumber', 225 'form_page_number_metadata': 'formPageNumberMetadata', 226 'formula': 'formula', 227 'formula_metadata': 'formulaMetadata', 228 'height': 'height', 229 'height_metadata': 'heightMetadata', 230 'hidden': 'hidden', 231 'hidden_metadata': 'hiddenMetadata', 232 'is_payment_amount': 'isPaymentAmount', 233 'is_payment_amount_metadata': 'isPaymentAmountMetadata', 234 'italic': 'italic', 235 'italic_metadata': 'italicMetadata', 236 'locale_policy': 'localePolicy', 237 'locked': 'locked', 238 'locked_metadata': 'lockedMetadata', 239 'max_length': 'maxLength', 240 'max_length_metadata': 'maxLengthMetadata', 241 'merge_field': 'mergeField', 242 'merge_field_xml': 'mergeFieldXml', 243 'name': 'name', 244 'name_metadata': 'nameMetadata', 245 'original_value': 'originalValue', 246 'original_value_metadata': 'originalValueMetadata', 247 'page_number': 'pageNumber', 248 'page_number_metadata': 'pageNumberMetadata', 249 'payment_details': 'paymentDetails', 250 'recipient_id': 'recipientId', 251 'recipient_id_guid': 'recipientIdGuid', 252 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 253 'recipient_id_metadata': 'recipientIdMetadata', 254 'require_all': 'requireAll', 255 'require_all_metadata': 'requireAllMetadata', 256 'required': 'required', 257 'required_metadata': 'requiredMetadata', 258 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 259 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 260 'round_decimal_places': 'roundDecimalPlaces', 261 'round_decimal_places_metadata': 'roundDecimalPlacesMetadata', 262 'sender_required': 'senderRequired', 263 'sender_required_metadata': 'senderRequiredMetadata', 264 'shared': 'shared', 265 'shared_metadata': 'sharedMetadata', 266 'share_to_recipients': 'shareToRecipients', 267 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 268 'smart_contract_information': 'smartContractInformation', 269 'source': 'source', 270 'status': 'status', 271 'status_metadata': 'statusMetadata', 272 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 273 'tab_group_labels': 'tabGroupLabels', 274 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 275 'tab_id': 'tabId', 276 'tab_id_metadata': 'tabIdMetadata', 277 'tab_label': 'tabLabel', 278 'tab_label_metadata': 'tabLabelMetadata', 279 'tab_order': 'tabOrder', 280 'tab_order_metadata': 'tabOrderMetadata', 281 'tab_type': 'tabType', 282 'tab_type_metadata': 'tabTypeMetadata', 283 'template_locked': 'templateLocked', 284 'template_locked_metadata': 'templateLockedMetadata', 285 'template_required': 'templateRequired', 286 'template_required_metadata': 'templateRequiredMetadata', 287 'tooltip': 'tooltip', 288 'tool_tip_metadata': 'toolTipMetadata', 289 'underline': 'underline', 290 'underline_metadata': 'underlineMetadata', 291 'validation_message': 'validationMessage', 292 'validation_message_metadata': 'validationMessageMetadata', 293 'validation_pattern': 'validationPattern', 294 'validation_pattern_metadata': 'validationPatternMetadata', 295 'value': 'value', 296 'value_metadata': 'valueMetadata', 297 'warning_details': 'warningDetails', 298 'width': 'width', 299 'width_metadata': 'widthMetadata', 300 'x_position': 'xPosition', 301 'x_position_metadata': 'xPositionMetadata', 302 'y_position': 'yPosition', 303 'y_position_metadata': 'yPositionMetadata' 304 } 305 306 def __init__(self, _configuration=None, **kwargs): # noqa: E501 307 """FormulaTab - a model defined in Swagger""" # noqa: E501 308 if _configuration is None: 309 _configuration = Configuration() 310 self._configuration = _configuration 311 312 self._agreement_attribute = None 313 self._agreement_attribute_locked = None 314 self._anchor_allow_white_space_in_characters = None 315 self._anchor_allow_white_space_in_characters_metadata = None 316 self._anchor_case_sensitive = None 317 self._anchor_case_sensitive_metadata = None 318 self._anchor_horizontal_alignment = None 319 self._anchor_horizontal_alignment_metadata = None 320 self._anchor_ignore_if_not_present = None 321 self._anchor_ignore_if_not_present_metadata = None 322 self._anchor_match_whole_word = None 323 self._anchor_match_whole_word_metadata = None 324 self._anchor_string = None 325 self._anchor_string_metadata = None 326 self._anchor_tab_processor_version = None 327 self._anchor_tab_processor_version_metadata = None 328 self._anchor_tab_scope = None 329 self._anchor_units = None 330 self._anchor_units_metadata = None 331 self._anchor_x_offset = None 332 self._anchor_x_offset_metadata = None 333 self._anchor_y_offset = None 334 self._anchor_y_offset_metadata = None 335 self._bold = None 336 self._bold_metadata = None 337 self._caption = None 338 self._caption_metadata = None 339 self._conceal_value_on_document = None 340 self._conceal_value_on_document_metadata = None 341 self._conditional_parent_label = None 342 self._conditional_parent_label_metadata = None 343 self._conditional_parent_value = None 344 self._conditional_parent_value_metadata = None 345 self._connected_object_details = None 346 self._custom_tab_id = None 347 self._custom_tab_id_metadata = None 348 self._disable_auto_size = None 349 self._disable_auto_size_metadata = None 350 self._document_id = None 351 self._document_id_metadata = None 352 self._error_details = None 353 self._extension_data = None 354 self._font = None 355 self._font_color = None 356 self._font_color_metadata = None 357 self._font_metadata = None 358 self._font_size = None 359 self._font_size_metadata = None 360 self._form_order = None 361 self._form_order_metadata = None 362 self._form_page_label = None 363 self._form_page_label_metadata = None 364 self._form_page_number = None 365 self._form_page_number_metadata = None 366 self._formula = None 367 self._formula_metadata = None 368 self._height = None 369 self._height_metadata = None 370 self._hidden = None 371 self._hidden_metadata = None 372 self._is_payment_amount = None 373 self._is_payment_amount_metadata = None 374 self._italic = None 375 self._italic_metadata = None 376 self._locale_policy = None 377 self._locked = None 378 self._locked_metadata = None 379 self._max_length = None 380 self._max_length_metadata = None 381 self._merge_field = None 382 self._merge_field_xml = None 383 self._name = None 384 self._name_metadata = None 385 self._original_value = None 386 self._original_value_metadata = None 387 self._page_number = None 388 self._page_number_metadata = None 389 self._payment_details = None 390 self._recipient_id = None 391 self._recipient_id_guid = None 392 self._recipient_id_guid_metadata = None 393 self._recipient_id_metadata = None 394 self._require_all = None 395 self._require_all_metadata = None 396 self._required = None 397 self._required_metadata = None 398 self._require_initial_on_shared_change = None 399 self._require_initial_on_shared_change_metadata = None 400 self._round_decimal_places = None 401 self._round_decimal_places_metadata = None 402 self._sender_required = None 403 self._sender_required_metadata = None 404 self._shared = None 405 self._shared_metadata = None 406 self._share_to_recipients = None 407 self._share_to_recipients_metadata = None 408 self._smart_contract_information = None 409 self._source = None 410 self._status = None 411 self._status_metadata = None 412 self._tab_fully_qualified_path = None 413 self._tab_group_labels = None 414 self._tab_group_labels_metadata = None 415 self._tab_id = None 416 self._tab_id_metadata = None 417 self._tab_label = None 418 self._tab_label_metadata = None 419 self._tab_order = None 420 self._tab_order_metadata = None 421 self._tab_type = None 422 self._tab_type_metadata = None 423 self._template_locked = None 424 self._template_locked_metadata = None 425 self._template_required = None 426 self._template_required_metadata = None 427 self._tooltip = None 428 self._tool_tip_metadata = None 429 self._underline = None 430 self._underline_metadata = None 431 self._validation_message = None 432 self._validation_message_metadata = None 433 self._validation_pattern = None 434 self._validation_pattern_metadata = None 435 self._value = None 436 self._value_metadata = None 437 self._warning_details = None 438 self._width = None 439 self._width_metadata = None 440 self._x_position = None 441 self._x_position_metadata = None 442 self._y_position = None 443 self._y_position_metadata = None 444 self.discriminator = None 445 446 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 447 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 448 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 449 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 450 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 451 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 452 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 453 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 454 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 455 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 456 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 457 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 458 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 459 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 460 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 461 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 462 setattr(self, "_{}".format('anchor_tab_scope'), kwargs.get('anchor_tab_scope', None)) 463 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 464 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 465 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 466 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 467 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 468 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 469 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 470 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 471 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 472 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 473 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 474 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 475 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 476 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 477 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 478 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 479 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 480 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 481 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 482 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 483 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 484 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 485 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 486 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 487 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 488 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 489 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 490 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 491 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 492 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 493 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 494 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 495 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 496 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 497 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 498 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 499 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 500 setattr(self, "_{}".format('formula'), kwargs.get('formula', None)) 501 setattr(self, "_{}".format('formula_metadata'), kwargs.get('formula_metadata', None)) 502 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 503 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 504 setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None)) 505 setattr(self, "_{}".format('hidden_metadata'), kwargs.get('hidden_metadata', None)) 506 setattr(self, "_{}".format('is_payment_amount'), kwargs.get('is_payment_amount', None)) 507 setattr(self, "_{}".format('is_payment_amount_metadata'), kwargs.get('is_payment_amount_metadata', None)) 508 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 509 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 510 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 511 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 512 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 513 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 514 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 515 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 516 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 517 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 518 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 519 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 520 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 521 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 522 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 523 setattr(self, "_{}".format('payment_details'), kwargs.get('payment_details', None)) 524 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 525 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 526 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 527 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 528 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 529 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 530 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 531 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 532 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 533 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 534 setattr(self, "_{}".format('round_decimal_places'), kwargs.get('round_decimal_places', None)) 535 setattr(self, "_{}".format('round_decimal_places_metadata'), kwargs.get('round_decimal_places_metadata', None)) 536 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 537 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 538 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 539 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 540 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 541 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 542 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 543 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 544 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 545 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 546 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 547 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 548 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 549 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 550 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 551 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 552 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 553 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 554 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 555 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 556 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 557 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 558 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 559 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 560 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 561 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 562 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 563 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 564 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 565 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 566 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 567 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 568 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 569 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 570 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 571 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 572 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 573 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 574 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 575 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 576 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 577 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 578 579 @property 580 def agreement_attribute(self): 581 """Gets the agreement_attribute of this FormulaTab. # noqa: E501 582 583 # noqa: E501 584 585 :return: The agreement_attribute of this FormulaTab. # noqa: E501 586 :rtype: str 587 """ 588 return self._agreement_attribute 589 590 @agreement_attribute.setter 591 def agreement_attribute(self, agreement_attribute): 592 """Sets the agreement_attribute of this FormulaTab. 593 594 # noqa: E501 595 596 :param agreement_attribute: The agreement_attribute of this FormulaTab. # noqa: E501 597 :type: str 598 """ 599 600 self._agreement_attribute = agreement_attribute 601 602 @property 603 def agreement_attribute_locked(self): 604 """Gets the agreement_attribute_locked of this FormulaTab. # noqa: E501 605 606 # noqa: E501 607 608 :return: The agreement_attribute_locked of this FormulaTab. # noqa: E501 609 :rtype: str 610 """ 611 return self._agreement_attribute_locked 612 613 @agreement_attribute_locked.setter 614 def agreement_attribute_locked(self, agreement_attribute_locked): 615 """Sets the agreement_attribute_locked of this FormulaTab. 616 617 # noqa: E501 618 619 :param agreement_attribute_locked: The agreement_attribute_locked of this FormulaTab. # noqa: E501 620 :type: str 621 """ 622 623 self._agreement_attribute_locked = agreement_attribute_locked 624 625 @property 626 def anchor_allow_white_space_in_characters(self): 627 """Gets the anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 628 629 # noqa: E501 630 631 :return: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 632 :rtype: str 633 """ 634 return self._anchor_allow_white_space_in_characters 635 636 @anchor_allow_white_space_in_characters.setter 637 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 638 """Sets the anchor_allow_white_space_in_characters of this FormulaTab. 639 640 # noqa: E501 641 642 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501 643 :type: str 644 """ 645 646 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 647 648 @property 649 def anchor_allow_white_space_in_characters_metadata(self): 650 """Gets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 651 652 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 653 654 :return: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 655 :rtype: PropertyMetadata 656 """ 657 return self._anchor_allow_white_space_in_characters_metadata 658 659 @anchor_allow_white_space_in_characters_metadata.setter 660 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 661 """Sets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. 662 663 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 664 665 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501 666 :type: PropertyMetadata 667 """ 668 669 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 670 671 @property 672 def anchor_case_sensitive(self): 673 """Gets the anchor_case_sensitive of this FormulaTab. # noqa: E501 674 675 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 676 677 :return: The anchor_case_sensitive of this FormulaTab. # noqa: E501 678 :rtype: str 679 """ 680 return self._anchor_case_sensitive 681 682 @anchor_case_sensitive.setter 683 def anchor_case_sensitive(self, anchor_case_sensitive): 684 """Sets the anchor_case_sensitive of this FormulaTab. 685 686 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 687 688 :param anchor_case_sensitive: The anchor_case_sensitive of this FormulaTab. # noqa: E501 689 :type: str 690 """ 691 692 self._anchor_case_sensitive = anchor_case_sensitive 693 694 @property 695 def anchor_case_sensitive_metadata(self): 696 """Gets the anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 697 698 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 699 700 :return: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 701 :rtype: PropertyMetadata 702 """ 703 return self._anchor_case_sensitive_metadata 704 705 @anchor_case_sensitive_metadata.setter 706 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 707 """Sets the anchor_case_sensitive_metadata of this FormulaTab. 708 709 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 710 711 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501 712 :type: PropertyMetadata 713 """ 714 715 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 716 717 @property 718 def anchor_horizontal_alignment(self): 719 """Gets the anchor_horizontal_alignment of this FormulaTab. # noqa: E501 720 721 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 722 723 :return: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 724 :rtype: str 725 """ 726 return self._anchor_horizontal_alignment 727 728 @anchor_horizontal_alignment.setter 729 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 730 """Sets the anchor_horizontal_alignment of this FormulaTab. 731 732 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 733 734 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this FormulaTab. # noqa: E501 735 :type: str 736 """ 737 738 self._anchor_horizontal_alignment = anchor_horizontal_alignment 739 740 @property 741 def anchor_horizontal_alignment_metadata(self): 742 """Gets the anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 743 744 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 745 746 :return: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 747 :rtype: PropertyMetadata 748 """ 749 return self._anchor_horizontal_alignment_metadata 750 751 @anchor_horizontal_alignment_metadata.setter 752 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 753 """Sets the anchor_horizontal_alignment_metadata of this FormulaTab. 754 755 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 756 757 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501 758 :type: PropertyMetadata 759 """ 760 761 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 762 763 @property 764 def anchor_ignore_if_not_present(self): 765 """Gets the anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 766 767 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 768 769 :return: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 770 :rtype: str 771 """ 772 return self._anchor_ignore_if_not_present 773 774 @anchor_ignore_if_not_present.setter 775 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 776 """Sets the anchor_ignore_if_not_present of this FormulaTab. 777 778 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 779 780 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501 781 :type: str 782 """ 783 784 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 785 786 @property 787 def anchor_ignore_if_not_present_metadata(self): 788 """Gets the anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 789 790 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 791 792 :return: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 793 :rtype: PropertyMetadata 794 """ 795 return self._anchor_ignore_if_not_present_metadata 796 797 @anchor_ignore_if_not_present_metadata.setter 798 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 799 """Sets the anchor_ignore_if_not_present_metadata of this FormulaTab. 800 801 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 802 803 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501 804 :type: PropertyMetadata 805 """ 806 807 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 808 809 @property 810 def anchor_match_whole_word(self): 811 """Gets the anchor_match_whole_word of this FormulaTab. # noqa: E501 812 813 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 814 815 :return: The anchor_match_whole_word of this FormulaTab. # noqa: E501 816 :rtype: str 817 """ 818 return self._anchor_match_whole_word 819 820 @anchor_match_whole_word.setter 821 def anchor_match_whole_word(self, anchor_match_whole_word): 822 """Sets the anchor_match_whole_word of this FormulaTab. 823 824 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 825 826 :param anchor_match_whole_word: The anchor_match_whole_word of this FormulaTab. # noqa: E501 827 :type: str 828 """ 829 830 self._anchor_match_whole_word = anchor_match_whole_word 831 832 @property 833 def anchor_match_whole_word_metadata(self): 834 """Gets the anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 835 836 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 837 838 :return: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 839 :rtype: PropertyMetadata 840 """ 841 return self._anchor_match_whole_word_metadata 842 843 @anchor_match_whole_word_metadata.setter 844 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 845 """Sets the anchor_match_whole_word_metadata of this FormulaTab. 846 847 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 848 849 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501 850 :type: PropertyMetadata 851 """ 852 853 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 854 855 @property 856 def anchor_string(self): 857 """Gets the anchor_string of this FormulaTab. # noqa: E501 858 859 Anchor text information for a radio button. # noqa: E501 860 861 :return: The anchor_string of this FormulaTab. # noqa: E501 862 :rtype: str 863 """ 864 return self._anchor_string 865 866 @anchor_string.setter 867 def anchor_string(self, anchor_string): 868 """Sets the anchor_string of this FormulaTab. 869 870 Anchor text information for a radio button. # noqa: E501 871 872 :param anchor_string: The anchor_string of this FormulaTab. # noqa: E501 873 :type: str 874 """ 875 876 self._anchor_string = anchor_string 877 878 @property 879 def anchor_string_metadata(self): 880 """Gets the anchor_string_metadata of this FormulaTab. # noqa: E501 881 882 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 883 884 :return: The anchor_string_metadata of this FormulaTab. # noqa: E501 885 :rtype: PropertyMetadata 886 """ 887 return self._anchor_string_metadata 888 889 @anchor_string_metadata.setter 890 def anchor_string_metadata(self, anchor_string_metadata): 891 """Sets the anchor_string_metadata of this FormulaTab. 892 893 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 894 895 :param anchor_string_metadata: The anchor_string_metadata of this FormulaTab. # noqa: E501 896 :type: PropertyMetadata 897 """ 898 899 self._anchor_string_metadata = anchor_string_metadata 900 901 @property 902 def anchor_tab_processor_version(self): 903 """Gets the anchor_tab_processor_version of this FormulaTab. # noqa: E501 904 905 # noqa: E501 906 907 :return: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 908 :rtype: str 909 """ 910 return self._anchor_tab_processor_version 911 912 @anchor_tab_processor_version.setter 913 def anchor_tab_processor_version(self, anchor_tab_processor_version): 914 """Sets the anchor_tab_processor_version of this FormulaTab. 915 916 # noqa: E501 917 918 :param anchor_tab_processor_version: The anchor_tab_processor_version of this FormulaTab. # noqa: E501 919 :type: str 920 """ 921 922 self._anchor_tab_processor_version = anchor_tab_processor_version 923 924 @property 925 def anchor_tab_processor_version_metadata(self): 926 """Gets the anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 927 928 Reserved for DocuSign. # noqa: E501 929 930 :return: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 931 :rtype: PropertyMetadata 932 """ 933 return self._anchor_tab_processor_version_metadata 934 935 @anchor_tab_processor_version_metadata.setter 936 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 937 """Sets the anchor_tab_processor_version_metadata of this FormulaTab. 938 939 Reserved for DocuSign. # noqa: E501 940 941 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501 942 :type: PropertyMetadata 943 """ 944 945 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 946 947 @property 948 def anchor_tab_scope(self): 949 """Gets the anchor_tab_scope of this FormulaTab. # noqa: E501 950 951 # noqa: E501 952 953 :return: The anchor_tab_scope of this FormulaTab. # noqa: E501 954 :rtype: str 955 """ 956 return self._anchor_tab_scope 957 958 @anchor_tab_scope.setter 959 def anchor_tab_scope(self, anchor_tab_scope): 960 """Sets the anchor_tab_scope of this FormulaTab. 961 962 # noqa: E501 963 964 :param anchor_tab_scope: The anchor_tab_scope of this FormulaTab. # noqa: E501 965 :type: str 966 """ 967 968 self._anchor_tab_scope = anchor_tab_scope 969 970 @property 971 def anchor_units(self): 972 """Gets the anchor_units of this FormulaTab. # noqa: E501 973 974 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 975 976 :return: The anchor_units of this FormulaTab. # noqa: E501 977 :rtype: str 978 """ 979 return self._anchor_units 980 981 @anchor_units.setter 982 def anchor_units(self, anchor_units): 983 """Sets the anchor_units of this FormulaTab. 984 985 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 986 987 :param anchor_units: The anchor_units of this FormulaTab. # noqa: E501 988 :type: str 989 """ 990 991 self._anchor_units = anchor_units 992 993 @property 994 def anchor_units_metadata(self): 995 """Gets the anchor_units_metadata of this FormulaTab. # noqa: E501 996 997 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 998 999 :return: The anchor_units_metadata of this FormulaTab. # noqa: E501 1000 :rtype: PropertyMetadata 1001 """ 1002 return self._anchor_units_metadata 1003 1004 @anchor_units_metadata.setter 1005 def anchor_units_metadata(self, anchor_units_metadata): 1006 """Sets the anchor_units_metadata of this FormulaTab. 1007 1008 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 1009 1010 :param anchor_units_metadata: The anchor_units_metadata of this FormulaTab. # noqa: E501 1011 :type: PropertyMetadata 1012 """ 1013 1014 self._anchor_units_metadata = anchor_units_metadata 1015 1016 @property 1017 def anchor_x_offset(self): 1018 """Gets the anchor_x_offset of this FormulaTab. # noqa: E501 1019 1020 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1021 1022 :return: The anchor_x_offset of this FormulaTab. # noqa: E501 1023 :rtype: str 1024 """ 1025 return self._anchor_x_offset 1026 1027 @anchor_x_offset.setter 1028 def anchor_x_offset(self, anchor_x_offset): 1029 """Sets the anchor_x_offset of this FormulaTab. 1030 1031 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1032 1033 :param anchor_x_offset: The anchor_x_offset of this FormulaTab. # noqa: E501 1034 :type: str 1035 """ 1036 1037 self._anchor_x_offset = anchor_x_offset 1038 1039 @property 1040 def anchor_x_offset_metadata(self): 1041 """Gets the anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1042 1043 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1044 1045 :return: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1046 :rtype: PropertyMetadata 1047 """ 1048 return self._anchor_x_offset_metadata 1049 1050 @anchor_x_offset_metadata.setter 1051 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 1052 """Sets the anchor_x_offset_metadata of this FormulaTab. 1053 1054 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1055 1056 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this FormulaTab. # noqa: E501 1057 :type: PropertyMetadata 1058 """ 1059 1060 self._anchor_x_offset_metadata = anchor_x_offset_metadata 1061 1062 @property 1063 def anchor_y_offset(self): 1064 """Gets the anchor_y_offset of this FormulaTab. # noqa: E501 1065 1066 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1067 1068 :return: The anchor_y_offset of this FormulaTab. # noqa: E501 1069 :rtype: str 1070 """ 1071 return self._anchor_y_offset 1072 1073 @anchor_y_offset.setter 1074 def anchor_y_offset(self, anchor_y_offset): 1075 """Sets the anchor_y_offset of this FormulaTab. 1076 1077 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1078 1079 :param anchor_y_offset: The anchor_y_offset of this FormulaTab. # noqa: E501 1080 :type: str 1081 """ 1082 1083 self._anchor_y_offset = anchor_y_offset 1084 1085 @property 1086 def anchor_y_offset_metadata(self): 1087 """Gets the anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1088 1089 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1090 1091 :return: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1092 :rtype: PropertyMetadata 1093 """ 1094 return self._anchor_y_offset_metadata 1095 1096 @anchor_y_offset_metadata.setter 1097 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 1098 """Sets the anchor_y_offset_metadata of this FormulaTab. 1099 1100 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1101 1102 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this FormulaTab. # noqa: E501 1103 :type: PropertyMetadata 1104 """ 1105 1106 self._anchor_y_offset_metadata = anchor_y_offset_metadata 1107 1108 @property 1109 def bold(self): 1110 """Gets the bold of this FormulaTab. # noqa: E501 1111 1112 When set to **true**, the information in the tab is bold. # noqa: E501 1113 1114 :return: The bold of this FormulaTab. # noqa: E501 1115 :rtype: str 1116 """ 1117 return self._bold 1118 1119 @bold.setter 1120 def bold(self, bold): 1121 """Sets the bold of this FormulaTab. 1122 1123 When set to **true**, the information in the tab is bold. # noqa: E501 1124 1125 :param bold: The bold of this FormulaTab. # noqa: E501 1126 :type: str 1127 """ 1128 1129 self._bold = bold 1130 1131 @property 1132 def bold_metadata(self): 1133 """Gets the bold_metadata of this FormulaTab. # noqa: E501 1134 1135 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1136 1137 :return: The bold_metadata of this FormulaTab. # noqa: E501 1138 :rtype: PropertyMetadata 1139 """ 1140 return self._bold_metadata 1141 1142 @bold_metadata.setter 1143 def bold_metadata(self, bold_metadata): 1144 """Sets the bold_metadata of this FormulaTab. 1145 1146 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1147 1148 :param bold_metadata: The bold_metadata of this FormulaTab. # noqa: E501 1149 :type: PropertyMetadata 1150 """ 1151 1152 self._bold_metadata = bold_metadata 1153 1154 @property 1155 def caption(self): 1156 """Gets the caption of this FormulaTab. # noqa: E501 1157 1158 # noqa: E501 1159 1160 :return: The caption of this FormulaTab. # noqa: E501 1161 :rtype: str 1162 """ 1163 return self._caption 1164 1165 @caption.setter 1166 def caption(self, caption): 1167 """Sets the caption of this FormulaTab. 1168 1169 # noqa: E501 1170 1171 :param caption: The caption of this FormulaTab. # noqa: E501 1172 :type: str 1173 """ 1174 1175 self._caption = caption 1176 1177 @property 1178 def caption_metadata(self): 1179 """Gets the caption_metadata of this FormulaTab. # noqa: E501 1180 1181 # noqa: E501 1182 1183 :return: The caption_metadata of this FormulaTab. # noqa: E501 1184 :rtype: PropertyMetadata 1185 """ 1186 return self._caption_metadata 1187 1188 @caption_metadata.setter 1189 def caption_metadata(self, caption_metadata): 1190 """Sets the caption_metadata of this FormulaTab. 1191 1192 # noqa: E501 1193 1194 :param caption_metadata: The caption_metadata of this FormulaTab. # noqa: E501 1195 :type: PropertyMetadata 1196 """ 1197 1198 self._caption_metadata = caption_metadata 1199 1200 @property 1201 def conceal_value_on_document(self): 1202 """Gets the conceal_value_on_document of this FormulaTab. # noqa: E501 1203 1204 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 1205 1206 :return: The conceal_value_on_document of this FormulaTab. # noqa: E501 1207 :rtype: str 1208 """ 1209 return self._conceal_value_on_document 1210 1211 @conceal_value_on_document.setter 1212 def conceal_value_on_document(self, conceal_value_on_document): 1213 """Sets the conceal_value_on_document of this FormulaTab. 1214 1215 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 1216 1217 :param conceal_value_on_document: The conceal_value_on_document of this FormulaTab. # noqa: E501 1218 :type: str 1219 """ 1220 1221 self._conceal_value_on_document = conceal_value_on_document 1222 1223 @property 1224 def conceal_value_on_document_metadata(self): 1225 """Gets the conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1226 1227 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1228 1229 :return: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1230 :rtype: PropertyMetadata 1231 """ 1232 return self._conceal_value_on_document_metadata 1233 1234 @conceal_value_on_document_metadata.setter 1235 def conceal_value_on_document_metadata(self, conceal_value_on_document_metadata): 1236 """Sets the conceal_value_on_document_metadata of this FormulaTab. 1237 1238 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1239 1240 :param conceal_value_on_document_metadata: The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501 1241 :type: PropertyMetadata 1242 """ 1243 1244 self._conceal_value_on_document_metadata = conceal_value_on_document_metadata 1245 1246 @property 1247 def conditional_parent_label(self): 1248 """Gets the conditional_parent_label of this FormulaTab. # noqa: E501 1249 1250 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1251 1252 :return: The conditional_parent_label of this FormulaTab. # noqa: E501 1253 :rtype: str 1254 """ 1255 return self._conditional_parent_label 1256 1257 @conditional_parent_label.setter 1258 def conditional_parent_label(self, conditional_parent_label): 1259 """Sets the conditional_parent_label of this FormulaTab. 1260 1261 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1262 1263 :param conditional_parent_label: The conditional_parent_label of this FormulaTab. # noqa: E501 1264 :type: str 1265 """ 1266 1267 self._conditional_parent_label = conditional_parent_label 1268 1269 @property 1270 def conditional_parent_label_metadata(self): 1271 """Gets the conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1272 1273 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1274 1275 :return: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1276 :rtype: PropertyMetadata 1277 """ 1278 return self._conditional_parent_label_metadata 1279 1280 @conditional_parent_label_metadata.setter 1281 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 1282 """Sets the conditional_parent_label_metadata of this FormulaTab. 1283 1284 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1285 1286 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this FormulaTab. # noqa: E501 1287 :type: PropertyMetadata 1288 """ 1289 1290 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1291 1292 @property 1293 def conditional_parent_value(self): 1294 """Gets the conditional_parent_value of this FormulaTab. # noqa: E501 1295 1296 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1297 1298 :return: The conditional_parent_value of this FormulaTab. # noqa: E501 1299 :rtype: str 1300 """ 1301 return self._conditional_parent_value 1302 1303 @conditional_parent_value.setter 1304 def conditional_parent_value(self, conditional_parent_value): 1305 """Sets the conditional_parent_value of this FormulaTab. 1306 1307 For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. # noqa: E501 1308 1309 :param conditional_parent_value: The conditional_parent_value of this FormulaTab. # noqa: E501 1310 :type: str 1311 """ 1312 1313 self._conditional_parent_value = conditional_parent_value 1314 1315 @property 1316 def conditional_parent_value_metadata(self): 1317 """Gets the conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1318 1319 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1320 1321 :return: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1322 :rtype: PropertyMetadata 1323 """ 1324 return self._conditional_parent_value_metadata 1325 1326 @conditional_parent_value_metadata.setter 1327 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1328 """Sets the conditional_parent_value_metadata of this FormulaTab. 1329 1330 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1331 1332 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this FormulaTab. # noqa: E501 1333 :type: PropertyMetadata 1334 """ 1335 1336 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1337 1338 @property 1339 def connected_object_details(self): 1340 """Gets the connected_object_details of this FormulaTab. # noqa: E501 1341 1342 # noqa: E501 1343 1344 :return: The connected_object_details of this FormulaTab. # noqa: E501 1345 :rtype: ConnectedObjectDetails 1346 """ 1347 return self._connected_object_details 1348 1349 @connected_object_details.setter 1350 def connected_object_details(self, connected_object_details): 1351 """Sets the connected_object_details of this FormulaTab. 1352 1353 # noqa: E501 1354 1355 :param connected_object_details: The connected_object_details of this FormulaTab. # noqa: E501 1356 :type: ConnectedObjectDetails 1357 """ 1358 1359 self._connected_object_details = connected_object_details 1360 1361 @property 1362 def custom_tab_id(self): 1363 """Gets the custom_tab_id of this FormulaTab. # noqa: E501 1364 1365 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 1366 1367 :return: The custom_tab_id of this FormulaTab. # noqa: E501 1368 :rtype: str 1369 """ 1370 return self._custom_tab_id 1371 1372 @custom_tab_id.setter 1373 def custom_tab_id(self, custom_tab_id): 1374 """Sets the custom_tab_id of this FormulaTab. 1375 1376 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 1377 1378 :param custom_tab_id: The custom_tab_id of this FormulaTab. # noqa: E501 1379 :type: str 1380 """ 1381 1382 self._custom_tab_id = custom_tab_id 1383 1384 @property 1385 def custom_tab_id_metadata(self): 1386 """Gets the custom_tab_id_metadata of this FormulaTab. # noqa: E501 1387 1388 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1389 1390 :return: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1391 :rtype: PropertyMetadata 1392 """ 1393 return self._custom_tab_id_metadata 1394 1395 @custom_tab_id_metadata.setter 1396 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1397 """Sets the custom_tab_id_metadata of this FormulaTab. 1398 1399 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1400 1401 :param custom_tab_id_metadata: The custom_tab_id_metadata of this FormulaTab. # noqa: E501 1402 :type: PropertyMetadata 1403 """ 1404 1405 self._custom_tab_id_metadata = custom_tab_id_metadata 1406 1407 @property 1408 def disable_auto_size(self): 1409 """Gets the disable_auto_size of this FormulaTab. # noqa: E501 1410 1411 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 1412 1413 :return: The disable_auto_size of this FormulaTab. # noqa: E501 1414 :rtype: str 1415 """ 1416 return self._disable_auto_size 1417 1418 @disable_auto_size.setter 1419 def disable_auto_size(self, disable_auto_size): 1420 """Sets the disable_auto_size of this FormulaTab. 1421 1422 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 1423 1424 :param disable_auto_size: The disable_auto_size of this FormulaTab. # noqa: E501 1425 :type: str 1426 """ 1427 1428 self._disable_auto_size = disable_auto_size 1429 1430 @property 1431 def disable_auto_size_metadata(self): 1432 """Gets the disable_auto_size_metadata of this FormulaTab. # noqa: E501 1433 1434 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1435 1436 :return: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1437 :rtype: PropertyMetadata 1438 """ 1439 return self._disable_auto_size_metadata 1440 1441 @disable_auto_size_metadata.setter 1442 def disable_auto_size_metadata(self, disable_auto_size_metadata): 1443 """Sets the disable_auto_size_metadata of this FormulaTab. 1444 1445 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1446 1447 :param disable_auto_size_metadata: The disable_auto_size_metadata of this FormulaTab. # noqa: E501 1448 :type: PropertyMetadata 1449 """ 1450 1451 self._disable_auto_size_metadata = disable_auto_size_metadata 1452 1453 @property 1454 def document_id(self): 1455 """Gets the document_id of this FormulaTab. # noqa: E501 1456 1457 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1458 1459 :return: The document_id of this FormulaTab. # noqa: E501 1460 :rtype: str 1461 """ 1462 return self._document_id 1463 1464 @document_id.setter 1465 def document_id(self, document_id): 1466 """Sets the document_id of this FormulaTab. 1467 1468 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1469 1470 :param document_id: The document_id of this FormulaTab. # noqa: E501 1471 :type: str 1472 """ 1473 1474 self._document_id = document_id 1475 1476 @property 1477 def document_id_metadata(self): 1478 """Gets the document_id_metadata of this FormulaTab. # noqa: E501 1479 1480 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1481 1482 :return: The document_id_metadata of this FormulaTab. # noqa: E501 1483 :rtype: PropertyMetadata 1484 """ 1485 return self._document_id_metadata 1486 1487 @document_id_metadata.setter 1488 def document_id_metadata(self, document_id_metadata): 1489 """Sets the document_id_metadata of this FormulaTab. 1490 1491 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1492 1493 :param document_id_metadata: The document_id_metadata of this FormulaTab. # noqa: E501 1494 :type: PropertyMetadata 1495 """ 1496 1497 self._document_id_metadata = document_id_metadata 1498 1499 @property 1500 def error_details(self): 1501 """Gets the error_details of this FormulaTab. # noqa: E501 1502 1503 Array or errors. # noqa: E501 1504 1505 :return: The error_details of this FormulaTab. # noqa: E501 1506 :rtype: ErrorDetails 1507 """ 1508 return self._error_details 1509 1510 @error_details.setter 1511 def error_details(self, error_details): 1512 """Sets the error_details of this FormulaTab. 1513 1514 Array or errors. # noqa: E501 1515 1516 :param error_details: The error_details of this FormulaTab. # noqa: E501 1517 :type: ErrorDetails 1518 """ 1519 1520 self._error_details = error_details 1521 1522 @property 1523 def extension_data(self): 1524 """Gets the extension_data of this FormulaTab. # noqa: E501 1525 1526 # noqa: E501 1527 1528 :return: The extension_data of this FormulaTab. # noqa: E501 1529 :rtype: ExtensionData 1530 """ 1531 return self._extension_data 1532 1533 @extension_data.setter 1534 def extension_data(self, extension_data): 1535 """Sets the extension_data of this FormulaTab. 1536 1537 # noqa: E501 1538 1539 :param extension_data: The extension_data of this FormulaTab. # noqa: E501 1540 :type: ExtensionData 1541 """ 1542 1543 self._extension_data = extension_data 1544 1545 @property 1546 def font(self): 1547 """Gets the font of this FormulaTab. # noqa: E501 1548 1549 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 1550 1551 :return: The font of this FormulaTab. # noqa: E501 1552 :rtype: str 1553 """ 1554 return self._font 1555 1556 @font.setter 1557 def font(self, font): 1558 """Sets the font of this FormulaTab. 1559 1560 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 1561 1562 :param font: The font of this FormulaTab. # noqa: E501 1563 :type: str 1564 """ 1565 1566 self._font = font 1567 1568 @property 1569 def font_color(self): 1570 """Gets the font_color of this FormulaTab. # noqa: E501 1571 1572 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 1573 1574 :return: The font_color of this FormulaTab. # noqa: E501 1575 :rtype: str 1576 """ 1577 return self._font_color 1578 1579 @font_color.setter 1580 def font_color(self, font_color): 1581 """Sets the font_color of this FormulaTab. 1582 1583 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 1584 1585 :param font_color: The font_color of this FormulaTab. # noqa: E501 1586 :type: str 1587 """ 1588 1589 self._font_color = font_color 1590 1591 @property 1592 def font_color_metadata(self): 1593 """Gets the font_color_metadata of this FormulaTab. # noqa: E501 1594 1595 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1596 1597 :return: The font_color_metadata of this FormulaTab. # noqa: E501 1598 :rtype: PropertyMetadata 1599 """ 1600 return self._font_color_metadata 1601 1602 @font_color_metadata.setter 1603 def font_color_metadata(self, font_color_metadata): 1604 """Sets the font_color_metadata of this FormulaTab. 1605 1606 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1607 1608 :param font_color_metadata: The font_color_metadata of this FormulaTab. # noqa: E501 1609 :type: PropertyMetadata 1610 """ 1611 1612 self._font_color_metadata = font_color_metadata 1613 1614 @property 1615 def font_metadata(self): 1616 """Gets the font_metadata of this FormulaTab. # noqa: E501 1617 1618 Metadata that indicates whether the `font` property is editable. # noqa: E501 1619 1620 :return: The font_metadata of this FormulaTab. # noqa: E501 1621 :rtype: PropertyMetadata 1622 """ 1623 return self._font_metadata 1624 1625 @font_metadata.setter 1626 def font_metadata(self, font_metadata): 1627 """Sets the font_metadata of this FormulaTab. 1628 1629 Metadata that indicates whether the `font` property is editable. # noqa: E501 1630 1631 :param font_metadata: The font_metadata of this FormulaTab. # noqa: E501 1632 :type: PropertyMetadata 1633 """ 1634 1635 self._font_metadata = font_metadata 1636 1637 @property 1638 def font_size(self): 1639 """Gets the font_size of this FormulaTab. # noqa: E501 1640 1641 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 1642 1643 :return: The font_size of this FormulaTab. # noqa: E501 1644 :rtype: str 1645 """ 1646 return self._font_size 1647 1648 @font_size.setter 1649 def font_size(self, font_size): 1650 """Sets the font_size of this FormulaTab. 1651 1652 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 1653 1654 :param font_size: The font_size of this FormulaTab. # noqa: E501 1655 :type: str 1656 """ 1657 1658 self._font_size = font_size 1659 1660 @property 1661 def font_size_metadata(self): 1662 """Gets the font_size_metadata of this FormulaTab. # noqa: E501 1663 1664 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1665 1666 :return: The font_size_metadata of this FormulaTab. # noqa: E501 1667 :rtype: PropertyMetadata 1668 """ 1669 return self._font_size_metadata 1670 1671 @font_size_metadata.setter 1672 def font_size_metadata(self, font_size_metadata): 1673 """Sets the font_size_metadata of this FormulaTab. 1674 1675 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1676 1677 :param font_size_metadata: The font_size_metadata of this FormulaTab. # noqa: E501 1678 :type: PropertyMetadata 1679 """ 1680 1681 self._font_size_metadata = font_size_metadata 1682 1683 @property 1684 def form_order(self): 1685 """Gets the form_order of this FormulaTab. # noqa: E501 1686 1687 # noqa: E501 1688 1689 :return: The form_order of this FormulaTab. # noqa: E501 1690 :rtype: str 1691 """ 1692 return self._form_order 1693 1694 @form_order.setter 1695 def form_order(self, form_order): 1696 """Sets the form_order of this FormulaTab. 1697 1698 # noqa: E501 1699 1700 :param form_order: The form_order of this FormulaTab. # noqa: E501 1701 :type: str 1702 """ 1703 1704 self._form_order = form_order 1705 1706 @property 1707 def form_order_metadata(self): 1708 """Gets the form_order_metadata of this FormulaTab. # noqa: E501 1709 1710 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1711 1712 :return: The form_order_metadata of this FormulaTab. # noqa: E501 1713 :rtype: PropertyMetadata 1714 """ 1715 return self._form_order_metadata 1716 1717 @form_order_metadata.setter 1718 def form_order_metadata(self, form_order_metadata): 1719 """Sets the form_order_metadata of this FormulaTab. 1720 1721 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1722 1723 :param form_order_metadata: The form_order_metadata of this FormulaTab. # noqa: E501 1724 :type: PropertyMetadata 1725 """ 1726 1727 self._form_order_metadata = form_order_metadata 1728 1729 @property 1730 def form_page_label(self): 1731 """Gets the form_page_label of this FormulaTab. # noqa: E501 1732 1733 # noqa: E501 1734 1735 :return: The form_page_label of this FormulaTab. # noqa: E501 1736 :rtype: str 1737 """ 1738 return self._form_page_label 1739 1740 @form_page_label.setter 1741 def form_page_label(self, form_page_label): 1742 """Sets the form_page_label of this FormulaTab. 1743 1744 # noqa: E501 1745 1746 :param form_page_label: The form_page_label of this FormulaTab. # noqa: E501 1747 :type: str 1748 """ 1749 1750 self._form_page_label = form_page_label 1751 1752 @property 1753 def form_page_label_metadata(self): 1754 """Gets the form_page_label_metadata of this FormulaTab. # noqa: E501 1755 1756 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1757 1758 :return: The form_page_label_metadata of this FormulaTab. # noqa: E501 1759 :rtype: PropertyMetadata 1760 """ 1761 return self._form_page_label_metadata 1762 1763 @form_page_label_metadata.setter 1764 def form_page_label_metadata(self, form_page_label_metadata): 1765 """Sets the form_page_label_metadata of this FormulaTab. 1766 1767 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1768 1769 :param form_page_label_metadata: The form_page_label_metadata of this FormulaTab. # noqa: E501 1770 :type: PropertyMetadata 1771 """ 1772 1773 self._form_page_label_metadata = form_page_label_metadata 1774 1775 @property 1776 def form_page_number(self): 1777 """Gets the form_page_number of this FormulaTab. # noqa: E501 1778 1779 # noqa: E501 1780 1781 :return: The form_page_number of this FormulaTab. # noqa: E501 1782 :rtype: str 1783 """ 1784 return self._form_page_number 1785 1786 @form_page_number.setter 1787 def form_page_number(self, form_page_number): 1788 """Sets the form_page_number of this FormulaTab. 1789 1790 # noqa: E501 1791 1792 :param form_page_number: The form_page_number of this FormulaTab. # noqa: E501 1793 :type: str 1794 """ 1795 1796 self._form_page_number = form_page_number 1797 1798 @property 1799 def form_page_number_metadata(self): 1800 """Gets the form_page_number_metadata of this FormulaTab. # noqa: E501 1801 1802 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1803 1804 :return: The form_page_number_metadata of this FormulaTab. # noqa: E501 1805 :rtype: PropertyMetadata 1806 """ 1807 return self._form_page_number_metadata 1808 1809 @form_page_number_metadata.setter 1810 def form_page_number_metadata(self, form_page_number_metadata): 1811 """Sets the form_page_number_metadata of this FormulaTab. 1812 1813 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1814 1815 :param form_page_number_metadata: The form_page_number_metadata of this FormulaTab. # noqa: E501 1816 :type: PropertyMetadata 1817 """ 1818 1819 self._form_page_number_metadata = form_page_number_metadata 1820 1821 @property 1822 def formula(self): 1823 """Gets the formula of this FormulaTab. # noqa: E501 1824 1825 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1826 1827 :return: The formula of this FormulaTab. # noqa: E501 1828 :rtype: str 1829 """ 1830 return self._formula 1831 1832 @formula.setter 1833 def formula(self, formula): 1834 """Sets the formula of this FormulaTab. 1835 1836 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501 1837 1838 :param formula: The formula of this FormulaTab. # noqa: E501 1839 :type: str 1840 """ 1841 1842 self._formula = formula 1843 1844 @property 1845 def formula_metadata(self): 1846 """Gets the formula_metadata of this FormulaTab. # noqa: E501 1847 1848 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1849 1850 :return: The formula_metadata of this FormulaTab. # noqa: E501 1851 :rtype: PropertyMetadata 1852 """ 1853 return self._formula_metadata 1854 1855 @formula_metadata.setter 1856 def formula_metadata(self, formula_metadata): 1857 """Sets the formula_metadata of this FormulaTab. 1858 1859 Metadata indicating if the sender can edit the `formula` property. # noqa: E501 1860 1861 :param formula_metadata: The formula_metadata of this FormulaTab. # noqa: E501 1862 :type: PropertyMetadata 1863 """ 1864 1865 self._formula_metadata = formula_metadata 1866 1867 @property 1868 def height(self): 1869 """Gets the height of this FormulaTab. # noqa: E501 1870 1871 Height of the tab in pixels. # noqa: E501 1872 1873 :return: The height of this FormulaTab. # noqa: E501 1874 :rtype: str 1875 """ 1876 return self._height 1877 1878 @height.setter 1879 def height(self, height): 1880 """Sets the height of this FormulaTab. 1881 1882 Height of the tab in pixels. # noqa: E501 1883 1884 :param height: The height of this FormulaTab. # noqa: E501 1885 :type: str 1886 """ 1887 1888 self._height = height 1889 1890 @property 1891 def height_metadata(self): 1892 """Gets the height_metadata of this FormulaTab. # noqa: E501 1893 1894 Metadata that indicates whether the `height` property is editable. # noqa: E501 1895 1896 :return: The height_metadata of this FormulaTab. # noqa: E501 1897 :rtype: PropertyMetadata 1898 """ 1899 return self._height_metadata 1900 1901 @height_metadata.setter 1902 def height_metadata(self, height_metadata): 1903 """Sets the height_metadata of this FormulaTab. 1904 1905 Metadata that indicates whether the `height` property is editable. # noqa: E501 1906 1907 :param height_metadata: The height_metadata of this FormulaTab. # noqa: E501 1908 :type: PropertyMetadata 1909 """ 1910 1911 self._height_metadata = height_metadata 1912 1913 @property 1914 def hidden(self): 1915 """Gets the hidden of this FormulaTab. # noqa: E501 1916 1917 # noqa: E501 1918 1919 :return: The hidden of this FormulaTab. # noqa: E501 1920 :rtype: str 1921 """ 1922 return self._hidden 1923 1924 @hidden.setter 1925 def hidden(self, hidden): 1926 """Sets the hidden of this FormulaTab. 1927 1928 # noqa: E501 1929 1930 :param hidden: The hidden of this FormulaTab. # noqa: E501 1931 :type: str 1932 """ 1933 1934 self._hidden = hidden 1935 1936 @property 1937 def hidden_metadata(self): 1938 """Gets the hidden_metadata of this FormulaTab. # noqa: E501 1939 1940 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1941 1942 :return: The hidden_metadata of this FormulaTab. # noqa: E501 1943 :rtype: PropertyMetadata 1944 """ 1945 return self._hidden_metadata 1946 1947 @hidden_metadata.setter 1948 def hidden_metadata(self, hidden_metadata): 1949 """Sets the hidden_metadata of this FormulaTab. 1950 1951 Metadata that indicates whether the `hidden` property is editable. # noqa: E501 1952 1953 :param hidden_metadata: The hidden_metadata of this FormulaTab. # noqa: E501 1954 :type: PropertyMetadata 1955 """ 1956 1957 self._hidden_metadata = hidden_metadata 1958 1959 @property 1960 def is_payment_amount(self): 1961 """Gets the is_payment_amount of this FormulaTab. # noqa: E501 1962 1963 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1964 1965 :return: The is_payment_amount of this FormulaTab. # noqa: E501 1966 :rtype: str 1967 """ 1968 return self._is_payment_amount 1969 1970 @is_payment_amount.setter 1971 def is_payment_amount(self, is_payment_amount): 1972 """Sets the is_payment_amount of this FormulaTab. 1973 1974 When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501 1975 1976 :param is_payment_amount: The is_payment_amount of this FormulaTab. # noqa: E501 1977 :type: str 1978 """ 1979 1980 self._is_payment_amount = is_payment_amount 1981 1982 @property 1983 def is_payment_amount_metadata(self): 1984 """Gets the is_payment_amount_metadata of this FormulaTab. # noqa: E501 1985 1986 Reserved for DocuSign. # noqa: E501 1987 1988 :return: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 1989 :rtype: PropertyMetadata 1990 """ 1991 return self._is_payment_amount_metadata 1992 1993 @is_payment_amount_metadata.setter 1994 def is_payment_amount_metadata(self, is_payment_amount_metadata): 1995 """Sets the is_payment_amount_metadata of this FormulaTab. 1996 1997 Reserved for DocuSign. # noqa: E501 1998 1999 :param is_payment_amount_metadata: The is_payment_amount_metadata of this FormulaTab. # noqa: E501 2000 :type: PropertyMetadata 2001 """ 2002 2003 self._is_payment_amount_metadata = is_payment_amount_metadata 2004 2005 @property 2006 def italic(self): 2007 """Gets the italic of this FormulaTab. # noqa: E501 2008 2009 When set to **true**, the information in the tab is italic. # noqa: E501 2010 2011 :return: The italic of this FormulaTab. # noqa: E501 2012 :rtype: str 2013 """ 2014 return self._italic 2015 2016 @italic.setter 2017 def italic(self, italic): 2018 """Sets the italic of this FormulaTab. 2019 2020 When set to **true**, the information in the tab is italic. # noqa: E501 2021 2022 :param italic: The italic of this FormulaTab. # noqa: E501 2023 :type: str 2024 """ 2025 2026 self._italic = italic 2027 2028 @property 2029 def italic_metadata(self): 2030 """Gets the italic_metadata of this FormulaTab. # noqa: E501 2031 2032 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2033 2034 :return: The italic_metadata of this FormulaTab. # noqa: E501 2035 :rtype: PropertyMetadata 2036 """ 2037 return self._italic_metadata 2038 2039 @italic_metadata.setter 2040 def italic_metadata(self, italic_metadata): 2041 """Sets the italic_metadata of this FormulaTab. 2042 2043 Metadata that indicates whether the `italic` property is editable. # noqa: E501 2044 2045 :param italic_metadata: The italic_metadata of this FormulaTab. # noqa: E501 2046 :type: PropertyMetadata 2047 """ 2048 2049 self._italic_metadata = italic_metadata 2050 2051 @property 2052 def locale_policy(self): 2053 """Gets the locale_policy of this FormulaTab. # noqa: E501 2054 2055 Reserved for DocuSign. # noqa: E501 2056 2057 :return: The locale_policy of this FormulaTab. # noqa: E501 2058 :rtype: LocalePolicyTab 2059 """ 2060 return self._locale_policy 2061 2062 @locale_policy.setter 2063 def locale_policy(self, locale_policy): 2064 """Sets the locale_policy of this FormulaTab. 2065 2066 Reserved for DocuSign. # noqa: E501 2067 2068 :param locale_policy: The locale_policy of this FormulaTab. # noqa: E501 2069 :type: LocalePolicyTab 2070 """ 2071 2072 self._locale_policy = locale_policy 2073 2074 @property 2075 def locked(self): 2076 """Gets the locked of this FormulaTab. # noqa: E501 2077 2078 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2079 2080 :return: The locked of this FormulaTab. # noqa: E501 2081 :rtype: str 2082 """ 2083 return self._locked 2084 2085 @locked.setter 2086 def locked(self, locked): 2087 """Sets the locked of this FormulaTab. 2088 2089 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 2090 2091 :param locked: The locked of this FormulaTab. # noqa: E501 2092 :type: str 2093 """ 2094 2095 self._locked = locked 2096 2097 @property 2098 def locked_metadata(self): 2099 """Gets the locked_metadata of this FormulaTab. # noqa: E501 2100 2101 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2102 2103 :return: The locked_metadata of this FormulaTab. # noqa: E501 2104 :rtype: PropertyMetadata 2105 """ 2106 return self._locked_metadata 2107 2108 @locked_metadata.setter 2109 def locked_metadata(self, locked_metadata): 2110 """Sets the locked_metadata of this FormulaTab. 2111 2112 Metadata that indicates whether the `locked` property is editable. # noqa: E501 2113 2114 :param locked_metadata: The locked_metadata of this FormulaTab. # noqa: E501 2115 :type: PropertyMetadata 2116 """ 2117 2118 self._locked_metadata = locked_metadata 2119 2120 @property 2121 def max_length(self): 2122 """Gets the max_length of this FormulaTab. # noqa: E501 2123 2124 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2125 2126 :return: The max_length of this FormulaTab. # noqa: E501 2127 :rtype: str 2128 """ 2129 return self._max_length 2130 2131 @max_length.setter 2132 def max_length(self, max_length): 2133 """Sets the max_length of this FormulaTab. 2134 2135 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 2136 2137 :param max_length: The max_length of this FormulaTab. # noqa: E501 2138 :type: str 2139 """ 2140 2141 self._max_length = max_length 2142 2143 @property 2144 def max_length_metadata(self): 2145 """Gets the max_length_metadata of this FormulaTab. # noqa: E501 2146 2147 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2148 2149 :return: The max_length_metadata of this FormulaTab. # noqa: E501 2150 :rtype: PropertyMetadata 2151 """ 2152 return self._max_length_metadata 2153 2154 @max_length_metadata.setter 2155 def max_length_metadata(self, max_length_metadata): 2156 """Sets the max_length_metadata of this FormulaTab. 2157 2158 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 2159 2160 :param max_length_metadata: The max_length_metadata of this FormulaTab. # noqa: E501 2161 :type: PropertyMetadata 2162 """ 2163 2164 self._max_length_metadata = max_length_metadata 2165 2166 @property 2167 def merge_field(self): 2168 """Gets the merge_field of this FormulaTab. # noqa: E501 2169 2170 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2171 2172 :return: The merge_field of this FormulaTab. # noqa: E501 2173 :rtype: MergeField 2174 """ 2175 return self._merge_field 2176 2177 @merge_field.setter 2178 def merge_field(self, merge_field): 2179 """Sets the merge_field of this FormulaTab. 2180 2181 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 2182 2183 :param merge_field: The merge_field of this FormulaTab. # noqa: E501 2184 :type: MergeField 2185 """ 2186 2187 self._merge_field = merge_field 2188 2189 @property 2190 def merge_field_xml(self): 2191 """Gets the merge_field_xml of this FormulaTab. # noqa: E501 2192 2193 # noqa: E501 2194 2195 :return: The merge_field_xml of this FormulaTab. # noqa: E501 2196 :rtype: str 2197 """ 2198 return self._merge_field_xml 2199 2200 @merge_field_xml.setter 2201 def merge_field_xml(self, merge_field_xml): 2202 """Sets the merge_field_xml of this FormulaTab. 2203 2204 # noqa: E501 2205 2206 :param merge_field_xml: The merge_field_xml of this FormulaTab. # noqa: E501 2207 :type: str 2208 """ 2209 2210 self._merge_field_xml = merge_field_xml 2211 2212 @property 2213 def name(self): 2214 """Gets the name of this FormulaTab. # noqa: E501 2215 2216 # noqa: E501 2217 2218 :return: The name of this FormulaTab. # noqa: E501 2219 :rtype: str 2220 """ 2221 return self._name 2222 2223 @name.setter 2224 def name(self, name): 2225 """Sets the name of this FormulaTab. 2226 2227 # noqa: E501 2228 2229 :param name: The name of this FormulaTab. # noqa: E501 2230 :type: str 2231 """ 2232 2233 self._name = name 2234 2235 @property 2236 def name_metadata(self): 2237 """Gets the name_metadata of this FormulaTab. # noqa: E501 2238 2239 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2240 2241 :return: The name_metadata of this FormulaTab. # noqa: E501 2242 :rtype: PropertyMetadata 2243 """ 2244 return self._name_metadata 2245 2246 @name_metadata.setter 2247 def name_metadata(self, name_metadata): 2248 """Sets the name_metadata of this FormulaTab. 2249 2250 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2251 2252 :param name_metadata: The name_metadata of this FormulaTab. # noqa: E501 2253 :type: PropertyMetadata 2254 """ 2255 2256 self._name_metadata = name_metadata 2257 2258 @property 2259 def original_value(self): 2260 """Gets the original_value of this FormulaTab. # noqa: E501 2261 2262 The initial value of the tab when it was sent to the recipient. # noqa: E501 2263 2264 :return: The original_value of this FormulaTab. # noqa: E501 2265 :rtype: str 2266 """ 2267 return self._original_value 2268 2269 @original_value.setter 2270 def original_value(self, original_value): 2271 """Sets the original_value of this FormulaTab. 2272 2273 The initial value of the tab when it was sent to the recipient. # noqa: E501 2274 2275 :param original_value: The original_value of this FormulaTab. # noqa: E501 2276 :type: str 2277 """ 2278 2279 self._original_value = original_value 2280 2281 @property 2282 def original_value_metadata(self): 2283 """Gets the original_value_metadata of this FormulaTab. # noqa: E501 2284 2285 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2286 2287 :return: The original_value_metadata of this FormulaTab. # noqa: E501 2288 :rtype: PropertyMetadata 2289 """ 2290 return self._original_value_metadata 2291 2292 @original_value_metadata.setter 2293 def original_value_metadata(self, original_value_metadata): 2294 """Sets the original_value_metadata of this FormulaTab. 2295 2296 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2297 2298 :param original_value_metadata: The original_value_metadata of this FormulaTab. # noqa: E501 2299 :type: PropertyMetadata 2300 """ 2301 2302 self._original_value_metadata = original_value_metadata 2303 2304 @property 2305 def page_number(self): 2306 """Gets the page_number of this FormulaTab. # noqa: E501 2307 2308 Specifies the page number on which the tab is located. # noqa: E501 2309 2310 :return: The page_number of this FormulaTab. # noqa: E501 2311 :rtype: str 2312 """ 2313 return self._page_number 2314 2315 @page_number.setter 2316 def page_number(self, page_number): 2317 """Sets the page_number of this FormulaTab. 2318 2319 Specifies the page number on which the tab is located. # noqa: E501 2320 2321 :param page_number: The page_number of this FormulaTab. # noqa: E501 2322 :type: str 2323 """ 2324 2325 self._page_number = page_number 2326 2327 @property 2328 def page_number_metadata(self): 2329 """Gets the page_number_metadata of this FormulaTab. # noqa: E501 2330 2331 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2332 2333 :return: The page_number_metadata of this FormulaTab. # noqa: E501 2334 :rtype: PropertyMetadata 2335 """ 2336 return self._page_number_metadata 2337 2338 @page_number_metadata.setter 2339 def page_number_metadata(self, page_number_metadata): 2340 """Sets the page_number_metadata of this FormulaTab. 2341 2342 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2343 2344 :param page_number_metadata: The page_number_metadata of this FormulaTab. # noqa: E501 2345 :type: PropertyMetadata 2346 """ 2347 2348 self._page_number_metadata = page_number_metadata 2349 2350 @property 2351 def payment_details(self): 2352 """Gets the payment_details of this FormulaTab. # noqa: E501 2353 2354 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2355 2356 :return: The payment_details of this FormulaTab. # noqa: E501 2357 :rtype: PaymentDetails 2358 """ 2359 return self._payment_details 2360 2361 @payment_details.setter 2362 def payment_details(self, payment_details): 2363 """Sets the payment_details of this FormulaTab. 2364 2365 This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501 2366 2367 :param payment_details: The payment_details of this FormulaTab. # noqa: E501 2368 :type: PaymentDetails 2369 """ 2370 2371 self._payment_details = payment_details 2372 2373 @property 2374 def recipient_id(self): 2375 """Gets the recipient_id of this FormulaTab. # noqa: E501 2376 2377 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2378 2379 :return: The recipient_id of this FormulaTab. # noqa: E501 2380 :rtype: str 2381 """ 2382 return self._recipient_id 2383 2384 @recipient_id.setter 2385 def recipient_id(self, recipient_id): 2386 """Sets the recipient_id of this FormulaTab. 2387 2388 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2389 2390 :param recipient_id: The recipient_id of this FormulaTab. # noqa: E501 2391 :type: str 2392 """ 2393 2394 self._recipient_id = recipient_id 2395 2396 @property 2397 def recipient_id_guid(self): 2398 """Gets the recipient_id_guid of this FormulaTab. # noqa: E501 2399 2400 # noqa: E501 2401 2402 :return: The recipient_id_guid of this FormulaTab. # noqa: E501 2403 :rtype: str 2404 """ 2405 return self._recipient_id_guid 2406 2407 @recipient_id_guid.setter 2408 def recipient_id_guid(self, recipient_id_guid): 2409 """Sets the recipient_id_guid of this FormulaTab. 2410 2411 # noqa: E501 2412 2413 :param recipient_id_guid: The recipient_id_guid of this FormulaTab. # noqa: E501 2414 :type: str 2415 """ 2416 2417 self._recipient_id_guid = recipient_id_guid 2418 2419 @property 2420 def recipient_id_guid_metadata(self): 2421 """Gets the recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2422 2423 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2424 2425 :return: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2426 :rtype: PropertyMetadata 2427 """ 2428 return self._recipient_id_guid_metadata 2429 2430 @recipient_id_guid_metadata.setter 2431 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 2432 """Sets the recipient_id_guid_metadata of this FormulaTab. 2433 2434 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2435 2436 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this FormulaTab. # noqa: E501 2437 :type: PropertyMetadata 2438 """ 2439 2440 self._recipient_id_guid_metadata = recipient_id_guid_metadata 2441 2442 @property 2443 def recipient_id_metadata(self): 2444 """Gets the recipient_id_metadata of this FormulaTab. # noqa: E501 2445 2446 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2447 2448 :return: The recipient_id_metadata of this FormulaTab. # noqa: E501 2449 :rtype: PropertyMetadata 2450 """ 2451 return self._recipient_id_metadata 2452 2453 @recipient_id_metadata.setter 2454 def recipient_id_metadata(self, recipient_id_metadata): 2455 """Sets the recipient_id_metadata of this FormulaTab. 2456 2457 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2458 2459 :param recipient_id_metadata: The recipient_id_metadata of this FormulaTab. # noqa: E501 2460 :type: PropertyMetadata 2461 """ 2462 2463 self._recipient_id_metadata = recipient_id_metadata 2464 2465 @property 2466 def require_all(self): 2467 """Gets the require_all of this FormulaTab. # noqa: E501 2468 2469 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2470 2471 :return: The require_all of this FormulaTab. # noqa: E501 2472 :rtype: str 2473 """ 2474 return self._require_all 2475 2476 @require_all.setter 2477 def require_all(self, require_all): 2478 """Sets the require_all of this FormulaTab. 2479 2480 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2481 2482 :param require_all: The require_all of this FormulaTab. # noqa: E501 2483 :type: str 2484 """ 2485 2486 self._require_all = require_all 2487 2488 @property 2489 def require_all_metadata(self): 2490 """Gets the require_all_metadata of this FormulaTab. # noqa: E501 2491 2492 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2493 2494 :return: The require_all_metadata of this FormulaTab. # noqa: E501 2495 :rtype: PropertyMetadata 2496 """ 2497 return self._require_all_metadata 2498 2499 @require_all_metadata.setter 2500 def require_all_metadata(self, require_all_metadata): 2501 """Sets the require_all_metadata of this FormulaTab. 2502 2503 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2504 2505 :param require_all_metadata: The require_all_metadata of this FormulaTab. # noqa: E501 2506 :type: PropertyMetadata 2507 """ 2508 2509 self._require_all_metadata = require_all_metadata 2510 2511 @property 2512 def required(self): 2513 """Gets the required of this FormulaTab. # noqa: E501 2514 2515 When set to **true**, the signer is required to fill out this tab # noqa: E501 2516 2517 :return: The required of this FormulaTab. # noqa: E501 2518 :rtype: str 2519 """ 2520 return self._required 2521 2522 @required.setter 2523 def required(self, required): 2524 """Sets the required of this FormulaTab. 2525 2526 When set to **true**, the signer is required to fill out this tab # noqa: E501 2527 2528 :param required: The required of this FormulaTab. # noqa: E501 2529 :type: str 2530 """ 2531 2532 self._required = required 2533 2534 @property 2535 def required_metadata(self): 2536 """Gets the required_metadata of this FormulaTab. # noqa: E501 2537 2538 Metadata that indicates whether the `required` property is editable. # noqa: E501 2539 2540 :return: The required_metadata of this FormulaTab. # noqa: E501 2541 :rtype: PropertyMetadata 2542 """ 2543 return self._required_metadata 2544 2545 @required_metadata.setter 2546 def required_metadata(self, required_metadata): 2547 """Sets the required_metadata of this FormulaTab. 2548 2549 Metadata that indicates whether the `required` property is editable. # noqa: E501 2550 2551 :param required_metadata: The required_metadata of this FormulaTab. # noqa: E501 2552 :type: PropertyMetadata 2553 """ 2554 2555 self._required_metadata = required_metadata 2556 2557 @property 2558 def require_initial_on_shared_change(self): 2559 """Gets the require_initial_on_shared_change of this FormulaTab. # noqa: E501 2560 2561 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2562 2563 :return: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2564 :rtype: str 2565 """ 2566 return self._require_initial_on_shared_change 2567 2568 @require_initial_on_shared_change.setter 2569 def require_initial_on_shared_change(self, require_initial_on_shared_change): 2570 """Sets the require_initial_on_shared_change of this FormulaTab. 2571 2572 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2573 2574 :param require_initial_on_shared_change: The require_initial_on_shared_change of this FormulaTab. # noqa: E501 2575 :type: str 2576 """ 2577 2578 self._require_initial_on_shared_change = require_initial_on_shared_change 2579 2580 @property 2581 def require_initial_on_shared_change_metadata(self): 2582 """Gets the require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2583 2584 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2585 2586 :return: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2587 :rtype: PropertyMetadata 2588 """ 2589 return self._require_initial_on_shared_change_metadata 2590 2591 @require_initial_on_shared_change_metadata.setter 2592 def require_initial_on_shared_change_metadata(self, require_initial_on_shared_change_metadata): 2593 """Sets the require_initial_on_shared_change_metadata of this FormulaTab. 2594 2595 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2596 2597 :param require_initial_on_shared_change_metadata: The require_initial_on_shared_change_metadata of this FormulaTab. # noqa: E501 2598 :type: PropertyMetadata 2599 """ 2600 2601 self._require_initial_on_shared_change_metadata = require_initial_on_shared_change_metadata 2602 2603 @property 2604 def round_decimal_places(self): 2605 """Gets the round_decimal_places of this FormulaTab. # noqa: E501 2606 2607 # noqa: E501 2608 2609 :return: The round_decimal_places of this FormulaTab. # noqa: E501 2610 :rtype: str 2611 """ 2612 return self._round_decimal_places 2613 2614 @round_decimal_places.setter 2615 def round_decimal_places(self, round_decimal_places): 2616 """Sets the round_decimal_places of this FormulaTab. 2617 2618 # noqa: E501 2619 2620 :param round_decimal_places: The round_decimal_places of this FormulaTab. # noqa: E501 2621 :type: str 2622 """ 2623 2624 self._round_decimal_places = round_decimal_places 2625 2626 @property 2627 def round_decimal_places_metadata(self): 2628 """Gets the round_decimal_places_metadata of this FormulaTab. # noqa: E501 2629 2630 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2631 2632 :return: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2633 :rtype: PropertyMetadata 2634 """ 2635 return self._round_decimal_places_metadata 2636 2637 @round_decimal_places_metadata.setter 2638 def round_decimal_places_metadata(self, round_decimal_places_metadata): 2639 """Sets the round_decimal_places_metadata of this FormulaTab. 2640 2641 Metadata that indicates whether the `roundDecimalPlaces` property is editable. # noqa: E501 2642 2643 :param round_decimal_places_metadata: The round_decimal_places_metadata of this FormulaTab. # noqa: E501 2644 :type: PropertyMetadata 2645 """ 2646 2647 self._round_decimal_places_metadata = round_decimal_places_metadata 2648 2649 @property 2650 def sender_required(self): 2651 """Gets the sender_required of this FormulaTab. # noqa: E501 2652 2653 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2654 2655 :return: The sender_required of this FormulaTab. # noqa: E501 2656 :rtype: str 2657 """ 2658 return self._sender_required 2659 2660 @sender_required.setter 2661 def sender_required(self, sender_required): 2662 """Sets the sender_required of this FormulaTab. 2663 2664 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2665 2666 :param sender_required: The sender_required of this FormulaTab. # noqa: E501 2667 :type: str 2668 """ 2669 2670 self._sender_required = sender_required 2671 2672 @property 2673 def sender_required_metadata(self): 2674 """Gets the sender_required_metadata of this FormulaTab. # noqa: E501 2675 2676 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2677 2678 :return: The sender_required_metadata of this FormulaTab. # noqa: E501 2679 :rtype: PropertyMetadata 2680 """ 2681 return self._sender_required_metadata 2682 2683 @sender_required_metadata.setter 2684 def sender_required_metadata(self, sender_required_metadata): 2685 """Sets the sender_required_metadata of this FormulaTab. 2686 2687 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2688 2689 :param sender_required_metadata: The sender_required_metadata of this FormulaTab. # noqa: E501 2690 :type: PropertyMetadata 2691 """ 2692 2693 self._sender_required_metadata = sender_required_metadata 2694 2695 @property 2696 def shared(self): 2697 """Gets the shared of this FormulaTab. # noqa: E501 2698 2699 When set to **true**, this custom tab is shared. # noqa: E501 2700 2701 :return: The shared of this FormulaTab. # noqa: E501 2702 :rtype: str 2703 """ 2704 return self._shared 2705 2706 @shared.setter 2707 def shared(self, shared): 2708 """Sets the shared of this FormulaTab. 2709 2710 When set to **true**, this custom tab is shared. # noqa: E501 2711 2712 :param shared: The shared of this FormulaTab. # noqa: E501 2713 :type: str 2714 """ 2715 2716 self._shared = shared 2717 2718 @property 2719 def shared_metadata(self): 2720 """Gets the shared_metadata of this FormulaTab. # noqa: E501 2721 2722 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2723 2724 :return: The shared_metadata of this FormulaTab. # noqa: E501 2725 :rtype: PropertyMetadata 2726 """ 2727 return self._shared_metadata 2728 2729 @shared_metadata.setter 2730 def shared_metadata(self, shared_metadata): 2731 """Sets the shared_metadata of this FormulaTab. 2732 2733 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2734 2735 :param shared_metadata: The shared_metadata of this FormulaTab. # noqa: E501 2736 :type: PropertyMetadata 2737 """ 2738 2739 self._shared_metadata = shared_metadata 2740 2741 @property 2742 def share_to_recipients(self): 2743 """Gets the share_to_recipients of this FormulaTab. # noqa: E501 2744 2745 # noqa: E501 2746 2747 :return: The share_to_recipients of this FormulaTab. # noqa: E501 2748 :rtype: str 2749 """ 2750 return self._share_to_recipients 2751 2752 @share_to_recipients.setter 2753 def share_to_recipients(self, share_to_recipients): 2754 """Sets the share_to_recipients of this FormulaTab. 2755 2756 # noqa: E501 2757 2758 :param share_to_recipients: The share_to_recipients of this FormulaTab. # noqa: E501 2759 :type: str 2760 """ 2761 2762 self._share_to_recipients = share_to_recipients 2763 2764 @property 2765 def share_to_recipients_metadata(self): 2766 """Gets the share_to_recipients_metadata of this FormulaTab. # noqa: E501 2767 2768 Reserved for DocuSign. # noqa: E501 2769 2770 :return: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2771 :rtype: PropertyMetadata 2772 """ 2773 return self._share_to_recipients_metadata 2774 2775 @share_to_recipients_metadata.setter 2776 def share_to_recipients_metadata(self, share_to_recipients_metadata): 2777 """Sets the share_to_recipients_metadata of this FormulaTab. 2778 2779 Reserved for DocuSign. # noqa: E501 2780 2781 :param share_to_recipients_metadata: The share_to_recipients_metadata of this FormulaTab. # noqa: E501 2782 :type: PropertyMetadata 2783 """ 2784 2785 self._share_to_recipients_metadata = share_to_recipients_metadata 2786 2787 @property 2788 def smart_contract_information(self): 2789 """Gets the smart_contract_information of this FormulaTab. # noqa: E501 2790 2791 Reserved for DocuSign. # noqa: E501 2792 2793 :return: The smart_contract_information of this FormulaTab. # noqa: E501 2794 :rtype: SmartContractInformation 2795 """ 2796 return self._smart_contract_information 2797 2798 @smart_contract_information.setter 2799 def smart_contract_information(self, smart_contract_information): 2800 """Sets the smart_contract_information of this FormulaTab. 2801 2802 Reserved for DocuSign. # noqa: E501 2803 2804 :param smart_contract_information: The smart_contract_information of this FormulaTab. # noqa: E501 2805 :type: SmartContractInformation 2806 """ 2807 2808 self._smart_contract_information = smart_contract_information 2809 2810 @property 2811 def source(self): 2812 """Gets the source of this FormulaTab. # noqa: E501 2813 2814 # noqa: E501 2815 2816 :return: The source of this FormulaTab. # noqa: E501 2817 :rtype: str 2818 """ 2819 return self._source 2820 2821 @source.setter 2822 def source(self, source): 2823 """Sets the source of this FormulaTab. 2824 2825 # noqa: E501 2826 2827 :param source: The source of this FormulaTab. # noqa: E501 2828 :type: str 2829 """ 2830 2831 self._source = source 2832 2833 @property 2834 def status(self): 2835 """Gets the status of this FormulaTab. # noqa: E501 2836 2837 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 2838 2839 :return: The status of this FormulaTab. # noqa: E501 2840 :rtype: str 2841 """ 2842 return self._status 2843 2844 @status.setter 2845 def status(self, status): 2846 """Sets the status of this FormulaTab. 2847 2848 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 2849 2850 :param status: The status of this FormulaTab. # noqa: E501 2851 :type: str 2852 """ 2853 2854 self._status = status 2855 2856 @property 2857 def status_metadata(self): 2858 """Gets the status_metadata of this FormulaTab. # noqa: E501 2859 2860 Metadata that indicates whether the `status` property is editable. # noqa: E501 2861 2862 :return: The status_metadata of this FormulaTab. # noqa: E501 2863 :rtype: PropertyMetadata 2864 """ 2865 return self._status_metadata 2866 2867 @status_metadata.setter 2868 def status_metadata(self, status_metadata): 2869 """Sets the status_metadata of this FormulaTab. 2870 2871 Metadata that indicates whether the `status` property is editable. # noqa: E501 2872 2873 :param status_metadata: The status_metadata of this FormulaTab. # noqa: E501 2874 :type: PropertyMetadata 2875 """ 2876 2877 self._status_metadata = status_metadata 2878 2879 @property 2880 def tab_fully_qualified_path(self): 2881 """Gets the tab_fully_qualified_path of this FormulaTab. # noqa: E501 2882 2883 # noqa: E501 2884 2885 :return: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2886 :rtype: str 2887 """ 2888 return self._tab_fully_qualified_path 2889 2890 @tab_fully_qualified_path.setter 2891 def tab_fully_qualified_path(self, tab_fully_qualified_path): 2892 """Sets the tab_fully_qualified_path of this FormulaTab. 2893 2894 # noqa: E501 2895 2896 :param tab_fully_qualified_path: The tab_fully_qualified_path of this FormulaTab. # noqa: E501 2897 :type: str 2898 """ 2899 2900 self._tab_fully_qualified_path = tab_fully_qualified_path 2901 2902 @property 2903 def tab_group_labels(self): 2904 """Gets the tab_group_labels of this FormulaTab. # noqa: E501 2905 2906 # noqa: E501 2907 2908 :return: The tab_group_labels of this FormulaTab. # noqa: E501 2909 :rtype: list[str] 2910 """ 2911 return self._tab_group_labels 2912 2913 @tab_group_labels.setter 2914 def tab_group_labels(self, tab_group_labels): 2915 """Sets the tab_group_labels of this FormulaTab. 2916 2917 # noqa: E501 2918 2919 :param tab_group_labels: The tab_group_labels of this FormulaTab. # noqa: E501 2920 :type: list[str] 2921 """ 2922 2923 self._tab_group_labels = tab_group_labels 2924 2925 @property 2926 def tab_group_labels_metadata(self): 2927 """Gets the tab_group_labels_metadata of this FormulaTab. # noqa: E501 2928 2929 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2930 2931 :return: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2932 :rtype: PropertyMetadata 2933 """ 2934 return self._tab_group_labels_metadata 2935 2936 @tab_group_labels_metadata.setter 2937 def tab_group_labels_metadata(self, tab_group_labels_metadata): 2938 """Sets the tab_group_labels_metadata of this FormulaTab. 2939 2940 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2941 2942 :param tab_group_labels_metadata: The tab_group_labels_metadata of this FormulaTab. # noqa: E501 2943 :type: PropertyMetadata 2944 """ 2945 2946 self._tab_group_labels_metadata = tab_group_labels_metadata 2947 2948 @property 2949 def tab_id(self): 2950 """Gets the tab_id of this FormulaTab. # noqa: E501 2951 2952 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2953 2954 :return: The tab_id of this FormulaTab. # noqa: E501 2955 :rtype: str 2956 """ 2957 return self._tab_id 2958 2959 @tab_id.setter 2960 def tab_id(self, tab_id): 2961 """Sets the tab_id of this FormulaTab. 2962 2963 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2964 2965 :param tab_id: The tab_id of this FormulaTab. # noqa: E501 2966 :type: str 2967 """ 2968 2969 self._tab_id = tab_id 2970 2971 @property 2972 def tab_id_metadata(self): 2973 """Gets the tab_id_metadata of this FormulaTab. # noqa: E501 2974 2975 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2976 2977 :return: The tab_id_metadata of this FormulaTab. # noqa: E501 2978 :rtype: PropertyMetadata 2979 """ 2980 return self._tab_id_metadata 2981 2982 @tab_id_metadata.setter 2983 def tab_id_metadata(self, tab_id_metadata): 2984 """Sets the tab_id_metadata of this FormulaTab. 2985 2986 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2987 2988 :param tab_id_metadata: The tab_id_metadata of this FormulaTab. # noqa: E501 2989 :type: PropertyMetadata 2990 """ 2991 2992 self._tab_id_metadata = tab_id_metadata 2993 2994 @property 2995 def tab_label(self): 2996 """Gets the tab_label of this FormulaTab. # noqa: E501 2997 2998 The label string associated with the tab. # noqa: E501 2999 3000 :return: The tab_label of this FormulaTab. # noqa: E501 3001 :rtype: str 3002 """ 3003 return self._tab_label 3004 3005 @tab_label.setter 3006 def tab_label(self, tab_label): 3007 """Sets the tab_label of this FormulaTab. 3008 3009 The label string associated with the tab. # noqa: E501 3010 3011 :param tab_label: The tab_label of this FormulaTab. # noqa: E501 3012 :type: str 3013 """ 3014 3015 self._tab_label = tab_label 3016 3017 @property 3018 def tab_label_metadata(self): 3019 """Gets the tab_label_metadata of this FormulaTab. # noqa: E501 3020 3021 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 3022 3023 :return: The tab_label_metadata of this FormulaTab. # noqa: E501 3024 :rtype: PropertyMetadata 3025 """ 3026 return self._tab_label_metadata 3027 3028 @tab_label_metadata.setter 3029 def tab_label_metadata(self, tab_label_metadata): 3030 """Sets the tab_label_metadata of this FormulaTab. 3031 3032 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 3033 3034 :param tab_label_metadata: The tab_label_metadata of this FormulaTab. # noqa: E501 3035 :type: PropertyMetadata 3036 """ 3037 3038 self._tab_label_metadata = tab_label_metadata 3039 3040 @property 3041 def tab_order(self): 3042 """Gets the tab_order of this FormulaTab. # noqa: E501 3043 3044 # noqa: E501 3045 3046 :return: The tab_order of this FormulaTab. # noqa: E501 3047 :rtype: str 3048 """ 3049 return self._tab_order 3050 3051 @tab_order.setter 3052 def tab_order(self, tab_order): 3053 """Sets the tab_order of this FormulaTab. 3054 3055 # noqa: E501 3056 3057 :param tab_order: The tab_order of this FormulaTab. # noqa: E501 3058 :type: str 3059 """ 3060 3061 self._tab_order = tab_order 3062 3063 @property 3064 def tab_order_metadata(self): 3065 """Gets the tab_order_metadata of this FormulaTab. # noqa: E501 3066 3067 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3068 3069 :return: The tab_order_metadata of this FormulaTab. # noqa: E501 3070 :rtype: PropertyMetadata 3071 """ 3072 return self._tab_order_metadata 3073 3074 @tab_order_metadata.setter 3075 def tab_order_metadata(self, tab_order_metadata): 3076 """Sets the tab_order_metadata of this FormulaTab. 3077 3078 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 3079 3080 :param tab_order_metadata: The tab_order_metadata of this FormulaTab. # noqa: E501 3081 :type: PropertyMetadata 3082 """ 3083 3084 self._tab_order_metadata = tab_order_metadata 3085 3086 @property 3087 def tab_type(self): 3088 """Gets the tab_type of this FormulaTab. # noqa: E501 3089 3090 # noqa: E501 3091 3092 :return: The tab_type of this FormulaTab. # noqa: E501 3093 :rtype: str 3094 """ 3095 return self._tab_type 3096 3097 @tab_type.setter 3098 def tab_type(self, tab_type): 3099 """Sets the tab_type of this FormulaTab. 3100 3101 # noqa: E501 3102 3103 :param tab_type: The tab_type of this FormulaTab. # noqa: E501 3104 :type: str 3105 """ 3106 3107 self._tab_type = tab_type 3108 3109 @property 3110 def tab_type_metadata(self): 3111 """Gets the tab_type_metadata of this FormulaTab. # noqa: E501 3112 3113 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3114 3115 :return: The tab_type_metadata of this FormulaTab. # noqa: E501 3116 :rtype: PropertyMetadata 3117 """ 3118 return self._tab_type_metadata 3119 3120 @tab_type_metadata.setter 3121 def tab_type_metadata(self, tab_type_metadata): 3122 """Sets the tab_type_metadata of this FormulaTab. 3123 3124 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 3125 3126 :param tab_type_metadata: The tab_type_metadata of this FormulaTab. # noqa: E501 3127 :type: PropertyMetadata 3128 """ 3129 3130 self._tab_type_metadata = tab_type_metadata 3131 3132 @property 3133 def template_locked(self): 3134 """Gets the template_locked of this FormulaTab. # noqa: E501 3135 3136 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3137 3138 :return: The template_locked of this FormulaTab. # noqa: E501 3139 :rtype: str 3140 """ 3141 return self._template_locked 3142 3143 @template_locked.setter 3144 def template_locked(self, template_locked): 3145 """Sets the template_locked of this FormulaTab. 3146 3147 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 3148 3149 :param template_locked: The template_locked of this FormulaTab. # noqa: E501 3150 :type: str 3151 """ 3152 3153 self._template_locked = template_locked 3154 3155 @property 3156 def template_locked_metadata(self): 3157 """Gets the template_locked_metadata of this FormulaTab. # noqa: E501 3158 3159 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3160 3161 :return: The template_locked_metadata of this FormulaTab. # noqa: E501 3162 :rtype: PropertyMetadata 3163 """ 3164 return self._template_locked_metadata 3165 3166 @template_locked_metadata.setter 3167 def template_locked_metadata(self, template_locked_metadata): 3168 """Sets the template_locked_metadata of this FormulaTab. 3169 3170 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 3171 3172 :param template_locked_metadata: The template_locked_metadata of this FormulaTab. # noqa: E501 3173 :type: PropertyMetadata 3174 """ 3175 3176 self._template_locked_metadata = template_locked_metadata 3177 3178 @property 3179 def template_required(self): 3180 """Gets the template_required of this FormulaTab. # noqa: E501 3181 3182 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3183 3184 :return: The template_required of this FormulaTab. # noqa: E501 3185 :rtype: str 3186 """ 3187 return self._template_required 3188 3189 @template_required.setter 3190 def template_required(self, template_required): 3191 """Sets the template_required of this FormulaTab. 3192 3193 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 3194 3195 :param template_required: The template_required of this FormulaTab. # noqa: E501 3196 :type: str 3197 """ 3198 3199 self._template_required = template_required 3200 3201 @property 3202 def template_required_metadata(self): 3203 """Gets the template_required_metadata of this FormulaTab. # noqa: E501 3204 3205 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3206 3207 :return: The template_required_metadata of this FormulaTab. # noqa: E501 3208 :rtype: PropertyMetadata 3209 """ 3210 return self._template_required_metadata 3211 3212 @template_required_metadata.setter 3213 def template_required_metadata(self, template_required_metadata): 3214 """Sets the template_required_metadata of this FormulaTab. 3215 3216 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 3217 3218 :param template_required_metadata: The template_required_metadata of this FormulaTab. # noqa: E501 3219 :type: PropertyMetadata 3220 """ 3221 3222 self._template_required_metadata = template_required_metadata 3223 3224 @property 3225 def tooltip(self): 3226 """Gets the tooltip of this FormulaTab. # noqa: E501 3227 3228 # noqa: E501 3229 3230 :return: The tooltip of this FormulaTab. # noqa: E501 3231 :rtype: str 3232 """ 3233 return self._tooltip 3234 3235 @tooltip.setter 3236 def tooltip(self, tooltip): 3237 """Sets the tooltip of this FormulaTab. 3238 3239 # noqa: E501 3240 3241 :param tooltip: The tooltip of this FormulaTab. # noqa: E501 3242 :type: str 3243 """ 3244 3245 self._tooltip = tooltip 3246 3247 @property 3248 def tool_tip_metadata(self): 3249 """Gets the tool_tip_metadata of this FormulaTab. # noqa: E501 3250 3251 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3252 3253 :return: The tool_tip_metadata of this FormulaTab. # noqa: E501 3254 :rtype: PropertyMetadata 3255 """ 3256 return self._tool_tip_metadata 3257 3258 @tool_tip_metadata.setter 3259 def tool_tip_metadata(self, tool_tip_metadata): 3260 """Sets the tool_tip_metadata of this FormulaTab. 3261 3262 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3263 3264 :param tool_tip_metadata: The tool_tip_metadata of this FormulaTab. # noqa: E501 3265 :type: PropertyMetadata 3266 """ 3267 3268 self._tool_tip_metadata = tool_tip_metadata 3269 3270 @property 3271 def underline(self): 3272 """Gets the underline of this FormulaTab. # noqa: E501 3273 3274 When set to **true**, the information in the tab is underlined. # noqa: E501 3275 3276 :return: The underline of this FormulaTab. # noqa: E501 3277 :rtype: str 3278 """ 3279 return self._underline 3280 3281 @underline.setter 3282 def underline(self, underline): 3283 """Sets the underline of this FormulaTab. 3284 3285 When set to **true**, the information in the tab is underlined. # noqa: E501 3286 3287 :param underline: The underline of this FormulaTab. # noqa: E501 3288 :type: str 3289 """ 3290 3291 self._underline = underline 3292 3293 @property 3294 def underline_metadata(self): 3295 """Gets the underline_metadata of this FormulaTab. # noqa: E501 3296 3297 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3298 3299 :return: The underline_metadata of this FormulaTab. # noqa: E501 3300 :rtype: PropertyMetadata 3301 """ 3302 return self._underline_metadata 3303 3304 @underline_metadata.setter 3305 def underline_metadata(self, underline_metadata): 3306 """Sets the underline_metadata of this FormulaTab. 3307 3308 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3309 3310 :param underline_metadata: The underline_metadata of this FormulaTab. # noqa: E501 3311 :type: PropertyMetadata 3312 """ 3313 3314 self._underline_metadata = underline_metadata 3315 3316 @property 3317 def validation_message(self): 3318 """Gets the validation_message of this FormulaTab. # noqa: E501 3319 3320 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3321 3322 :return: The validation_message of this FormulaTab. # noqa: E501 3323 :rtype: str 3324 """ 3325 return self._validation_message 3326 3327 @validation_message.setter 3328 def validation_message(self, validation_message): 3329 """Sets the validation_message of this FormulaTab. 3330 3331 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3332 3333 :param validation_message: The validation_message of this FormulaTab. # noqa: E501 3334 :type: str 3335 """ 3336 3337 self._validation_message = validation_message 3338 3339 @property 3340 def validation_message_metadata(self): 3341 """Gets the validation_message_metadata of this FormulaTab. # noqa: E501 3342 3343 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3344 3345 :return: The validation_message_metadata of this FormulaTab. # noqa: E501 3346 :rtype: PropertyMetadata 3347 """ 3348 return self._validation_message_metadata 3349 3350 @validation_message_metadata.setter 3351 def validation_message_metadata(self, validation_message_metadata): 3352 """Sets the validation_message_metadata of this FormulaTab. 3353 3354 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3355 3356 :param validation_message_metadata: The validation_message_metadata of this FormulaTab. # noqa: E501 3357 :type: PropertyMetadata 3358 """ 3359 3360 self._validation_message_metadata = validation_message_metadata 3361 3362 @property 3363 def validation_pattern(self): 3364 """Gets the validation_pattern of this FormulaTab. # noqa: E501 3365 3366 A regular expression used to validate input for the tab. # noqa: E501 3367 3368 :return: The validation_pattern of this FormulaTab. # noqa: E501 3369 :rtype: str 3370 """ 3371 return self._validation_pattern 3372 3373 @validation_pattern.setter 3374 def validation_pattern(self, validation_pattern): 3375 """Sets the validation_pattern of this FormulaTab. 3376 3377 A regular expression used to validate input for the tab. # noqa: E501 3378 3379 :param validation_pattern: The validation_pattern of this FormulaTab. # noqa: E501 3380 :type: str 3381 """ 3382 3383 self._validation_pattern = validation_pattern 3384 3385 @property 3386 def validation_pattern_metadata(self): 3387 """Gets the validation_pattern_metadata of this FormulaTab. # noqa: E501 3388 3389 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3390 3391 :return: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3392 :rtype: PropertyMetadata 3393 """ 3394 return self._validation_pattern_metadata 3395 3396 @validation_pattern_metadata.setter 3397 def validation_pattern_metadata(self, validation_pattern_metadata): 3398 """Sets the validation_pattern_metadata of this FormulaTab. 3399 3400 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3401 3402 :param validation_pattern_metadata: The validation_pattern_metadata of this FormulaTab. # noqa: E501 3403 :type: PropertyMetadata 3404 """ 3405 3406 self._validation_pattern_metadata = validation_pattern_metadata 3407 3408 @property 3409 def value(self): 3410 """Gets the value of this FormulaTab. # noqa: E501 3411 3412 Specifies the value of the tab. # noqa: E501 3413 3414 :return: The value of this FormulaTab. # noqa: E501 3415 :rtype: str 3416 """ 3417 return self._value 3418 3419 @value.setter 3420 def value(self, value): 3421 """Sets the value of this FormulaTab. 3422 3423 Specifies the value of the tab. # noqa: E501 3424 3425 :param value: The value of this FormulaTab. # noqa: E501 3426 :type: str 3427 """ 3428 3429 self._value = value 3430 3431 @property 3432 def value_metadata(self): 3433 """Gets the value_metadata of this FormulaTab. # noqa: E501 3434 3435 Metadata that indicates whether the `value` property is editable. # noqa: E501 3436 3437 :return: The value_metadata of this FormulaTab. # noqa: E501 3438 :rtype: PropertyMetadata 3439 """ 3440 return self._value_metadata 3441 3442 @value_metadata.setter 3443 def value_metadata(self, value_metadata): 3444 """Sets the value_metadata of this FormulaTab. 3445 3446 Metadata that indicates whether the `value` property is editable. # noqa: E501 3447 3448 :param value_metadata: The value_metadata of this FormulaTab. # noqa: E501 3449 :type: PropertyMetadata 3450 """ 3451 3452 self._value_metadata = value_metadata 3453 3454 @property 3455 def warning_details(self): 3456 """Gets the warning_details of this FormulaTab. # noqa: E501 3457 3458 # noqa: E501 3459 3460 :return: The warning_details of this FormulaTab. # noqa: E501 3461 :rtype: ErrorDetails 3462 """ 3463 return self._warning_details 3464 3465 @warning_details.setter 3466 def warning_details(self, warning_details): 3467 """Sets the warning_details of this FormulaTab. 3468 3469 # noqa: E501 3470 3471 :param warning_details: The warning_details of this FormulaTab. # noqa: E501 3472 :type: ErrorDetails 3473 """ 3474 3475 self._warning_details = warning_details 3476 3477 @property 3478 def width(self): 3479 """Gets the width of this FormulaTab. # noqa: E501 3480 3481 Width of the tab in pixels. # noqa: E501 3482 3483 :return: The width of this FormulaTab. # noqa: E501 3484 :rtype: str 3485 """ 3486 return self._width 3487 3488 @width.setter 3489 def width(self, width): 3490 """Sets the width of this FormulaTab. 3491 3492 Width of the tab in pixels. # noqa: E501 3493 3494 :param width: The width of this FormulaTab. # noqa: E501 3495 :type: str 3496 """ 3497 3498 self._width = width 3499 3500 @property 3501 def width_metadata(self): 3502 """Gets the width_metadata of this FormulaTab. # noqa: E501 3503 3504 Metadata that indicates whether the `width` property is editable. # noqa: E501 3505 3506 :return: The width_metadata of this FormulaTab. # noqa: E501 3507 :rtype: PropertyMetadata 3508 """ 3509 return self._width_metadata 3510 3511 @width_metadata.setter 3512 def width_metadata(self, width_metadata): 3513 """Sets the width_metadata of this FormulaTab. 3514 3515 Metadata that indicates whether the `width` property is editable. # noqa: E501 3516 3517 :param width_metadata: The width_metadata of this FormulaTab. # noqa: E501 3518 :type: PropertyMetadata 3519 """ 3520 3521 self._width_metadata = width_metadata 3522 3523 @property 3524 def x_position(self): 3525 """Gets the x_position of this FormulaTab. # noqa: E501 3526 3527 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3528 3529 :return: The x_position of this FormulaTab. # noqa: E501 3530 :rtype: str 3531 """ 3532 return self._x_position 3533 3534 @x_position.setter 3535 def x_position(self, x_position): 3536 """Sets the x_position of this FormulaTab. 3537 3538 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3539 3540 :param x_position: The x_position of this FormulaTab. # noqa: E501 3541 :type: str 3542 """ 3543 3544 self._x_position = x_position 3545 3546 @property 3547 def x_position_metadata(self): 3548 """Gets the x_position_metadata of this FormulaTab. # noqa: E501 3549 3550 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3551 3552 :return: The x_position_metadata of this FormulaTab. # noqa: E501 3553 :rtype: PropertyMetadata 3554 """ 3555 return self._x_position_metadata 3556 3557 @x_position_metadata.setter 3558 def x_position_metadata(self, x_position_metadata): 3559 """Sets the x_position_metadata of this FormulaTab. 3560 3561 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3562 3563 :param x_position_metadata: The x_position_metadata of this FormulaTab. # noqa: E501 3564 :type: PropertyMetadata 3565 """ 3566 3567 self._x_position_metadata = x_position_metadata 3568 3569 @property 3570 def y_position(self): 3571 """Gets the y_position of this FormulaTab. # noqa: E501 3572 3573 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3574 3575 :return: The y_position of this FormulaTab. # noqa: E501 3576 :rtype: str 3577 """ 3578 return self._y_position 3579 3580 @y_position.setter 3581 def y_position(self, y_position): 3582 """Sets the y_position of this FormulaTab. 3583 3584 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3585 3586 :param y_position: The y_position of this FormulaTab. # noqa: E501 3587 :type: str 3588 """ 3589 3590 self._y_position = y_position 3591 3592 @property 3593 def y_position_metadata(self): 3594 """Gets the y_position_metadata of this FormulaTab. # noqa: E501 3595 3596 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3597 3598 :return: The y_position_metadata of this FormulaTab. # noqa: E501 3599 :rtype: PropertyMetadata 3600 """ 3601 return self._y_position_metadata 3602 3603 @y_position_metadata.setter 3604 def y_position_metadata(self, y_position_metadata): 3605 """Sets the y_position_metadata of this FormulaTab. 3606 3607 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3608 3609 :param y_position_metadata: The y_position_metadata of this FormulaTab. # noqa: E501 3610 :type: PropertyMetadata 3611 """ 3612 3613 self._y_position_metadata = y_position_metadata 3614 3615 def to_dict(self): 3616 """Returns the model properties as a dict""" 3617 result = {} 3618 3619 for attr, _ in six.iteritems(self.swagger_types): 3620 value = getattr(self, attr) 3621 if isinstance(value, list): 3622 result[attr] = list(map( 3623 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3624 value 3625 )) 3626 elif hasattr(value, "to_dict"): 3627 result[attr] = value.to_dict() 3628 elif isinstance(value, dict): 3629 result[attr] = dict(map( 3630 lambda item: (item[0], item[1].to_dict()) 3631 if hasattr(item[1], "to_dict") else item, 3632 value.items() 3633 )) 3634 else: 3635 result[attr] = value 3636 if issubclass(FormulaTab, dict): 3637 for key, value in self.items(): 3638 result[key] = value 3639 3640 return result 3641 3642 def to_str(self): 3643 """Returns the string representation of the model""" 3644 return pprint.pformat(self.to_dict()) 3645 3646 def __repr__(self): 3647 """For `print` and `pprint`""" 3648 return self.to_str() 3649 3650 def __eq__(self, other): 3651 """Returns true if both objects are equal""" 3652 if not isinstance(other, FormulaTab): 3653 return False 3654 3655 return self.to_dict() == other.to_dict() 3656 3657 def __ne__(self, other): 3658 """Returns true if both objects are not equal""" 3659 if not isinstance(other, FormulaTab): 3660 return True 3661 3662 return self.to_dict() != other.to_dict()
NOTE: This class is auto generated by the swagger code generator program.
Do not edit the class manually.
306 def __init__(self, _configuration=None, **kwargs): # noqa: E501 307 """FormulaTab - a model defined in Swagger""" # noqa: E501 308 if _configuration is None: 309 _configuration = Configuration() 310 self._configuration = _configuration 311 312 self._agreement_attribute = None 313 self._agreement_attribute_locked = None 314 self._anchor_allow_white_space_in_characters = None 315 self._anchor_allow_white_space_in_characters_metadata = None 316 self._anchor_case_sensitive = None 317 self._anchor_case_sensitive_metadata = None 318 self._anchor_horizontal_alignment = None 319 self._anchor_horizontal_alignment_metadata = None 320 self._anchor_ignore_if_not_present = None 321 self._anchor_ignore_if_not_present_metadata = None 322 self._anchor_match_whole_word = None 323 self._anchor_match_whole_word_metadata = None 324 self._anchor_string = None 325 self._anchor_string_metadata = None 326 self._anchor_tab_processor_version = None 327 self._anchor_tab_processor_version_metadata = None 328 self._anchor_tab_scope = None 329 self._anchor_units = None 330 self._anchor_units_metadata = None 331 self._anchor_x_offset = None 332 self._anchor_x_offset_metadata = None 333 self._anchor_y_offset = None 334 self._anchor_y_offset_metadata = None 335 self._bold = None 336 self._bold_metadata = None 337 self._caption = None 338 self._caption_metadata = None 339 self._conceal_value_on_document = None 340 self._conceal_value_on_document_metadata = None 341 self._conditional_parent_label = None 342 self._conditional_parent_label_metadata = None 343 self._conditional_parent_value = None 344 self._conditional_parent_value_metadata = None 345 self._connected_object_details = None 346 self._custom_tab_id = None 347 self._custom_tab_id_metadata = None 348 self._disable_auto_size = None 349 self._disable_auto_size_metadata = None 350 self._document_id = None 351 self._document_id_metadata = None 352 self._error_details = None 353 self._extension_data = None 354 self._font = None 355 self._font_color = None 356 self._font_color_metadata = None 357 self._font_metadata = None 358 self._font_size = None 359 self._font_size_metadata = None 360 self._form_order = None 361 self._form_order_metadata = None 362 self._form_page_label = None 363 self._form_page_label_metadata = None 364 self._form_page_number = None 365 self._form_page_number_metadata = None 366 self._formula = None 367 self._formula_metadata = None 368 self._height = None 369 self._height_metadata = None 370 self._hidden = None 371 self._hidden_metadata = None 372 self._is_payment_amount = None 373 self._is_payment_amount_metadata = None 374 self._italic = None 375 self._italic_metadata = None 376 self._locale_policy = None 377 self._locked = None 378 self._locked_metadata = None 379 self._max_length = None 380 self._max_length_metadata = None 381 self._merge_field = None 382 self._merge_field_xml = None 383 self._name = None 384 self._name_metadata = None 385 self._original_value = None 386 self._original_value_metadata = None 387 self._page_number = None 388 self._page_number_metadata = None 389 self._payment_details = None 390 self._recipient_id = None 391 self._recipient_id_guid = None 392 self._recipient_id_guid_metadata = None 393 self._recipient_id_metadata = None 394 self._require_all = None 395 self._require_all_metadata = None 396 self._required = None 397 self._required_metadata = None 398 self._require_initial_on_shared_change = None 399 self._require_initial_on_shared_change_metadata = None 400 self._round_decimal_places = None 401 self._round_decimal_places_metadata = None 402 self._sender_required = None 403 self._sender_required_metadata = None 404 self._shared = None 405 self._shared_metadata = None 406 self._share_to_recipients = None 407 self._share_to_recipients_metadata = None 408 self._smart_contract_information = None 409 self._source = None 410 self._status = None 411 self._status_metadata = None 412 self._tab_fully_qualified_path = None 413 self._tab_group_labels = None 414 self._tab_group_labels_metadata = None 415 self._tab_id = None 416 self._tab_id_metadata = None 417 self._tab_label = None 418 self._tab_label_metadata = None 419 self._tab_order = None 420 self._tab_order_metadata = None 421 self._tab_type = None 422 self._tab_type_metadata = None 423 self._template_locked = None 424 self._template_locked_metadata = None 425 self._template_required = None 426 self._template_required_metadata = None 427 self._tooltip = None 428 self._tool_tip_metadata = None 429 self._underline = None 430 self._underline_metadata = None 431 self._validation_message = None 432 self._validation_message_metadata = None 433 self._validation_pattern = None 434 self._validation_pattern_metadata = None 435 self._value = None 436 self._value_metadata = None 437 self._warning_details = None 438 self._width = None 439 self._width_metadata = None 440 self._x_position = None 441 self._x_position_metadata = None 442 self._y_position = None 443 self._y_position_metadata = None 444 self.discriminator = None 445 446 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 447 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 448 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 449 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 450 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 451 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 452 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 453 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 454 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 455 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 456 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 457 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 458 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 459 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 460 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 461 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 462 setattr(self, "_{}".format('anchor_tab_scope'), kwargs.get('anchor_tab_scope', None)) 463 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 464 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 465 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 466 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 467 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 468 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 469 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 470 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 471 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 472 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 473 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 474 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 475 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 476 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 477 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 478 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 479 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 480 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 481 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 482 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 483 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 484 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 485 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 486 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 487 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 488 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 489 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 490 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 491 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 492 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 493 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 494 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 495 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 496 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 497 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 498 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 499 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 500 setattr(self, "_{}".format('formula'), kwargs.get('formula', None)) 501 setattr(self, "_{}".format('formula_metadata'), kwargs.get('formula_metadata', None)) 502 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 503 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 504 setattr(self, "_{}".format('hidden'), kwargs.get('hidden', None)) 505 setattr(self, "_{}".format('hidden_metadata'), kwargs.get('hidden_metadata', None)) 506 setattr(self, "_{}".format('is_payment_amount'), kwargs.get('is_payment_amount', None)) 507 setattr(self, "_{}".format('is_payment_amount_metadata'), kwargs.get('is_payment_amount_metadata', None)) 508 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 509 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 510 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 511 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 512 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 513 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 514 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 515 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 516 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 517 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 518 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 519 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 520 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 521 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 522 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 523 setattr(self, "_{}".format('payment_details'), kwargs.get('payment_details', None)) 524 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 525 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 526 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 527 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 528 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 529 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 530 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 531 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 532 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 533 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 534 setattr(self, "_{}".format('round_decimal_places'), kwargs.get('round_decimal_places', None)) 535 setattr(self, "_{}".format('round_decimal_places_metadata'), kwargs.get('round_decimal_places_metadata', None)) 536 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 537 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 538 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 539 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 540 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 541 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 542 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 543 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 544 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 545 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 546 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 547 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 548 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 549 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 550 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 551 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 552 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 553 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 554 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 555 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 556 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 557 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 558 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 559 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 560 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 561 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 562 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 563 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 564 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 565 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 566 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 567 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 568 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 569 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 570 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 571 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 572 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 573 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 574 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 575 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 576 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 577 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None))
FormulaTab - a model defined in Swagger
Gets the agreement_attribute of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The agreement_attribute of this FormulaTab. # noqa: E501
Gets the agreement_attribute_locked of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The agreement_attribute_locked of this FormulaTab. # noqa: E501
Gets the anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The anchor_allow_white_space_in_characters of this FormulaTab. # noqa: E501
Gets the anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable. # noqa: E501
Returns
The anchor_allow_white_space_in_characters_metadata of this FormulaTab. # noqa: E501
Gets the anchor_case_sensitive of this FormulaTab. # noqa: E501
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true. # noqa: E501
Returns
The anchor_case_sensitive of this FormulaTab. # noqa: E501
Gets the anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorCaseSensitive property is editable. # noqa: E501
Returns
The anchor_case_sensitive_metadata of this FormulaTab. # noqa: E501
Gets the anchor_horizontal_alignment of this FormulaTab. # noqa: E501
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left. # noqa: E501
Returns
The anchor_horizontal_alignment of this FormulaTab. # noqa: E501
Gets the anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorHorizontalAlignment property is editable. # noqa: E501
Returns
The anchor_horizontal_alignment_metadata of this FormulaTab. # noqa: E501
Gets the anchor_ignore_if_not_present of this FormulaTab. # noqa: E501
When set to true, this tab is ignored if anchorString is not found in the document. # noqa: E501
Returns
The anchor_ignore_if_not_present of this FormulaTab. # noqa: E501
Gets the anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable. # noqa: E501
Returns
The anchor_ignore_if_not_present_metadata of this FormulaTab. # noqa: E501
Gets the anchor_match_whole_word of this FormulaTab. # noqa: E501
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
Returns
The anchor_match_whole_word of this FormulaTab. # noqa: E501
Gets the anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorMatchWholeWord property is editable. # noqa: E501
Returns
The anchor_match_whole_word_metadata of this FormulaTab. # noqa: E501
Gets the anchor_string of this FormulaTab. # noqa: E501
Anchor text information for a radio button. # noqa: E501
Returns
The anchor_string of this FormulaTab. # noqa: E501
Gets the anchor_string_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorString property is editable. # noqa: E501
Returns
The anchor_string_metadata of this FormulaTab. # noqa: E501
Gets the anchor_tab_processor_version of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The anchor_tab_processor_version of this FormulaTab. # noqa: E501
Gets the anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The anchor_tab_processor_version_metadata of this FormulaTab. # noqa: E501
Gets the anchor_tab_scope of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The anchor_tab_scope of this FormulaTab. # noqa: E501
Gets the anchor_units of this FormulaTab. # noqa: E501
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501
Returns
The anchor_units of this FormulaTab. # noqa: E501
Gets the anchor_units_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorUnits property is editable. # noqa: E501
Returns
The anchor_units_metadata of this FormulaTab. # noqa: E501
Gets the anchor_x_offset of this FormulaTab. # noqa: E501
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501
Returns
The anchor_x_offset of this FormulaTab. # noqa: E501
Gets the anchor_x_offset_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorXOffset property is editable. # noqa: E501
Returns
The anchor_x_offset_metadata of this FormulaTab. # noqa: E501
Gets the anchor_y_offset of this FormulaTab. # noqa: E501
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501
Returns
The anchor_y_offset of this FormulaTab. # noqa: E501
Gets the anchor_y_offset_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the anchorYOffset property is editable. # noqa: E501
Returns
The anchor_y_offset_metadata of this FormulaTab. # noqa: E501
Gets the bold of this FormulaTab. # noqa: E501
When set to true, the information in the tab is bold. # noqa: E501
Returns
The bold of this FormulaTab. # noqa: E501
Gets the bold_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the bold property is editable. # noqa: E501
Returns
The bold_metadata of this FormulaTab. # noqa: E501
Gets the caption of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The caption of this FormulaTab. # noqa: E501
Gets the caption_metadata of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The caption_metadata of this FormulaTab. # noqa: E501
Gets the conceal_value_on_document of this FormulaTab. # noqa: E501
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
Returns
The conceal_value_on_document of this FormulaTab. # noqa: E501
Gets the conceal_value_on_document_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the concealValueOnDocument property is editable. # noqa: E501
Returns
The conceal_value_on_document_metadata of this FormulaTab. # noqa: E501
Gets the conditional_parent_label of this FormulaTab. # noqa: E501
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501
Returns
The conditional_parent_label of this FormulaTab. # noqa: E501
Gets the conditional_parent_label_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the conditionalParentLabel property is editable. # noqa: E501
Returns
The conditional_parent_label_metadata of this FormulaTab. # noqa: E501
Gets the conditional_parent_value of this FormulaTab. # noqa: E501
For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. # noqa: E501
Returns
The conditional_parent_value of this FormulaTab. # noqa: E501
Gets the conditional_parent_value_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the conditionalParentValue property is editable. # noqa: E501
Returns
The conditional_parent_value_metadata of this FormulaTab. # noqa: E501
Gets the connected_object_details of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The connected_object_details of this FormulaTab. # noqa: E501
Gets the custom_tab_id of this FormulaTab. # noqa: E501
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
Returns
The custom_tab_id of this FormulaTab. # noqa: E501
Gets the custom_tab_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the customTabId property is editable. # noqa: E501
Returns
The custom_tab_id_metadata of this FormulaTab. # noqa: E501
Gets the disable_auto_size of this FormulaTab. # noqa: E501
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
Returns
The disable_auto_size of this FormulaTab. # noqa: E501
Gets the disable_auto_size_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the disableAutoSize property is editable. # noqa: E501
Returns
The disable_auto_size_metadata of this FormulaTab. # noqa: E501
Gets the document_id of this FormulaTab. # noqa: E501
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501
Returns
The document_id of this FormulaTab. # noqa: E501
Gets the document_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the documentId property is editable. # noqa: E501
Returns
The document_id_metadata of this FormulaTab. # noqa: E501
Gets the error_details of this FormulaTab. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this FormulaTab. # noqa: E501
Gets the extension_data of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The extension_data of this FormulaTab. # noqa: E501
Gets the font of this FormulaTab. # noqa: E501
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
Returns
The font of this FormulaTab. # noqa: E501
Gets the font_color of this FormulaTab. # noqa: E501
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
Returns
The font_color of this FormulaTab. # noqa: E501
Gets the font_color_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the fontColor property is editable. # noqa: E501
Returns
The font_color_metadata of this FormulaTab. # noqa: E501
Gets the font_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the font property is editable. # noqa: E501
Returns
The font_metadata of this FormulaTab. # noqa: E501
Gets the font_size of this FormulaTab. # noqa: E501
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
Returns
The font_size of this FormulaTab. # noqa: E501
Gets the font_size_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the fontSize property is editable. # noqa: E501
Returns
The font_size_metadata of this FormulaTab. # noqa: E501
Gets the form_order of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The form_order of this FormulaTab. # noqa: E501
Gets the form_order_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the formOrder property is editable. # noqa: E501
Returns
The form_order_metadata of this FormulaTab. # noqa: E501
Gets the form_page_label of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The form_page_label of this FormulaTab. # noqa: E501
Gets the form_page_label_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the formPageLabel property is editable. # noqa: E501
Returns
The form_page_label_metadata of this FormulaTab. # noqa: E501
Gets the form_page_number of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The form_page_number of this FormulaTab. # noqa: E501
Gets the form_page_number_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the fromPageNumber property is editable. # noqa: E501
Returns
The form_page_number_metadata of this FormulaTab. # noqa: E501
Gets the formula of this FormulaTab. # noqa: E501
The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. Example: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax] # noqa: E501
Returns
The formula of this FormulaTab. # noqa: E501
Gets the formula_metadata of this FormulaTab. # noqa: E501
Metadata indicating if the sender can edit the formula property. # noqa: E501
Returns
The formula_metadata of this FormulaTab. # noqa: E501
Gets the height of this FormulaTab. # noqa: E501
Height of the tab in pixels. # noqa: E501
Returns
The height of this FormulaTab. # noqa: E501
Gets the height_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the height property is editable. # noqa: E501
Returns
The height_metadata of this FormulaTab. # noqa: E501
Gets the is_payment_amount of this FormulaTab. # noqa: E501
When set to true, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. # noqa: E501
Returns
The is_payment_amount of this FormulaTab. # noqa: E501
Gets the is_payment_amount_metadata of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The is_payment_amount_metadata of this FormulaTab. # noqa: E501
Gets the italic of this FormulaTab. # noqa: E501
When set to true, the information in the tab is italic. # noqa: E501
Returns
The italic of this FormulaTab. # noqa: E501
Gets the italic_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the italic property is editable. # noqa: E501
Returns
The italic_metadata of this FormulaTab. # noqa: E501
Gets the locale_policy of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The locale_policy of this FormulaTab. # noqa: E501
Gets the locked of this FormulaTab. # noqa: E501
When set to true, the signer cannot change the data of the custom tab. # noqa: E501
Returns
The locked of this FormulaTab. # noqa: E501
Gets the locked_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the locked property is editable. # noqa: E501
Returns
The locked_metadata of this FormulaTab. # noqa: E501
Gets the max_length of this FormulaTab. # noqa: E501
An optional value that describes the maximum length of the property when the property is a string. # noqa: E501
Returns
The max_length of this FormulaTab. # noqa: E501
Gets the max_length_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the maxLength property is editable. # noqa: E501
Returns
The max_length_metadata of this FormulaTab. # noqa: E501
Gets the merge_field of this FormulaTab. # noqa: E501
Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501
Returns
The merge_field of this FormulaTab. # noqa: E501
Gets the merge_field_xml of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The merge_field_xml of this FormulaTab. # noqa: E501
Gets the name of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The name of this FormulaTab. # noqa: E501
Gets the name_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this FormulaTab. # noqa: E501
Gets the original_value of this FormulaTab. # noqa: E501
The initial value of the tab when it was sent to the recipient. # noqa: E501
Returns
The original_value of this FormulaTab. # noqa: E501
Gets the original_value_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the originalValue property is editable. # noqa: E501
Returns
The original_value_metadata of this FormulaTab. # noqa: E501
Gets the page_number of this FormulaTab. # noqa: E501
Specifies the page number on which the tab is located. # noqa: E501
Returns
The page_number of this FormulaTab. # noqa: E501
Gets the page_number_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the pageNumber property is editable. # noqa: E501
Returns
The page_number_metadata of this FormulaTab. # noqa: E501
Gets the payment_details of this FormulaTab. # noqa: E501
This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures # noqa: E501
Returns
The payment_details of this FormulaTab. # noqa: E501
Gets the recipient_id of this FormulaTab. # noqa: E501
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
Returns
The recipient_id of this FormulaTab. # noqa: E501
Gets the recipient_id_guid of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this FormulaTab. # noqa: E501
Gets the recipient_id_guid_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the recipientIdGuid property is editable. # noqa: E501
Returns
The recipient_id_guid_metadata of this FormulaTab. # noqa: E501
Gets the recipient_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the recipientId property is editable. # noqa: E501
Returns
The recipient_id_metadata of this FormulaTab. # noqa: E501
Gets the require_all of this FormulaTab. # noqa: E501
When set to true and shared is true, information must be entered in this field to complete the envelope. # noqa: E501
Returns
The require_all of this FormulaTab. # noqa: E501
Gets the require_all_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the requireAll property is editable. # noqa: E501
Returns
The require_all_metadata of this FormulaTab. # noqa: E501
Gets the required of this FormulaTab. # noqa: E501
When set to true, the signer is required to fill out this tab # noqa: E501
Returns
The required of this FormulaTab. # noqa: E501
Gets the required_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the required property is editable. # noqa: E501
Returns
The required_metadata of this FormulaTab. # noqa: E501
Gets the round_decimal_places of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The round_decimal_places of this FormulaTab. # noqa: E501
Gets the round_decimal_places_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the roundDecimalPlaces property is editable. # noqa: E501
Returns
The round_decimal_places_metadata of this FormulaTab. # noqa: E501
Gets the sender_required of this FormulaTab. # noqa: E501
When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a senderRequired value of true cannot be deleted from an envelope. # noqa: E501
Returns
The sender_required of this FormulaTab. # noqa: E501
Gets the sender_required_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the senderRequired property is editable. # noqa: E501
Returns
The sender_required_metadata of this FormulaTab. # noqa: E501
Gets the smart_contract_information of this FormulaTab. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The smart_contract_information of this FormulaTab. # noqa: E501
Gets the source of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The source of this FormulaTab. # noqa: E501
Gets the status of this FormulaTab. # noqa: E501
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
Returns
The status of this FormulaTab. # noqa: E501
Gets the status_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the status property is editable. # noqa: E501
Returns
The status_metadata of this FormulaTab. # noqa: E501
Gets the tab_fully_qualified_path of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_fully_qualified_path of this FormulaTab. # noqa: E501
Gets the tab_group_labels of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_group_labels of this FormulaTab. # noqa: E501
Gets the tab_group_labels_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabGroupLabels property is editable. # noqa: E501
Returns
The tab_group_labels_metadata of this FormulaTab. # noqa: E501
Gets the tab_id of this FormulaTab. # noqa: E501
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501
Returns
The tab_id of this FormulaTab. # noqa: E501
Gets the tab_id_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabId property is editable. # noqa: E501
Returns
The tab_id_metadata of this FormulaTab. # noqa: E501
Gets the tab_label of this FormulaTab. # noqa: E501
The label string associated with the tab. # noqa: E501
Returns
The tab_label of this FormulaTab. # noqa: E501
Gets the tab_label_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabLabel property is editable. # noqa: E501
Returns
The tab_label_metadata of this FormulaTab. # noqa: E501
Gets the tab_order of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_order of this FormulaTab. # noqa: E501
Gets the tab_order_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabOrder property is editable. # noqa: E501
Returns
The tab_order_metadata of this FormulaTab. # noqa: E501
Gets the tab_type of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tab_type of this FormulaTab. # noqa: E501
Gets the tab_type_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the tabType property is editable. # noqa: E501
Returns
The tab_type_metadata of this FormulaTab. # noqa: E501
Gets the template_locked of this FormulaTab. # noqa: E501
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_locked of this FormulaTab. # noqa: E501
Gets the template_locked_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the templateLocked property is editable. # noqa: E501
Returns
The template_locked_metadata of this FormulaTab. # noqa: E501
Gets the template_required of this FormulaTab. # noqa: E501
When set to true, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_required of this FormulaTab. # noqa: E501
Gets the template_required_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the templateRequired property is editable. # noqa: E501
Returns
The template_required_metadata of this FormulaTab. # noqa: E501
Gets the tooltip of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The tooltip of this FormulaTab. # noqa: E501
Gets the tool_tip_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the toolTip property is editable. # noqa: E501
Returns
The tool_tip_metadata of this FormulaTab. # noqa: E501
Gets the underline of this FormulaTab. # noqa: E501
When set to true, the information in the tab is underlined. # noqa: E501
Returns
The underline of this FormulaTab. # noqa: E501
Gets the underline_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the underline property is editable. # noqa: E501
Returns
The underline_metadata of this FormulaTab. # noqa: E501
Gets the validation_message of this FormulaTab. # noqa: E501
The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501
Returns
The validation_message of this FormulaTab. # noqa: E501
Gets the validation_message_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the validationMessage property is editable. # noqa: E501
Returns
The validation_message_metadata of this FormulaTab. # noqa: E501
Gets the validation_pattern of this FormulaTab. # noqa: E501
A regular expression used to validate input for the tab. # noqa: E501
Returns
The validation_pattern of this FormulaTab. # noqa: E501
Gets the validation_pattern_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the validationPattern property is editable. # noqa: E501
Returns
The validation_pattern_metadata of this FormulaTab. # noqa: E501
Gets the value of this FormulaTab. # noqa: E501
Specifies the value of the tab. # noqa: E501
Returns
The value of this FormulaTab. # noqa: E501
Gets the value_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the value property is editable. # noqa: E501
Returns
The value_metadata of this FormulaTab. # noqa: E501
Gets the warning_details of this FormulaTab. # noqa: E501
# noqa: E501
Returns
The warning_details of this FormulaTab. # noqa: E501
Gets the width of this FormulaTab. # noqa: E501
Width of the tab in pixels. # noqa: E501
Returns
The width of this FormulaTab. # noqa: E501
Gets the width_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the width property is editable. # noqa: E501
Returns
The width_metadata of this FormulaTab. # noqa: E501
Gets the x_position of this FormulaTab. # noqa: E501
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501
Returns
The x_position of this FormulaTab. # noqa: E501
Gets the x_position_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the xPosition property is editable. # noqa: E501
Returns
The x_position_metadata of this FormulaTab. # noqa: E501
Gets the y_position of this FormulaTab. # noqa: E501
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501
Returns
The y_position of this FormulaTab. # noqa: E501
Gets the y_position_metadata of this FormulaTab. # noqa: E501
Metadata that indicates whether the yPosition property is editable. # noqa: E501
Returns
The y_position_metadata of this FormulaTab. # noqa: E501
3615 def to_dict(self): 3616 """Returns the model properties as a dict""" 3617 result = {} 3618 3619 for attr, _ in six.iteritems(self.swagger_types): 3620 value = getattr(self, attr) 3621 if isinstance(value, list): 3622 result[attr] = list(map( 3623 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3624 value 3625 )) 3626 elif hasattr(value, "to_dict"): 3627 result[attr] = value.to_dict() 3628 elif isinstance(value, dict): 3629 result[attr] = dict(map( 3630 lambda item: (item[0], item[1].to_dict()) 3631 if hasattr(item[1], "to_dict") else item, 3632 value.items() 3633 )) 3634 else: 3635 result[attr] = value 3636 if issubclass(FormulaTab, dict): 3637 for key, value in self.items(): 3638 result[key] = value 3639 3640 return result
Returns the model properties as a dict