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