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