docusign_esign.models.tab_group
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 TabGroup(object): 23 """NOTE: This class is auto generated by the swagger code generator program. 24 25 Do not edit the class manually. 26 """ 27 28 """ 29 Attributes: 30 swagger_types (dict): The key is attribute name 31 and the value is attribute type. 32 attribute_map (dict): The key is attribute name 33 and the value is json key in definition. 34 """ 35 swagger_types = { 36 'agreement_attribute': 'str', 37 'agreement_attribute_locked': 'str', 38 'anchor_allow_white_space_in_characters': 'str', 39 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 40 'anchor_case_sensitive': 'str', 41 'anchor_case_sensitive_metadata': 'PropertyMetadata', 42 'anchor_horizontal_alignment': 'str', 43 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 44 'anchor_ignore_if_not_present': 'str', 45 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 46 'anchor_match_whole_word': 'str', 47 'anchor_match_whole_word_metadata': 'PropertyMetadata', 48 'anchor_string': 'str', 49 'anchor_string_metadata': 'PropertyMetadata', 50 'anchor_tab_processor_version': 'str', 51 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 52 'anchor_units': 'str', 53 'anchor_units_metadata': 'PropertyMetadata', 54 'anchor_x_offset': 'str', 55 'anchor_x_offset_metadata': 'PropertyMetadata', 56 'anchor_y_offset': 'str', 57 'anchor_y_offset_metadata': 'PropertyMetadata', 58 'caption': 'str', 59 'caption_metadata': 'PropertyMetadata', 60 'conditional_parent_label': 'str', 61 'conditional_parent_label_metadata': 'PropertyMetadata', 62 'conditional_parent_value': 'str', 63 'conditional_parent_value_metadata': 'PropertyMetadata', 64 'connected_object_details': 'ConnectedObjectDetails', 65 'custom_tab_id': 'str', 66 'custom_tab_id_metadata': 'PropertyMetadata', 67 'document_id': 'str', 68 'document_id_metadata': 'PropertyMetadata', 69 'error_details': 'ErrorDetails', 70 'extension_data': 'ExtensionData', 71 'form_order': 'str', 72 'form_order_metadata': 'PropertyMetadata', 73 'form_page_label': 'str', 74 'form_page_label_metadata': 'PropertyMetadata', 75 'form_page_number': 'str', 76 'form_page_number_metadata': 'PropertyMetadata', 77 'group_label': 'str', 78 'group_label_metadata': 'PropertyMetadata', 79 'group_rule': 'str', 80 'group_rule_metadata': 'PropertyMetadata', 81 'height': 'str', 82 'height_metadata': 'PropertyMetadata', 83 'maximum_allowed': 'str', 84 'maximum_allowed_metadata': 'PropertyMetadata', 85 'merge_field': 'MergeField', 86 'merge_field_xml': 'str', 87 'minimum_required': 'str', 88 'minimum_required_metadata': 'PropertyMetadata', 89 'page_number': 'str', 90 'page_number_metadata': 'PropertyMetadata', 91 'recipient_id': 'str', 92 'recipient_id_guid': 'str', 93 'recipient_id_guid_metadata': 'PropertyMetadata', 94 'recipient_id_metadata': 'PropertyMetadata', 95 'smart_contract_information': 'SmartContractInformation', 96 'source': 'str', 97 'status': 'str', 98 'status_metadata': 'PropertyMetadata', 99 'tab_fully_qualified_path': 'str', 100 'tab_group_labels': 'list[str]', 101 'tab_group_labels_metadata': 'PropertyMetadata', 102 'tab_id': 'str', 103 'tab_id_metadata': 'PropertyMetadata', 104 'tab_order': 'str', 105 'tab_order_metadata': 'PropertyMetadata', 106 'tab_scope': 'str', 107 'tab_scope_metadata': 'PropertyMetadata', 108 'tab_type': 'str', 109 'tab_type_metadata': 'PropertyMetadata', 110 'template_locked': 'str', 111 'template_locked_metadata': 'PropertyMetadata', 112 'template_required': 'str', 113 'template_required_metadata': 'PropertyMetadata', 114 'tooltip': 'str', 115 'tool_tip_metadata': 'PropertyMetadata', 116 'validation_message': 'str', 117 'validation_message_metadata': 'PropertyMetadata', 118 'warning_details': 'ErrorDetails', 119 'width': 'str', 120 'width_metadata': 'PropertyMetadata', 121 'x_position': 'str', 122 'x_position_metadata': 'PropertyMetadata', 123 'y_position': 'str', 124 'y_position_metadata': 'PropertyMetadata' 125 } 126 127 attribute_map = { 128 'agreement_attribute': 'agreementAttribute', 129 'agreement_attribute_locked': 'agreementAttributeLocked', 130 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 131 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 132 'anchor_case_sensitive': 'anchorCaseSensitive', 133 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 134 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 135 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 136 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 137 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 138 'anchor_match_whole_word': 'anchorMatchWholeWord', 139 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 140 'anchor_string': 'anchorString', 141 'anchor_string_metadata': 'anchorStringMetadata', 142 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 143 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 144 'anchor_units': 'anchorUnits', 145 'anchor_units_metadata': 'anchorUnitsMetadata', 146 'anchor_x_offset': 'anchorXOffset', 147 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 148 'anchor_y_offset': 'anchorYOffset', 149 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 150 'caption': 'caption', 151 'caption_metadata': 'captionMetadata', 152 'conditional_parent_label': 'conditionalParentLabel', 153 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 154 'conditional_parent_value': 'conditionalParentValue', 155 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 156 'connected_object_details': 'connectedObjectDetails', 157 'custom_tab_id': 'customTabId', 158 'custom_tab_id_metadata': 'customTabIdMetadata', 159 'document_id': 'documentId', 160 'document_id_metadata': 'documentIdMetadata', 161 'error_details': 'errorDetails', 162 'extension_data': 'extensionData', 163 'form_order': 'formOrder', 164 'form_order_metadata': 'formOrderMetadata', 165 'form_page_label': 'formPageLabel', 166 'form_page_label_metadata': 'formPageLabelMetadata', 167 'form_page_number': 'formPageNumber', 168 'form_page_number_metadata': 'formPageNumberMetadata', 169 'group_label': 'groupLabel', 170 'group_label_metadata': 'groupLabelMetadata', 171 'group_rule': 'groupRule', 172 'group_rule_metadata': 'groupRuleMetadata', 173 'height': 'height', 174 'height_metadata': 'heightMetadata', 175 'maximum_allowed': 'maximumAllowed', 176 'maximum_allowed_metadata': 'maximumAllowedMetadata', 177 'merge_field': 'mergeField', 178 'merge_field_xml': 'mergeFieldXml', 179 'minimum_required': 'minimumRequired', 180 'minimum_required_metadata': 'minimumRequiredMetadata', 181 'page_number': 'pageNumber', 182 'page_number_metadata': 'pageNumberMetadata', 183 'recipient_id': 'recipientId', 184 'recipient_id_guid': 'recipientIdGuid', 185 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 186 'recipient_id_metadata': 'recipientIdMetadata', 187 'smart_contract_information': 'smartContractInformation', 188 'source': 'source', 189 'status': 'status', 190 'status_metadata': 'statusMetadata', 191 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 192 'tab_group_labels': 'tabGroupLabels', 193 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 194 'tab_id': 'tabId', 195 'tab_id_metadata': 'tabIdMetadata', 196 'tab_order': 'tabOrder', 197 'tab_order_metadata': 'tabOrderMetadata', 198 'tab_scope': 'tabScope', 199 'tab_scope_metadata': 'tabScopeMetadata', 200 'tab_type': 'tabType', 201 'tab_type_metadata': 'tabTypeMetadata', 202 'template_locked': 'templateLocked', 203 'template_locked_metadata': 'templateLockedMetadata', 204 'template_required': 'templateRequired', 205 'template_required_metadata': 'templateRequiredMetadata', 206 'tooltip': 'tooltip', 207 'tool_tip_metadata': 'toolTipMetadata', 208 'validation_message': 'validationMessage', 209 'validation_message_metadata': 'validationMessageMetadata', 210 'warning_details': 'warningDetails', 211 'width': 'width', 212 'width_metadata': 'widthMetadata', 213 'x_position': 'xPosition', 214 'x_position_metadata': 'xPositionMetadata', 215 'y_position': 'yPosition', 216 'y_position_metadata': 'yPositionMetadata' 217 } 218 219 def __init__(self, _configuration=None, **kwargs): # noqa: E501 220 """TabGroup - a model defined in Swagger""" # noqa: E501 221 if _configuration is None: 222 _configuration = Configuration() 223 self._configuration = _configuration 224 225 self._agreement_attribute = None 226 self._agreement_attribute_locked = None 227 self._anchor_allow_white_space_in_characters = None 228 self._anchor_allow_white_space_in_characters_metadata = None 229 self._anchor_case_sensitive = None 230 self._anchor_case_sensitive_metadata = None 231 self._anchor_horizontal_alignment = None 232 self._anchor_horizontal_alignment_metadata = None 233 self._anchor_ignore_if_not_present = None 234 self._anchor_ignore_if_not_present_metadata = None 235 self._anchor_match_whole_word = None 236 self._anchor_match_whole_word_metadata = None 237 self._anchor_string = None 238 self._anchor_string_metadata = None 239 self._anchor_tab_processor_version = None 240 self._anchor_tab_processor_version_metadata = None 241 self._anchor_units = None 242 self._anchor_units_metadata = None 243 self._anchor_x_offset = None 244 self._anchor_x_offset_metadata = None 245 self._anchor_y_offset = None 246 self._anchor_y_offset_metadata = None 247 self._caption = None 248 self._caption_metadata = None 249 self._conditional_parent_label = None 250 self._conditional_parent_label_metadata = None 251 self._conditional_parent_value = None 252 self._conditional_parent_value_metadata = None 253 self._connected_object_details = None 254 self._custom_tab_id = None 255 self._custom_tab_id_metadata = None 256 self._document_id = None 257 self._document_id_metadata = None 258 self._error_details = None 259 self._extension_data = None 260 self._form_order = None 261 self._form_order_metadata = None 262 self._form_page_label = None 263 self._form_page_label_metadata = None 264 self._form_page_number = None 265 self._form_page_number_metadata = None 266 self._group_label = None 267 self._group_label_metadata = None 268 self._group_rule = None 269 self._group_rule_metadata = None 270 self._height = None 271 self._height_metadata = None 272 self._maximum_allowed = None 273 self._maximum_allowed_metadata = None 274 self._merge_field = None 275 self._merge_field_xml = None 276 self._minimum_required = None 277 self._minimum_required_metadata = None 278 self._page_number = None 279 self._page_number_metadata = None 280 self._recipient_id = None 281 self._recipient_id_guid = None 282 self._recipient_id_guid_metadata = None 283 self._recipient_id_metadata = None 284 self._smart_contract_information = None 285 self._source = None 286 self._status = None 287 self._status_metadata = None 288 self._tab_fully_qualified_path = None 289 self._tab_group_labels = None 290 self._tab_group_labels_metadata = None 291 self._tab_id = None 292 self._tab_id_metadata = None 293 self._tab_order = None 294 self._tab_order_metadata = None 295 self._tab_scope = None 296 self._tab_scope_metadata = None 297 self._tab_type = None 298 self._tab_type_metadata = None 299 self._template_locked = None 300 self._template_locked_metadata = None 301 self._template_required = None 302 self._template_required_metadata = None 303 self._tooltip = None 304 self._tool_tip_metadata = None 305 self._validation_message = None 306 self._validation_message_metadata = None 307 self._warning_details = None 308 self._width = None 309 self._width_metadata = None 310 self._x_position = None 311 self._x_position_metadata = None 312 self._y_position = None 313 self._y_position_metadata = None 314 self.discriminator = None 315 316 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 317 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 318 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 319 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 320 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 321 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 322 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 323 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 324 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 325 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 326 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 327 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 328 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 329 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 330 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 331 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 332 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 333 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 334 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 335 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 336 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 337 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 338 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 339 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 340 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 341 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 342 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 343 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 344 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 345 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 346 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 347 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 348 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 349 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 350 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 351 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 352 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 353 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 354 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 355 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 356 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 357 setattr(self, "_{}".format('group_label'), kwargs.get('group_label', None)) 358 setattr(self, "_{}".format('group_label_metadata'), kwargs.get('group_label_metadata', None)) 359 setattr(self, "_{}".format('group_rule'), kwargs.get('group_rule', None)) 360 setattr(self, "_{}".format('group_rule_metadata'), kwargs.get('group_rule_metadata', None)) 361 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 362 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 363 setattr(self, "_{}".format('maximum_allowed'), kwargs.get('maximum_allowed', None)) 364 setattr(self, "_{}".format('maximum_allowed_metadata'), kwargs.get('maximum_allowed_metadata', None)) 365 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 366 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 367 setattr(self, "_{}".format('minimum_required'), kwargs.get('minimum_required', None)) 368 setattr(self, "_{}".format('minimum_required_metadata'), kwargs.get('minimum_required_metadata', None)) 369 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 370 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 371 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 372 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 373 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 374 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 375 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 376 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 377 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 378 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 379 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 380 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 381 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 382 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 383 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 384 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 385 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 386 setattr(self, "_{}".format('tab_scope'), kwargs.get('tab_scope', None)) 387 setattr(self, "_{}".format('tab_scope_metadata'), kwargs.get('tab_scope_metadata', None)) 388 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 389 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 390 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 391 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 392 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 393 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 394 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 395 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 396 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 397 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 398 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 399 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 400 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 401 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 402 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 403 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 404 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 405 406 @property 407 def agreement_attribute(self): 408 """Gets the agreement_attribute of this TabGroup. # noqa: E501 409 410 # noqa: E501 411 412 :return: The agreement_attribute of this TabGroup. # noqa: E501 413 :rtype: str 414 """ 415 return self._agreement_attribute 416 417 @agreement_attribute.setter 418 def agreement_attribute(self, agreement_attribute): 419 """Sets the agreement_attribute of this TabGroup. 420 421 # noqa: E501 422 423 :param agreement_attribute: The agreement_attribute of this TabGroup. # noqa: E501 424 :type: str 425 """ 426 427 self._agreement_attribute = agreement_attribute 428 429 @property 430 def agreement_attribute_locked(self): 431 """Gets the agreement_attribute_locked of this TabGroup. # noqa: E501 432 433 # noqa: E501 434 435 :return: The agreement_attribute_locked of this TabGroup. # noqa: E501 436 :rtype: str 437 """ 438 return self._agreement_attribute_locked 439 440 @agreement_attribute_locked.setter 441 def agreement_attribute_locked(self, agreement_attribute_locked): 442 """Sets the agreement_attribute_locked of this TabGroup. 443 444 # noqa: E501 445 446 :param agreement_attribute_locked: The agreement_attribute_locked of this TabGroup. # noqa: E501 447 :type: str 448 """ 449 450 self._agreement_attribute_locked = agreement_attribute_locked 451 452 @property 453 def anchor_allow_white_space_in_characters(self): 454 """Gets the anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501 455 456 # noqa: E501 457 458 :return: The anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501 459 :rtype: str 460 """ 461 return self._anchor_allow_white_space_in_characters 462 463 @anchor_allow_white_space_in_characters.setter 464 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 465 """Sets the anchor_allow_white_space_in_characters of this TabGroup. 466 467 # noqa: E501 468 469 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501 470 :type: str 471 """ 472 473 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 474 475 @property 476 def anchor_allow_white_space_in_characters_metadata(self): 477 """Gets the anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501 478 479 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 480 481 :return: The anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501 482 :rtype: PropertyMetadata 483 """ 484 return self._anchor_allow_white_space_in_characters_metadata 485 486 @anchor_allow_white_space_in_characters_metadata.setter 487 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 488 """Sets the anchor_allow_white_space_in_characters_metadata of this TabGroup. 489 490 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 491 492 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501 493 :type: PropertyMetadata 494 """ 495 496 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 497 498 @property 499 def anchor_case_sensitive(self): 500 """Gets the anchor_case_sensitive of this TabGroup. # noqa: E501 501 502 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 503 504 :return: The anchor_case_sensitive of this TabGroup. # noqa: E501 505 :rtype: str 506 """ 507 return self._anchor_case_sensitive 508 509 @anchor_case_sensitive.setter 510 def anchor_case_sensitive(self, anchor_case_sensitive): 511 """Sets the anchor_case_sensitive of this TabGroup. 512 513 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 514 515 :param anchor_case_sensitive: The anchor_case_sensitive of this TabGroup. # noqa: E501 516 :type: str 517 """ 518 519 self._anchor_case_sensitive = anchor_case_sensitive 520 521 @property 522 def anchor_case_sensitive_metadata(self): 523 """Gets the anchor_case_sensitive_metadata of this TabGroup. # noqa: E501 524 525 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 526 527 :return: The anchor_case_sensitive_metadata of this TabGroup. # noqa: E501 528 :rtype: PropertyMetadata 529 """ 530 return self._anchor_case_sensitive_metadata 531 532 @anchor_case_sensitive_metadata.setter 533 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 534 """Sets the anchor_case_sensitive_metadata of this TabGroup. 535 536 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 537 538 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this TabGroup. # noqa: E501 539 :type: PropertyMetadata 540 """ 541 542 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 543 544 @property 545 def anchor_horizontal_alignment(self): 546 """Gets the anchor_horizontal_alignment of this TabGroup. # noqa: E501 547 548 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 549 550 :return: The anchor_horizontal_alignment of this TabGroup. # noqa: E501 551 :rtype: str 552 """ 553 return self._anchor_horizontal_alignment 554 555 @anchor_horizontal_alignment.setter 556 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 557 """Sets the anchor_horizontal_alignment of this TabGroup. 558 559 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 560 561 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this TabGroup. # noqa: E501 562 :type: str 563 """ 564 565 self._anchor_horizontal_alignment = anchor_horizontal_alignment 566 567 @property 568 def anchor_horizontal_alignment_metadata(self): 569 """Gets the anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501 570 571 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 572 573 :return: The anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501 574 :rtype: PropertyMetadata 575 """ 576 return self._anchor_horizontal_alignment_metadata 577 578 @anchor_horizontal_alignment_metadata.setter 579 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 580 """Sets the anchor_horizontal_alignment_metadata of this TabGroup. 581 582 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 583 584 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501 585 :type: PropertyMetadata 586 """ 587 588 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 589 590 @property 591 def anchor_ignore_if_not_present(self): 592 """Gets the anchor_ignore_if_not_present of this TabGroup. # noqa: E501 593 594 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 595 596 :return: The anchor_ignore_if_not_present of this TabGroup. # noqa: E501 597 :rtype: str 598 """ 599 return self._anchor_ignore_if_not_present 600 601 @anchor_ignore_if_not_present.setter 602 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 603 """Sets the anchor_ignore_if_not_present of this TabGroup. 604 605 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 606 607 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this TabGroup. # noqa: E501 608 :type: str 609 """ 610 611 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 612 613 @property 614 def anchor_ignore_if_not_present_metadata(self): 615 """Gets the anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501 616 617 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 618 619 :return: The anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501 620 :rtype: PropertyMetadata 621 """ 622 return self._anchor_ignore_if_not_present_metadata 623 624 @anchor_ignore_if_not_present_metadata.setter 625 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 626 """Sets the anchor_ignore_if_not_present_metadata of this TabGroup. 627 628 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 629 630 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501 631 :type: PropertyMetadata 632 """ 633 634 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 635 636 @property 637 def anchor_match_whole_word(self): 638 """Gets the anchor_match_whole_word of this TabGroup. # noqa: E501 639 640 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 641 642 :return: The anchor_match_whole_word of this TabGroup. # noqa: E501 643 :rtype: str 644 """ 645 return self._anchor_match_whole_word 646 647 @anchor_match_whole_word.setter 648 def anchor_match_whole_word(self, anchor_match_whole_word): 649 """Sets the anchor_match_whole_word of this TabGroup. 650 651 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 652 653 :param anchor_match_whole_word: The anchor_match_whole_word of this TabGroup. # noqa: E501 654 :type: str 655 """ 656 657 self._anchor_match_whole_word = anchor_match_whole_word 658 659 @property 660 def anchor_match_whole_word_metadata(self): 661 """Gets the anchor_match_whole_word_metadata of this TabGroup. # noqa: E501 662 663 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 664 665 :return: The anchor_match_whole_word_metadata of this TabGroup. # noqa: E501 666 :rtype: PropertyMetadata 667 """ 668 return self._anchor_match_whole_word_metadata 669 670 @anchor_match_whole_word_metadata.setter 671 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 672 """Sets the anchor_match_whole_word_metadata of this TabGroup. 673 674 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 675 676 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this TabGroup. # noqa: E501 677 :type: PropertyMetadata 678 """ 679 680 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 681 682 @property 683 def anchor_string(self): 684 """Gets the anchor_string of this TabGroup. # noqa: E501 685 686 Anchor text information for a radio button. # noqa: E501 687 688 :return: The anchor_string of this TabGroup. # noqa: E501 689 :rtype: str 690 """ 691 return self._anchor_string 692 693 @anchor_string.setter 694 def anchor_string(self, anchor_string): 695 """Sets the anchor_string of this TabGroup. 696 697 Anchor text information for a radio button. # noqa: E501 698 699 :param anchor_string: The anchor_string of this TabGroup. # noqa: E501 700 :type: str 701 """ 702 703 self._anchor_string = anchor_string 704 705 @property 706 def anchor_string_metadata(self): 707 """Gets the anchor_string_metadata of this TabGroup. # noqa: E501 708 709 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 710 711 :return: The anchor_string_metadata of this TabGroup. # noqa: E501 712 :rtype: PropertyMetadata 713 """ 714 return self._anchor_string_metadata 715 716 @anchor_string_metadata.setter 717 def anchor_string_metadata(self, anchor_string_metadata): 718 """Sets the anchor_string_metadata of this TabGroup. 719 720 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 721 722 :param anchor_string_metadata: The anchor_string_metadata of this TabGroup. # noqa: E501 723 :type: PropertyMetadata 724 """ 725 726 self._anchor_string_metadata = anchor_string_metadata 727 728 @property 729 def anchor_tab_processor_version(self): 730 """Gets the anchor_tab_processor_version of this TabGroup. # noqa: E501 731 732 # noqa: E501 733 734 :return: The anchor_tab_processor_version of this TabGroup. # noqa: E501 735 :rtype: str 736 """ 737 return self._anchor_tab_processor_version 738 739 @anchor_tab_processor_version.setter 740 def anchor_tab_processor_version(self, anchor_tab_processor_version): 741 """Sets the anchor_tab_processor_version of this TabGroup. 742 743 # noqa: E501 744 745 :param anchor_tab_processor_version: The anchor_tab_processor_version of this TabGroup. # noqa: E501 746 :type: str 747 """ 748 749 self._anchor_tab_processor_version = anchor_tab_processor_version 750 751 @property 752 def anchor_tab_processor_version_metadata(self): 753 """Gets the anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501 754 755 Reserved for DocuSign. # noqa: E501 756 757 :return: The anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501 758 :rtype: PropertyMetadata 759 """ 760 return self._anchor_tab_processor_version_metadata 761 762 @anchor_tab_processor_version_metadata.setter 763 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 764 """Sets the anchor_tab_processor_version_metadata of this TabGroup. 765 766 Reserved for DocuSign. # noqa: E501 767 768 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501 769 :type: PropertyMetadata 770 """ 771 772 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 773 774 @property 775 def anchor_units(self): 776 """Gets the anchor_units of this TabGroup. # noqa: E501 777 778 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 779 780 :return: The anchor_units of this TabGroup. # noqa: E501 781 :rtype: str 782 """ 783 return self._anchor_units 784 785 @anchor_units.setter 786 def anchor_units(self, anchor_units): 787 """Sets the anchor_units of this TabGroup. 788 789 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 790 791 :param anchor_units: The anchor_units of this TabGroup. # noqa: E501 792 :type: str 793 """ 794 795 self._anchor_units = anchor_units 796 797 @property 798 def anchor_units_metadata(self): 799 """Gets the anchor_units_metadata of this TabGroup. # noqa: E501 800 801 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 802 803 :return: The anchor_units_metadata of this TabGroup. # noqa: E501 804 :rtype: PropertyMetadata 805 """ 806 return self._anchor_units_metadata 807 808 @anchor_units_metadata.setter 809 def anchor_units_metadata(self, anchor_units_metadata): 810 """Sets the anchor_units_metadata of this TabGroup. 811 812 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 813 814 :param anchor_units_metadata: The anchor_units_metadata of this TabGroup. # noqa: E501 815 :type: PropertyMetadata 816 """ 817 818 self._anchor_units_metadata = anchor_units_metadata 819 820 @property 821 def anchor_x_offset(self): 822 """Gets the anchor_x_offset of this TabGroup. # noqa: E501 823 824 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 825 826 :return: The anchor_x_offset of this TabGroup. # noqa: E501 827 :rtype: str 828 """ 829 return self._anchor_x_offset 830 831 @anchor_x_offset.setter 832 def anchor_x_offset(self, anchor_x_offset): 833 """Sets the anchor_x_offset of this TabGroup. 834 835 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 836 837 :param anchor_x_offset: The anchor_x_offset of this TabGroup. # noqa: E501 838 :type: str 839 """ 840 841 self._anchor_x_offset = anchor_x_offset 842 843 @property 844 def anchor_x_offset_metadata(self): 845 """Gets the anchor_x_offset_metadata of this TabGroup. # noqa: E501 846 847 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 848 849 :return: The anchor_x_offset_metadata of this TabGroup. # noqa: E501 850 :rtype: PropertyMetadata 851 """ 852 return self._anchor_x_offset_metadata 853 854 @anchor_x_offset_metadata.setter 855 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 856 """Sets the anchor_x_offset_metadata of this TabGroup. 857 858 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 859 860 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this TabGroup. # noqa: E501 861 :type: PropertyMetadata 862 """ 863 864 self._anchor_x_offset_metadata = anchor_x_offset_metadata 865 866 @property 867 def anchor_y_offset(self): 868 """Gets the anchor_y_offset of this TabGroup. # noqa: E501 869 870 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 871 872 :return: The anchor_y_offset of this TabGroup. # noqa: E501 873 :rtype: str 874 """ 875 return self._anchor_y_offset 876 877 @anchor_y_offset.setter 878 def anchor_y_offset(self, anchor_y_offset): 879 """Sets the anchor_y_offset of this TabGroup. 880 881 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 882 883 :param anchor_y_offset: The anchor_y_offset of this TabGroup. # noqa: E501 884 :type: str 885 """ 886 887 self._anchor_y_offset = anchor_y_offset 888 889 @property 890 def anchor_y_offset_metadata(self): 891 """Gets the anchor_y_offset_metadata of this TabGroup. # noqa: E501 892 893 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 894 895 :return: The anchor_y_offset_metadata of this TabGroup. # noqa: E501 896 :rtype: PropertyMetadata 897 """ 898 return self._anchor_y_offset_metadata 899 900 @anchor_y_offset_metadata.setter 901 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 902 """Sets the anchor_y_offset_metadata of this TabGroup. 903 904 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 905 906 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this TabGroup. # noqa: E501 907 :type: PropertyMetadata 908 """ 909 910 self._anchor_y_offset_metadata = anchor_y_offset_metadata 911 912 @property 913 def caption(self): 914 """Gets the caption of this TabGroup. # noqa: E501 915 916 # noqa: E501 917 918 :return: The caption of this TabGroup. # noqa: E501 919 :rtype: str 920 """ 921 return self._caption 922 923 @caption.setter 924 def caption(self, caption): 925 """Sets the caption of this TabGroup. 926 927 # noqa: E501 928 929 :param caption: The caption of this TabGroup. # noqa: E501 930 :type: str 931 """ 932 933 self._caption = caption 934 935 @property 936 def caption_metadata(self): 937 """Gets the caption_metadata of this TabGroup. # noqa: E501 938 939 # noqa: E501 940 941 :return: The caption_metadata of this TabGroup. # noqa: E501 942 :rtype: PropertyMetadata 943 """ 944 return self._caption_metadata 945 946 @caption_metadata.setter 947 def caption_metadata(self, caption_metadata): 948 """Sets the caption_metadata of this TabGroup. 949 950 # noqa: E501 951 952 :param caption_metadata: The caption_metadata of this TabGroup. # noqa: E501 953 :type: PropertyMetadata 954 """ 955 956 self._caption_metadata = caption_metadata 957 958 @property 959 def conditional_parent_label(self): 960 """Gets the conditional_parent_label of this TabGroup. # noqa: E501 961 962 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 963 964 :return: The conditional_parent_label of this TabGroup. # noqa: E501 965 :rtype: str 966 """ 967 return self._conditional_parent_label 968 969 @conditional_parent_label.setter 970 def conditional_parent_label(self, conditional_parent_label): 971 """Sets the conditional_parent_label of this TabGroup. 972 973 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 974 975 :param conditional_parent_label: The conditional_parent_label of this TabGroup. # noqa: E501 976 :type: str 977 """ 978 979 self._conditional_parent_label = conditional_parent_label 980 981 @property 982 def conditional_parent_label_metadata(self): 983 """Gets the conditional_parent_label_metadata of this TabGroup. # noqa: E501 984 985 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 986 987 :return: The conditional_parent_label_metadata of this TabGroup. # noqa: E501 988 :rtype: PropertyMetadata 989 """ 990 return self._conditional_parent_label_metadata 991 992 @conditional_parent_label_metadata.setter 993 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 994 """Sets the conditional_parent_label_metadata of this TabGroup. 995 996 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 997 998 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this TabGroup. # noqa: E501 999 :type: PropertyMetadata 1000 """ 1001 1002 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1003 1004 @property 1005 def conditional_parent_value(self): 1006 """Gets the conditional_parent_value of this TabGroup. # noqa: E501 1007 1008 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 1009 1010 :return: The conditional_parent_value of this TabGroup. # noqa: E501 1011 :rtype: str 1012 """ 1013 return self._conditional_parent_value 1014 1015 @conditional_parent_value.setter 1016 def conditional_parent_value(self, conditional_parent_value): 1017 """Sets the conditional_parent_value of this TabGroup. 1018 1019 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 1020 1021 :param conditional_parent_value: The conditional_parent_value of this TabGroup. # noqa: E501 1022 :type: str 1023 """ 1024 1025 self._conditional_parent_value = conditional_parent_value 1026 1027 @property 1028 def conditional_parent_value_metadata(self): 1029 """Gets the conditional_parent_value_metadata of this TabGroup. # noqa: E501 1030 1031 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1032 1033 :return: The conditional_parent_value_metadata of this TabGroup. # noqa: E501 1034 :rtype: PropertyMetadata 1035 """ 1036 return self._conditional_parent_value_metadata 1037 1038 @conditional_parent_value_metadata.setter 1039 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1040 """Sets the conditional_parent_value_metadata of this TabGroup. 1041 1042 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1043 1044 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this TabGroup. # noqa: E501 1045 :type: PropertyMetadata 1046 """ 1047 1048 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1049 1050 @property 1051 def connected_object_details(self): 1052 """Gets the connected_object_details of this TabGroup. # noqa: E501 1053 1054 # noqa: E501 1055 1056 :return: The connected_object_details of this TabGroup. # noqa: E501 1057 :rtype: ConnectedObjectDetails 1058 """ 1059 return self._connected_object_details 1060 1061 @connected_object_details.setter 1062 def connected_object_details(self, connected_object_details): 1063 """Sets the connected_object_details of this TabGroup. 1064 1065 # noqa: E501 1066 1067 :param connected_object_details: The connected_object_details of this TabGroup. # noqa: E501 1068 :type: ConnectedObjectDetails 1069 """ 1070 1071 self._connected_object_details = connected_object_details 1072 1073 @property 1074 def custom_tab_id(self): 1075 """Gets the custom_tab_id of this TabGroup. # noqa: E501 1076 1077 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 1078 1079 :return: The custom_tab_id of this TabGroup. # noqa: E501 1080 :rtype: str 1081 """ 1082 return self._custom_tab_id 1083 1084 @custom_tab_id.setter 1085 def custom_tab_id(self, custom_tab_id): 1086 """Sets the custom_tab_id of this TabGroup. 1087 1088 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 1089 1090 :param custom_tab_id: The custom_tab_id of this TabGroup. # noqa: E501 1091 :type: str 1092 """ 1093 1094 self._custom_tab_id = custom_tab_id 1095 1096 @property 1097 def custom_tab_id_metadata(self): 1098 """Gets the custom_tab_id_metadata of this TabGroup. # noqa: E501 1099 1100 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1101 1102 :return: The custom_tab_id_metadata of this TabGroup. # noqa: E501 1103 :rtype: PropertyMetadata 1104 """ 1105 return self._custom_tab_id_metadata 1106 1107 @custom_tab_id_metadata.setter 1108 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1109 """Sets the custom_tab_id_metadata of this TabGroup. 1110 1111 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1112 1113 :param custom_tab_id_metadata: The custom_tab_id_metadata of this TabGroup. # noqa: E501 1114 :type: PropertyMetadata 1115 """ 1116 1117 self._custom_tab_id_metadata = custom_tab_id_metadata 1118 1119 @property 1120 def document_id(self): 1121 """Gets the document_id of this TabGroup. # noqa: E501 1122 1123 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1124 1125 :return: The document_id of this TabGroup. # noqa: E501 1126 :rtype: str 1127 """ 1128 return self._document_id 1129 1130 @document_id.setter 1131 def document_id(self, document_id): 1132 """Sets the document_id of this TabGroup. 1133 1134 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1135 1136 :param document_id: The document_id of this TabGroup. # noqa: E501 1137 :type: str 1138 """ 1139 1140 self._document_id = document_id 1141 1142 @property 1143 def document_id_metadata(self): 1144 """Gets the document_id_metadata of this TabGroup. # noqa: E501 1145 1146 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1147 1148 :return: The document_id_metadata of this TabGroup. # noqa: E501 1149 :rtype: PropertyMetadata 1150 """ 1151 return self._document_id_metadata 1152 1153 @document_id_metadata.setter 1154 def document_id_metadata(self, document_id_metadata): 1155 """Sets the document_id_metadata of this TabGroup. 1156 1157 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1158 1159 :param document_id_metadata: The document_id_metadata of this TabGroup. # noqa: E501 1160 :type: PropertyMetadata 1161 """ 1162 1163 self._document_id_metadata = document_id_metadata 1164 1165 @property 1166 def error_details(self): 1167 """Gets the error_details of this TabGroup. # noqa: E501 1168 1169 Array or errors. # noqa: E501 1170 1171 :return: The error_details of this TabGroup. # noqa: E501 1172 :rtype: ErrorDetails 1173 """ 1174 return self._error_details 1175 1176 @error_details.setter 1177 def error_details(self, error_details): 1178 """Sets the error_details of this TabGroup. 1179 1180 Array or errors. # noqa: E501 1181 1182 :param error_details: The error_details of this TabGroup. # noqa: E501 1183 :type: ErrorDetails 1184 """ 1185 1186 self._error_details = error_details 1187 1188 @property 1189 def extension_data(self): 1190 """Gets the extension_data of this TabGroup. # noqa: E501 1191 1192 # noqa: E501 1193 1194 :return: The extension_data of this TabGroup. # noqa: E501 1195 :rtype: ExtensionData 1196 """ 1197 return self._extension_data 1198 1199 @extension_data.setter 1200 def extension_data(self, extension_data): 1201 """Sets the extension_data of this TabGroup. 1202 1203 # noqa: E501 1204 1205 :param extension_data: The extension_data of this TabGroup. # noqa: E501 1206 :type: ExtensionData 1207 """ 1208 1209 self._extension_data = extension_data 1210 1211 @property 1212 def form_order(self): 1213 """Gets the form_order of this TabGroup. # noqa: E501 1214 1215 # noqa: E501 1216 1217 :return: The form_order of this TabGroup. # noqa: E501 1218 :rtype: str 1219 """ 1220 return self._form_order 1221 1222 @form_order.setter 1223 def form_order(self, form_order): 1224 """Sets the form_order of this TabGroup. 1225 1226 # noqa: E501 1227 1228 :param form_order: The form_order of this TabGroup. # noqa: E501 1229 :type: str 1230 """ 1231 1232 self._form_order = form_order 1233 1234 @property 1235 def form_order_metadata(self): 1236 """Gets the form_order_metadata of this TabGroup. # noqa: E501 1237 1238 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1239 1240 :return: The form_order_metadata of this TabGroup. # noqa: E501 1241 :rtype: PropertyMetadata 1242 """ 1243 return self._form_order_metadata 1244 1245 @form_order_metadata.setter 1246 def form_order_metadata(self, form_order_metadata): 1247 """Sets the form_order_metadata of this TabGroup. 1248 1249 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1250 1251 :param form_order_metadata: The form_order_metadata of this TabGroup. # noqa: E501 1252 :type: PropertyMetadata 1253 """ 1254 1255 self._form_order_metadata = form_order_metadata 1256 1257 @property 1258 def form_page_label(self): 1259 """Gets the form_page_label of this TabGroup. # noqa: E501 1260 1261 # noqa: E501 1262 1263 :return: The form_page_label of this TabGroup. # noqa: E501 1264 :rtype: str 1265 """ 1266 return self._form_page_label 1267 1268 @form_page_label.setter 1269 def form_page_label(self, form_page_label): 1270 """Sets the form_page_label of this TabGroup. 1271 1272 # noqa: E501 1273 1274 :param form_page_label: The form_page_label of this TabGroup. # noqa: E501 1275 :type: str 1276 """ 1277 1278 self._form_page_label = form_page_label 1279 1280 @property 1281 def form_page_label_metadata(self): 1282 """Gets the form_page_label_metadata of this TabGroup. # noqa: E501 1283 1284 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1285 1286 :return: The form_page_label_metadata of this TabGroup. # noqa: E501 1287 :rtype: PropertyMetadata 1288 """ 1289 return self._form_page_label_metadata 1290 1291 @form_page_label_metadata.setter 1292 def form_page_label_metadata(self, form_page_label_metadata): 1293 """Sets the form_page_label_metadata of this TabGroup. 1294 1295 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1296 1297 :param form_page_label_metadata: The form_page_label_metadata of this TabGroup. # noqa: E501 1298 :type: PropertyMetadata 1299 """ 1300 1301 self._form_page_label_metadata = form_page_label_metadata 1302 1303 @property 1304 def form_page_number(self): 1305 """Gets the form_page_number of this TabGroup. # noqa: E501 1306 1307 # noqa: E501 1308 1309 :return: The form_page_number of this TabGroup. # noqa: E501 1310 :rtype: str 1311 """ 1312 return self._form_page_number 1313 1314 @form_page_number.setter 1315 def form_page_number(self, form_page_number): 1316 """Sets the form_page_number of this TabGroup. 1317 1318 # noqa: E501 1319 1320 :param form_page_number: The form_page_number of this TabGroup. # noqa: E501 1321 :type: str 1322 """ 1323 1324 self._form_page_number = form_page_number 1325 1326 @property 1327 def form_page_number_metadata(self): 1328 """Gets the form_page_number_metadata of this TabGroup. # noqa: E501 1329 1330 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1331 1332 :return: The form_page_number_metadata of this TabGroup. # noqa: E501 1333 :rtype: PropertyMetadata 1334 """ 1335 return self._form_page_number_metadata 1336 1337 @form_page_number_metadata.setter 1338 def form_page_number_metadata(self, form_page_number_metadata): 1339 """Sets the form_page_number_metadata of this TabGroup. 1340 1341 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1342 1343 :param form_page_number_metadata: The form_page_number_metadata of this TabGroup. # noqa: E501 1344 :type: PropertyMetadata 1345 """ 1346 1347 self._form_page_number_metadata = form_page_number_metadata 1348 1349 @property 1350 def group_label(self): 1351 """Gets the group_label of this TabGroup. # noqa: E501 1352 1353 # noqa: E501 1354 1355 :return: The group_label of this TabGroup. # noqa: E501 1356 :rtype: str 1357 """ 1358 return self._group_label 1359 1360 @group_label.setter 1361 def group_label(self, group_label): 1362 """Sets the group_label of this TabGroup. 1363 1364 # noqa: E501 1365 1366 :param group_label: The group_label of this TabGroup. # noqa: E501 1367 :type: str 1368 """ 1369 1370 self._group_label = group_label 1371 1372 @property 1373 def group_label_metadata(self): 1374 """Gets the group_label_metadata of this TabGroup. # noqa: E501 1375 1376 Metadata that indicates whether the `groupLabel` property is editable. # noqa: E501 1377 1378 :return: The group_label_metadata of this TabGroup. # noqa: E501 1379 :rtype: PropertyMetadata 1380 """ 1381 return self._group_label_metadata 1382 1383 @group_label_metadata.setter 1384 def group_label_metadata(self, group_label_metadata): 1385 """Sets the group_label_metadata of this TabGroup. 1386 1387 Metadata that indicates whether the `groupLabel` property is editable. # noqa: E501 1388 1389 :param group_label_metadata: The group_label_metadata of this TabGroup. # noqa: E501 1390 :type: PropertyMetadata 1391 """ 1392 1393 self._group_label_metadata = group_label_metadata 1394 1395 @property 1396 def group_rule(self): 1397 """Gets the group_rule of this TabGroup. # noqa: E501 1398 1399 # noqa: E501 1400 1401 :return: The group_rule of this TabGroup. # noqa: E501 1402 :rtype: str 1403 """ 1404 return self._group_rule 1405 1406 @group_rule.setter 1407 def group_rule(self, group_rule): 1408 """Sets the group_rule of this TabGroup. 1409 1410 # noqa: E501 1411 1412 :param group_rule: The group_rule of this TabGroup. # noqa: E501 1413 :type: str 1414 """ 1415 1416 self._group_rule = group_rule 1417 1418 @property 1419 def group_rule_metadata(self): 1420 """Gets the group_rule_metadata of this TabGroup. # noqa: E501 1421 1422 Metadata that indicates whether the `groupRule` property is editable. # noqa: E501 1423 1424 :return: The group_rule_metadata of this TabGroup. # noqa: E501 1425 :rtype: PropertyMetadata 1426 """ 1427 return self._group_rule_metadata 1428 1429 @group_rule_metadata.setter 1430 def group_rule_metadata(self, group_rule_metadata): 1431 """Sets the group_rule_metadata of this TabGroup. 1432 1433 Metadata that indicates whether the `groupRule` property is editable. # noqa: E501 1434 1435 :param group_rule_metadata: The group_rule_metadata of this TabGroup. # noqa: E501 1436 :type: PropertyMetadata 1437 """ 1438 1439 self._group_rule_metadata = group_rule_metadata 1440 1441 @property 1442 def height(self): 1443 """Gets the height of this TabGroup. # noqa: E501 1444 1445 Height of the tab in pixels. # noqa: E501 1446 1447 :return: The height of this TabGroup. # noqa: E501 1448 :rtype: str 1449 """ 1450 return self._height 1451 1452 @height.setter 1453 def height(self, height): 1454 """Sets the height of this TabGroup. 1455 1456 Height of the tab in pixels. # noqa: E501 1457 1458 :param height: The height of this TabGroup. # noqa: E501 1459 :type: str 1460 """ 1461 1462 self._height = height 1463 1464 @property 1465 def height_metadata(self): 1466 """Gets the height_metadata of this TabGroup. # noqa: E501 1467 1468 Metadata that indicates whether the `height` property is editable. # noqa: E501 1469 1470 :return: The height_metadata of this TabGroup. # noqa: E501 1471 :rtype: PropertyMetadata 1472 """ 1473 return self._height_metadata 1474 1475 @height_metadata.setter 1476 def height_metadata(self, height_metadata): 1477 """Sets the height_metadata of this TabGroup. 1478 1479 Metadata that indicates whether the `height` property is editable. # noqa: E501 1480 1481 :param height_metadata: The height_metadata of this TabGroup. # noqa: E501 1482 :type: PropertyMetadata 1483 """ 1484 1485 self._height_metadata = height_metadata 1486 1487 @property 1488 def maximum_allowed(self): 1489 """Gets the maximum_allowed of this TabGroup. # noqa: E501 1490 1491 # noqa: E501 1492 1493 :return: The maximum_allowed of this TabGroup. # noqa: E501 1494 :rtype: str 1495 """ 1496 return self._maximum_allowed 1497 1498 @maximum_allowed.setter 1499 def maximum_allowed(self, maximum_allowed): 1500 """Sets the maximum_allowed of this TabGroup. 1501 1502 # noqa: E501 1503 1504 :param maximum_allowed: The maximum_allowed of this TabGroup. # noqa: E501 1505 :type: str 1506 """ 1507 1508 self._maximum_allowed = maximum_allowed 1509 1510 @property 1511 def maximum_allowed_metadata(self): 1512 """Gets the maximum_allowed_metadata of this TabGroup. # noqa: E501 1513 1514 Metadata that indicates whether the `maximumAllowed` property is editable. # noqa: E501 1515 1516 :return: The maximum_allowed_metadata of this TabGroup. # noqa: E501 1517 :rtype: PropertyMetadata 1518 """ 1519 return self._maximum_allowed_metadata 1520 1521 @maximum_allowed_metadata.setter 1522 def maximum_allowed_metadata(self, maximum_allowed_metadata): 1523 """Sets the maximum_allowed_metadata of this TabGroup. 1524 1525 Metadata that indicates whether the `maximumAllowed` property is editable. # noqa: E501 1526 1527 :param maximum_allowed_metadata: The maximum_allowed_metadata of this TabGroup. # noqa: E501 1528 :type: PropertyMetadata 1529 """ 1530 1531 self._maximum_allowed_metadata = maximum_allowed_metadata 1532 1533 @property 1534 def merge_field(self): 1535 """Gets the merge_field of this TabGroup. # noqa: E501 1536 1537 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1538 1539 :return: The merge_field of this TabGroup. # noqa: E501 1540 :rtype: MergeField 1541 """ 1542 return self._merge_field 1543 1544 @merge_field.setter 1545 def merge_field(self, merge_field): 1546 """Sets the merge_field of this TabGroup. 1547 1548 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1549 1550 :param merge_field: The merge_field of this TabGroup. # noqa: E501 1551 :type: MergeField 1552 """ 1553 1554 self._merge_field = merge_field 1555 1556 @property 1557 def merge_field_xml(self): 1558 """Gets the merge_field_xml of this TabGroup. # noqa: E501 1559 1560 # noqa: E501 1561 1562 :return: The merge_field_xml of this TabGroup. # noqa: E501 1563 :rtype: str 1564 """ 1565 return self._merge_field_xml 1566 1567 @merge_field_xml.setter 1568 def merge_field_xml(self, merge_field_xml): 1569 """Sets the merge_field_xml of this TabGroup. 1570 1571 # noqa: E501 1572 1573 :param merge_field_xml: The merge_field_xml of this TabGroup. # noqa: E501 1574 :type: str 1575 """ 1576 1577 self._merge_field_xml = merge_field_xml 1578 1579 @property 1580 def minimum_required(self): 1581 """Gets the minimum_required of this TabGroup. # noqa: E501 1582 1583 # noqa: E501 1584 1585 :return: The minimum_required of this TabGroup. # noqa: E501 1586 :rtype: str 1587 """ 1588 return self._minimum_required 1589 1590 @minimum_required.setter 1591 def minimum_required(self, minimum_required): 1592 """Sets the minimum_required of this TabGroup. 1593 1594 # noqa: E501 1595 1596 :param minimum_required: The minimum_required of this TabGroup. # noqa: E501 1597 :type: str 1598 """ 1599 1600 self._minimum_required = minimum_required 1601 1602 @property 1603 def minimum_required_metadata(self): 1604 """Gets the minimum_required_metadata of this TabGroup. # noqa: E501 1605 1606 Metadata that indicates whether the `minimumRequired` property is editable. # noqa: E501 1607 1608 :return: The minimum_required_metadata of this TabGroup. # noqa: E501 1609 :rtype: PropertyMetadata 1610 """ 1611 return self._minimum_required_metadata 1612 1613 @minimum_required_metadata.setter 1614 def minimum_required_metadata(self, minimum_required_metadata): 1615 """Sets the minimum_required_metadata of this TabGroup. 1616 1617 Metadata that indicates whether the `minimumRequired` property is editable. # noqa: E501 1618 1619 :param minimum_required_metadata: The minimum_required_metadata of this TabGroup. # noqa: E501 1620 :type: PropertyMetadata 1621 """ 1622 1623 self._minimum_required_metadata = minimum_required_metadata 1624 1625 @property 1626 def page_number(self): 1627 """Gets the page_number of this TabGroup. # noqa: E501 1628 1629 Specifies the page number on which the tab is located. # noqa: E501 1630 1631 :return: The page_number of this TabGroup. # noqa: E501 1632 :rtype: str 1633 """ 1634 return self._page_number 1635 1636 @page_number.setter 1637 def page_number(self, page_number): 1638 """Sets the page_number of this TabGroup. 1639 1640 Specifies the page number on which the tab is located. # noqa: E501 1641 1642 :param page_number: The page_number of this TabGroup. # noqa: E501 1643 :type: str 1644 """ 1645 1646 self._page_number = page_number 1647 1648 @property 1649 def page_number_metadata(self): 1650 """Gets the page_number_metadata of this TabGroup. # noqa: E501 1651 1652 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1653 1654 :return: The page_number_metadata of this TabGroup. # noqa: E501 1655 :rtype: PropertyMetadata 1656 """ 1657 return self._page_number_metadata 1658 1659 @page_number_metadata.setter 1660 def page_number_metadata(self, page_number_metadata): 1661 """Sets the page_number_metadata of this TabGroup. 1662 1663 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1664 1665 :param page_number_metadata: The page_number_metadata of this TabGroup. # noqa: E501 1666 :type: PropertyMetadata 1667 """ 1668 1669 self._page_number_metadata = page_number_metadata 1670 1671 @property 1672 def recipient_id(self): 1673 """Gets the recipient_id of this TabGroup. # noqa: E501 1674 1675 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1676 1677 :return: The recipient_id of this TabGroup. # noqa: E501 1678 :rtype: str 1679 """ 1680 return self._recipient_id 1681 1682 @recipient_id.setter 1683 def recipient_id(self, recipient_id): 1684 """Sets the recipient_id of this TabGroup. 1685 1686 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1687 1688 :param recipient_id: The recipient_id of this TabGroup. # noqa: E501 1689 :type: str 1690 """ 1691 1692 self._recipient_id = recipient_id 1693 1694 @property 1695 def recipient_id_guid(self): 1696 """Gets the recipient_id_guid of this TabGroup. # noqa: E501 1697 1698 # noqa: E501 1699 1700 :return: The recipient_id_guid of this TabGroup. # noqa: E501 1701 :rtype: str 1702 """ 1703 return self._recipient_id_guid 1704 1705 @recipient_id_guid.setter 1706 def recipient_id_guid(self, recipient_id_guid): 1707 """Sets the recipient_id_guid of this TabGroup. 1708 1709 # noqa: E501 1710 1711 :param recipient_id_guid: The recipient_id_guid of this TabGroup. # noqa: E501 1712 :type: str 1713 """ 1714 1715 self._recipient_id_guid = recipient_id_guid 1716 1717 @property 1718 def recipient_id_guid_metadata(self): 1719 """Gets the recipient_id_guid_metadata of this TabGroup. # noqa: E501 1720 1721 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1722 1723 :return: The recipient_id_guid_metadata of this TabGroup. # noqa: E501 1724 :rtype: PropertyMetadata 1725 """ 1726 return self._recipient_id_guid_metadata 1727 1728 @recipient_id_guid_metadata.setter 1729 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 1730 """Sets the recipient_id_guid_metadata of this TabGroup. 1731 1732 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1733 1734 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this TabGroup. # noqa: E501 1735 :type: PropertyMetadata 1736 """ 1737 1738 self._recipient_id_guid_metadata = recipient_id_guid_metadata 1739 1740 @property 1741 def recipient_id_metadata(self): 1742 """Gets the recipient_id_metadata of this TabGroup. # noqa: E501 1743 1744 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1745 1746 :return: The recipient_id_metadata of this TabGroup. # noqa: E501 1747 :rtype: PropertyMetadata 1748 """ 1749 return self._recipient_id_metadata 1750 1751 @recipient_id_metadata.setter 1752 def recipient_id_metadata(self, recipient_id_metadata): 1753 """Sets the recipient_id_metadata of this TabGroup. 1754 1755 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1756 1757 :param recipient_id_metadata: The recipient_id_metadata of this TabGroup. # noqa: E501 1758 :type: PropertyMetadata 1759 """ 1760 1761 self._recipient_id_metadata = recipient_id_metadata 1762 1763 @property 1764 def smart_contract_information(self): 1765 """Gets the smart_contract_information of this TabGroup. # noqa: E501 1766 1767 Reserved for DocuSign. # noqa: E501 1768 1769 :return: The smart_contract_information of this TabGroup. # noqa: E501 1770 :rtype: SmartContractInformation 1771 """ 1772 return self._smart_contract_information 1773 1774 @smart_contract_information.setter 1775 def smart_contract_information(self, smart_contract_information): 1776 """Sets the smart_contract_information of this TabGroup. 1777 1778 Reserved for DocuSign. # noqa: E501 1779 1780 :param smart_contract_information: The smart_contract_information of this TabGroup. # noqa: E501 1781 :type: SmartContractInformation 1782 """ 1783 1784 self._smart_contract_information = smart_contract_information 1785 1786 @property 1787 def source(self): 1788 """Gets the source of this TabGroup. # noqa: E501 1789 1790 # noqa: E501 1791 1792 :return: The source of this TabGroup. # noqa: E501 1793 :rtype: str 1794 """ 1795 return self._source 1796 1797 @source.setter 1798 def source(self, source): 1799 """Sets the source of this TabGroup. 1800 1801 # noqa: E501 1802 1803 :param source: The source of this TabGroup. # noqa: E501 1804 :type: str 1805 """ 1806 1807 self._source = source 1808 1809 @property 1810 def status(self): 1811 """Gets the status of this TabGroup. # noqa: E501 1812 1813 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 1814 1815 :return: The status of this TabGroup. # noqa: E501 1816 :rtype: str 1817 """ 1818 return self._status 1819 1820 @status.setter 1821 def status(self, status): 1822 """Sets the status of this TabGroup. 1823 1824 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 1825 1826 :param status: The status of this TabGroup. # noqa: E501 1827 :type: str 1828 """ 1829 1830 self._status = status 1831 1832 @property 1833 def status_metadata(self): 1834 """Gets the status_metadata of this TabGroup. # noqa: E501 1835 1836 Metadata that indicates whether the `status` property is editable. # noqa: E501 1837 1838 :return: The status_metadata of this TabGroup. # noqa: E501 1839 :rtype: PropertyMetadata 1840 """ 1841 return self._status_metadata 1842 1843 @status_metadata.setter 1844 def status_metadata(self, status_metadata): 1845 """Sets the status_metadata of this TabGroup. 1846 1847 Metadata that indicates whether the `status` property is editable. # noqa: E501 1848 1849 :param status_metadata: The status_metadata of this TabGroup. # noqa: E501 1850 :type: PropertyMetadata 1851 """ 1852 1853 self._status_metadata = status_metadata 1854 1855 @property 1856 def tab_fully_qualified_path(self): 1857 """Gets the tab_fully_qualified_path of this TabGroup. # noqa: E501 1858 1859 # noqa: E501 1860 1861 :return: The tab_fully_qualified_path of this TabGroup. # noqa: E501 1862 :rtype: str 1863 """ 1864 return self._tab_fully_qualified_path 1865 1866 @tab_fully_qualified_path.setter 1867 def tab_fully_qualified_path(self, tab_fully_qualified_path): 1868 """Sets the tab_fully_qualified_path of this TabGroup. 1869 1870 # noqa: E501 1871 1872 :param tab_fully_qualified_path: The tab_fully_qualified_path of this TabGroup. # noqa: E501 1873 :type: str 1874 """ 1875 1876 self._tab_fully_qualified_path = tab_fully_qualified_path 1877 1878 @property 1879 def tab_group_labels(self): 1880 """Gets the tab_group_labels of this TabGroup. # noqa: E501 1881 1882 # noqa: E501 1883 1884 :return: The tab_group_labels of this TabGroup. # noqa: E501 1885 :rtype: list[str] 1886 """ 1887 return self._tab_group_labels 1888 1889 @tab_group_labels.setter 1890 def tab_group_labels(self, tab_group_labels): 1891 """Sets the tab_group_labels of this TabGroup. 1892 1893 # noqa: E501 1894 1895 :param tab_group_labels: The tab_group_labels of this TabGroup. # noqa: E501 1896 :type: list[str] 1897 """ 1898 1899 self._tab_group_labels = tab_group_labels 1900 1901 @property 1902 def tab_group_labels_metadata(self): 1903 """Gets the tab_group_labels_metadata of this TabGroup. # noqa: E501 1904 1905 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1906 1907 :return: The tab_group_labels_metadata of this TabGroup. # noqa: E501 1908 :rtype: PropertyMetadata 1909 """ 1910 return self._tab_group_labels_metadata 1911 1912 @tab_group_labels_metadata.setter 1913 def tab_group_labels_metadata(self, tab_group_labels_metadata): 1914 """Sets the tab_group_labels_metadata of this TabGroup. 1915 1916 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1917 1918 :param tab_group_labels_metadata: The tab_group_labels_metadata of this TabGroup. # noqa: E501 1919 :type: PropertyMetadata 1920 """ 1921 1922 self._tab_group_labels_metadata = tab_group_labels_metadata 1923 1924 @property 1925 def tab_id(self): 1926 """Gets the tab_id of this TabGroup. # noqa: E501 1927 1928 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1929 1930 :return: The tab_id of this TabGroup. # noqa: E501 1931 :rtype: str 1932 """ 1933 return self._tab_id 1934 1935 @tab_id.setter 1936 def tab_id(self, tab_id): 1937 """Sets the tab_id of this TabGroup. 1938 1939 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1940 1941 :param tab_id: The tab_id of this TabGroup. # noqa: E501 1942 :type: str 1943 """ 1944 1945 self._tab_id = tab_id 1946 1947 @property 1948 def tab_id_metadata(self): 1949 """Gets the tab_id_metadata of this TabGroup. # noqa: E501 1950 1951 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1952 1953 :return: The tab_id_metadata of this TabGroup. # noqa: E501 1954 :rtype: PropertyMetadata 1955 """ 1956 return self._tab_id_metadata 1957 1958 @tab_id_metadata.setter 1959 def tab_id_metadata(self, tab_id_metadata): 1960 """Sets the tab_id_metadata of this TabGroup. 1961 1962 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1963 1964 :param tab_id_metadata: The tab_id_metadata of this TabGroup. # noqa: E501 1965 :type: PropertyMetadata 1966 """ 1967 1968 self._tab_id_metadata = tab_id_metadata 1969 1970 @property 1971 def tab_order(self): 1972 """Gets the tab_order of this TabGroup. # noqa: E501 1973 1974 # noqa: E501 1975 1976 :return: The tab_order of this TabGroup. # noqa: E501 1977 :rtype: str 1978 """ 1979 return self._tab_order 1980 1981 @tab_order.setter 1982 def tab_order(self, tab_order): 1983 """Sets the tab_order of this TabGroup. 1984 1985 # noqa: E501 1986 1987 :param tab_order: The tab_order of this TabGroup. # noqa: E501 1988 :type: str 1989 """ 1990 1991 self._tab_order = tab_order 1992 1993 @property 1994 def tab_order_metadata(self): 1995 """Gets the tab_order_metadata of this TabGroup. # noqa: E501 1996 1997 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 1998 1999 :return: The tab_order_metadata of this TabGroup. # noqa: E501 2000 :rtype: PropertyMetadata 2001 """ 2002 return self._tab_order_metadata 2003 2004 @tab_order_metadata.setter 2005 def tab_order_metadata(self, tab_order_metadata): 2006 """Sets the tab_order_metadata of this TabGroup. 2007 2008 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 2009 2010 :param tab_order_metadata: The tab_order_metadata of this TabGroup. # noqa: E501 2011 :type: PropertyMetadata 2012 """ 2013 2014 self._tab_order_metadata = tab_order_metadata 2015 2016 @property 2017 def tab_scope(self): 2018 """Gets the tab_scope of this TabGroup. # noqa: E501 2019 2020 # noqa: E501 2021 2022 :return: The tab_scope of this TabGroup. # noqa: E501 2023 :rtype: str 2024 """ 2025 return self._tab_scope 2026 2027 @tab_scope.setter 2028 def tab_scope(self, tab_scope): 2029 """Sets the tab_scope of this TabGroup. 2030 2031 # noqa: E501 2032 2033 :param tab_scope: The tab_scope of this TabGroup. # noqa: E501 2034 :type: str 2035 """ 2036 2037 self._tab_scope = tab_scope 2038 2039 @property 2040 def tab_scope_metadata(self): 2041 """Gets the tab_scope_metadata of this TabGroup. # noqa: E501 2042 2043 Metadata that indicates whether the `tabScope` property is editable. # noqa: E501 2044 2045 :return: The tab_scope_metadata of this TabGroup. # noqa: E501 2046 :rtype: PropertyMetadata 2047 """ 2048 return self._tab_scope_metadata 2049 2050 @tab_scope_metadata.setter 2051 def tab_scope_metadata(self, tab_scope_metadata): 2052 """Sets the tab_scope_metadata of this TabGroup. 2053 2054 Metadata that indicates whether the `tabScope` property is editable. # noqa: E501 2055 2056 :param tab_scope_metadata: The tab_scope_metadata of this TabGroup. # noqa: E501 2057 :type: PropertyMetadata 2058 """ 2059 2060 self._tab_scope_metadata = tab_scope_metadata 2061 2062 @property 2063 def tab_type(self): 2064 """Gets the tab_type of this TabGroup. # noqa: E501 2065 2066 # noqa: E501 2067 2068 :return: The tab_type of this TabGroup. # noqa: E501 2069 :rtype: str 2070 """ 2071 return self._tab_type 2072 2073 @tab_type.setter 2074 def tab_type(self, tab_type): 2075 """Sets the tab_type of this TabGroup. 2076 2077 # noqa: E501 2078 2079 :param tab_type: The tab_type of this TabGroup. # noqa: E501 2080 :type: str 2081 """ 2082 2083 self._tab_type = tab_type 2084 2085 @property 2086 def tab_type_metadata(self): 2087 """Gets the tab_type_metadata of this TabGroup. # noqa: E501 2088 2089 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2090 2091 :return: The tab_type_metadata of this TabGroup. # noqa: E501 2092 :rtype: PropertyMetadata 2093 """ 2094 return self._tab_type_metadata 2095 2096 @tab_type_metadata.setter 2097 def tab_type_metadata(self, tab_type_metadata): 2098 """Sets the tab_type_metadata of this TabGroup. 2099 2100 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2101 2102 :param tab_type_metadata: The tab_type_metadata of this TabGroup. # noqa: E501 2103 :type: PropertyMetadata 2104 """ 2105 2106 self._tab_type_metadata = tab_type_metadata 2107 2108 @property 2109 def template_locked(self): 2110 """Gets the template_locked of this TabGroup. # noqa: E501 2111 2112 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2113 2114 :return: The template_locked of this TabGroup. # noqa: E501 2115 :rtype: str 2116 """ 2117 return self._template_locked 2118 2119 @template_locked.setter 2120 def template_locked(self, template_locked): 2121 """Sets the template_locked of this TabGroup. 2122 2123 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2124 2125 :param template_locked: The template_locked of this TabGroup. # noqa: E501 2126 :type: str 2127 """ 2128 2129 self._template_locked = template_locked 2130 2131 @property 2132 def template_locked_metadata(self): 2133 """Gets the template_locked_metadata of this TabGroup. # noqa: E501 2134 2135 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2136 2137 :return: The template_locked_metadata of this TabGroup. # noqa: E501 2138 :rtype: PropertyMetadata 2139 """ 2140 return self._template_locked_metadata 2141 2142 @template_locked_metadata.setter 2143 def template_locked_metadata(self, template_locked_metadata): 2144 """Sets the template_locked_metadata of this TabGroup. 2145 2146 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2147 2148 :param template_locked_metadata: The template_locked_metadata of this TabGroup. # noqa: E501 2149 :type: PropertyMetadata 2150 """ 2151 2152 self._template_locked_metadata = template_locked_metadata 2153 2154 @property 2155 def template_required(self): 2156 """Gets the template_required of this TabGroup. # noqa: E501 2157 2158 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2159 2160 :return: The template_required of this TabGroup. # noqa: E501 2161 :rtype: str 2162 """ 2163 return self._template_required 2164 2165 @template_required.setter 2166 def template_required(self, template_required): 2167 """Sets the template_required of this TabGroup. 2168 2169 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2170 2171 :param template_required: The template_required of this TabGroup. # noqa: E501 2172 :type: str 2173 """ 2174 2175 self._template_required = template_required 2176 2177 @property 2178 def template_required_metadata(self): 2179 """Gets the template_required_metadata of this TabGroup. # noqa: E501 2180 2181 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2182 2183 :return: The template_required_metadata of this TabGroup. # noqa: E501 2184 :rtype: PropertyMetadata 2185 """ 2186 return self._template_required_metadata 2187 2188 @template_required_metadata.setter 2189 def template_required_metadata(self, template_required_metadata): 2190 """Sets the template_required_metadata of this TabGroup. 2191 2192 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2193 2194 :param template_required_metadata: The template_required_metadata of this TabGroup. # noqa: E501 2195 :type: PropertyMetadata 2196 """ 2197 2198 self._template_required_metadata = template_required_metadata 2199 2200 @property 2201 def tooltip(self): 2202 """Gets the tooltip of this TabGroup. # noqa: E501 2203 2204 # noqa: E501 2205 2206 :return: The tooltip of this TabGroup. # noqa: E501 2207 :rtype: str 2208 """ 2209 return self._tooltip 2210 2211 @tooltip.setter 2212 def tooltip(self, tooltip): 2213 """Sets the tooltip of this TabGroup. 2214 2215 # noqa: E501 2216 2217 :param tooltip: The tooltip of this TabGroup. # noqa: E501 2218 :type: str 2219 """ 2220 2221 self._tooltip = tooltip 2222 2223 @property 2224 def tool_tip_metadata(self): 2225 """Gets the tool_tip_metadata of this TabGroup. # noqa: E501 2226 2227 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2228 2229 :return: The tool_tip_metadata of this TabGroup. # noqa: E501 2230 :rtype: PropertyMetadata 2231 """ 2232 return self._tool_tip_metadata 2233 2234 @tool_tip_metadata.setter 2235 def tool_tip_metadata(self, tool_tip_metadata): 2236 """Sets the tool_tip_metadata of this TabGroup. 2237 2238 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2239 2240 :param tool_tip_metadata: The tool_tip_metadata of this TabGroup. # noqa: E501 2241 :type: PropertyMetadata 2242 """ 2243 2244 self._tool_tip_metadata = tool_tip_metadata 2245 2246 @property 2247 def validation_message(self): 2248 """Gets the validation_message of this TabGroup. # noqa: E501 2249 2250 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 2251 2252 :return: The validation_message of this TabGroup. # noqa: E501 2253 :rtype: str 2254 """ 2255 return self._validation_message 2256 2257 @validation_message.setter 2258 def validation_message(self, validation_message): 2259 """Sets the validation_message of this TabGroup. 2260 2261 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 2262 2263 :param validation_message: The validation_message of this TabGroup. # noqa: E501 2264 :type: str 2265 """ 2266 2267 self._validation_message = validation_message 2268 2269 @property 2270 def validation_message_metadata(self): 2271 """Gets the validation_message_metadata of this TabGroup. # noqa: E501 2272 2273 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 2274 2275 :return: The validation_message_metadata of this TabGroup. # noqa: E501 2276 :rtype: PropertyMetadata 2277 """ 2278 return self._validation_message_metadata 2279 2280 @validation_message_metadata.setter 2281 def validation_message_metadata(self, validation_message_metadata): 2282 """Sets the validation_message_metadata of this TabGroup. 2283 2284 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 2285 2286 :param validation_message_metadata: The validation_message_metadata of this TabGroup. # noqa: E501 2287 :type: PropertyMetadata 2288 """ 2289 2290 self._validation_message_metadata = validation_message_metadata 2291 2292 @property 2293 def warning_details(self): 2294 """Gets the warning_details of this TabGroup. # noqa: E501 2295 2296 # noqa: E501 2297 2298 :return: The warning_details of this TabGroup. # noqa: E501 2299 :rtype: ErrorDetails 2300 """ 2301 return self._warning_details 2302 2303 @warning_details.setter 2304 def warning_details(self, warning_details): 2305 """Sets the warning_details of this TabGroup. 2306 2307 # noqa: E501 2308 2309 :param warning_details: The warning_details of this TabGroup. # noqa: E501 2310 :type: ErrorDetails 2311 """ 2312 2313 self._warning_details = warning_details 2314 2315 @property 2316 def width(self): 2317 """Gets the width of this TabGroup. # noqa: E501 2318 2319 Width of the tab in pixels. # noqa: E501 2320 2321 :return: The width of this TabGroup. # noqa: E501 2322 :rtype: str 2323 """ 2324 return self._width 2325 2326 @width.setter 2327 def width(self, width): 2328 """Sets the width of this TabGroup. 2329 2330 Width of the tab in pixels. # noqa: E501 2331 2332 :param width: The width of this TabGroup. # noqa: E501 2333 :type: str 2334 """ 2335 2336 self._width = width 2337 2338 @property 2339 def width_metadata(self): 2340 """Gets the width_metadata of this TabGroup. # noqa: E501 2341 2342 Metadata that indicates whether the `width` property is editable. # noqa: E501 2343 2344 :return: The width_metadata of this TabGroup. # noqa: E501 2345 :rtype: PropertyMetadata 2346 """ 2347 return self._width_metadata 2348 2349 @width_metadata.setter 2350 def width_metadata(self, width_metadata): 2351 """Sets the width_metadata of this TabGroup. 2352 2353 Metadata that indicates whether the `width` property is editable. # noqa: E501 2354 2355 :param width_metadata: The width_metadata of this TabGroup. # noqa: E501 2356 :type: PropertyMetadata 2357 """ 2358 2359 self._width_metadata = width_metadata 2360 2361 @property 2362 def x_position(self): 2363 """Gets the x_position of this TabGroup. # noqa: E501 2364 2365 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2366 2367 :return: The x_position of this TabGroup. # noqa: E501 2368 :rtype: str 2369 """ 2370 return self._x_position 2371 2372 @x_position.setter 2373 def x_position(self, x_position): 2374 """Sets the x_position of this TabGroup. 2375 2376 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2377 2378 :param x_position: The x_position of this TabGroup. # noqa: E501 2379 :type: str 2380 """ 2381 2382 self._x_position = x_position 2383 2384 @property 2385 def x_position_metadata(self): 2386 """Gets the x_position_metadata of this TabGroup. # noqa: E501 2387 2388 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2389 2390 :return: The x_position_metadata of this TabGroup. # noqa: E501 2391 :rtype: PropertyMetadata 2392 """ 2393 return self._x_position_metadata 2394 2395 @x_position_metadata.setter 2396 def x_position_metadata(self, x_position_metadata): 2397 """Sets the x_position_metadata of this TabGroup. 2398 2399 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2400 2401 :param x_position_metadata: The x_position_metadata of this TabGroup. # noqa: E501 2402 :type: PropertyMetadata 2403 """ 2404 2405 self._x_position_metadata = x_position_metadata 2406 2407 @property 2408 def y_position(self): 2409 """Gets the y_position of this TabGroup. # noqa: E501 2410 2411 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2412 2413 :return: The y_position of this TabGroup. # noqa: E501 2414 :rtype: str 2415 """ 2416 return self._y_position 2417 2418 @y_position.setter 2419 def y_position(self, y_position): 2420 """Sets the y_position of this TabGroup. 2421 2422 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2423 2424 :param y_position: The y_position of this TabGroup. # noqa: E501 2425 :type: str 2426 """ 2427 2428 self._y_position = y_position 2429 2430 @property 2431 def y_position_metadata(self): 2432 """Gets the y_position_metadata of this TabGroup. # noqa: E501 2433 2434 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2435 2436 :return: The y_position_metadata of this TabGroup. # noqa: E501 2437 :rtype: PropertyMetadata 2438 """ 2439 return self._y_position_metadata 2440 2441 @y_position_metadata.setter 2442 def y_position_metadata(self, y_position_metadata): 2443 """Sets the y_position_metadata of this TabGroup. 2444 2445 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2446 2447 :param y_position_metadata: The y_position_metadata of this TabGroup. # noqa: E501 2448 :type: PropertyMetadata 2449 """ 2450 2451 self._y_position_metadata = y_position_metadata 2452 2453 def to_dict(self): 2454 """Returns the model properties as a dict""" 2455 result = {} 2456 2457 for attr, _ in six.iteritems(self.swagger_types): 2458 value = getattr(self, attr) 2459 if isinstance(value, list): 2460 result[attr] = list(map( 2461 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2462 value 2463 )) 2464 elif hasattr(value, "to_dict"): 2465 result[attr] = value.to_dict() 2466 elif isinstance(value, dict): 2467 result[attr] = dict(map( 2468 lambda item: (item[0], item[1].to_dict()) 2469 if hasattr(item[1], "to_dict") else item, 2470 value.items() 2471 )) 2472 else: 2473 result[attr] = value 2474 if issubclass(TabGroup, dict): 2475 for key, value in self.items(): 2476 result[key] = value 2477 2478 return result 2479 2480 def to_str(self): 2481 """Returns the string representation of the model""" 2482 return pprint.pformat(self.to_dict()) 2483 2484 def __repr__(self): 2485 """For `print` and `pprint`""" 2486 return self.to_str() 2487 2488 def __eq__(self, other): 2489 """Returns true if both objects are equal""" 2490 if not isinstance(other, TabGroup): 2491 return False 2492 2493 return self.to_dict() == other.to_dict() 2494 2495 def __ne__(self, other): 2496 """Returns true if both objects are not equal""" 2497 if not isinstance(other, TabGroup): 2498 return True 2499 2500 return self.to_dict() != other.to_dict()
class
TabGroup:
23class TabGroup(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'agreement_attribute': 'str', 38 'agreement_attribute_locked': 'str', 39 'anchor_allow_white_space_in_characters': 'str', 40 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 41 'anchor_case_sensitive': 'str', 42 'anchor_case_sensitive_metadata': 'PropertyMetadata', 43 'anchor_horizontal_alignment': 'str', 44 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 45 'anchor_ignore_if_not_present': 'str', 46 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 47 'anchor_match_whole_word': 'str', 48 'anchor_match_whole_word_metadata': 'PropertyMetadata', 49 'anchor_string': 'str', 50 'anchor_string_metadata': 'PropertyMetadata', 51 'anchor_tab_processor_version': 'str', 52 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 53 'anchor_units': 'str', 54 'anchor_units_metadata': 'PropertyMetadata', 55 'anchor_x_offset': 'str', 56 'anchor_x_offset_metadata': 'PropertyMetadata', 57 'anchor_y_offset': 'str', 58 'anchor_y_offset_metadata': 'PropertyMetadata', 59 'caption': 'str', 60 'caption_metadata': 'PropertyMetadata', 61 'conditional_parent_label': 'str', 62 'conditional_parent_label_metadata': 'PropertyMetadata', 63 'conditional_parent_value': 'str', 64 'conditional_parent_value_metadata': 'PropertyMetadata', 65 'connected_object_details': 'ConnectedObjectDetails', 66 'custom_tab_id': 'str', 67 'custom_tab_id_metadata': 'PropertyMetadata', 68 'document_id': 'str', 69 'document_id_metadata': 'PropertyMetadata', 70 'error_details': 'ErrorDetails', 71 'extension_data': 'ExtensionData', 72 'form_order': 'str', 73 'form_order_metadata': 'PropertyMetadata', 74 'form_page_label': 'str', 75 'form_page_label_metadata': 'PropertyMetadata', 76 'form_page_number': 'str', 77 'form_page_number_metadata': 'PropertyMetadata', 78 'group_label': 'str', 79 'group_label_metadata': 'PropertyMetadata', 80 'group_rule': 'str', 81 'group_rule_metadata': 'PropertyMetadata', 82 'height': 'str', 83 'height_metadata': 'PropertyMetadata', 84 'maximum_allowed': 'str', 85 'maximum_allowed_metadata': 'PropertyMetadata', 86 'merge_field': 'MergeField', 87 'merge_field_xml': 'str', 88 'minimum_required': 'str', 89 'minimum_required_metadata': 'PropertyMetadata', 90 'page_number': 'str', 91 'page_number_metadata': 'PropertyMetadata', 92 'recipient_id': 'str', 93 'recipient_id_guid': 'str', 94 'recipient_id_guid_metadata': 'PropertyMetadata', 95 'recipient_id_metadata': 'PropertyMetadata', 96 'smart_contract_information': 'SmartContractInformation', 97 'source': 'str', 98 'status': 'str', 99 'status_metadata': 'PropertyMetadata', 100 'tab_fully_qualified_path': 'str', 101 'tab_group_labels': 'list[str]', 102 'tab_group_labels_metadata': 'PropertyMetadata', 103 'tab_id': 'str', 104 'tab_id_metadata': 'PropertyMetadata', 105 'tab_order': 'str', 106 'tab_order_metadata': 'PropertyMetadata', 107 'tab_scope': 'str', 108 'tab_scope_metadata': 'PropertyMetadata', 109 'tab_type': 'str', 110 'tab_type_metadata': 'PropertyMetadata', 111 'template_locked': 'str', 112 'template_locked_metadata': 'PropertyMetadata', 113 'template_required': 'str', 114 'template_required_metadata': 'PropertyMetadata', 115 'tooltip': 'str', 116 'tool_tip_metadata': 'PropertyMetadata', 117 'validation_message': 'str', 118 'validation_message_metadata': 'PropertyMetadata', 119 'warning_details': 'ErrorDetails', 120 'width': 'str', 121 'width_metadata': 'PropertyMetadata', 122 'x_position': 'str', 123 'x_position_metadata': 'PropertyMetadata', 124 'y_position': 'str', 125 'y_position_metadata': 'PropertyMetadata' 126 } 127 128 attribute_map = { 129 'agreement_attribute': 'agreementAttribute', 130 'agreement_attribute_locked': 'agreementAttributeLocked', 131 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 132 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 133 'anchor_case_sensitive': 'anchorCaseSensitive', 134 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 135 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 136 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 137 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 138 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 139 'anchor_match_whole_word': 'anchorMatchWholeWord', 140 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 141 'anchor_string': 'anchorString', 142 'anchor_string_metadata': 'anchorStringMetadata', 143 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 144 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 145 'anchor_units': 'anchorUnits', 146 'anchor_units_metadata': 'anchorUnitsMetadata', 147 'anchor_x_offset': 'anchorXOffset', 148 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 149 'anchor_y_offset': 'anchorYOffset', 150 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 151 'caption': 'caption', 152 'caption_metadata': 'captionMetadata', 153 'conditional_parent_label': 'conditionalParentLabel', 154 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 155 'conditional_parent_value': 'conditionalParentValue', 156 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 157 'connected_object_details': 'connectedObjectDetails', 158 'custom_tab_id': 'customTabId', 159 'custom_tab_id_metadata': 'customTabIdMetadata', 160 'document_id': 'documentId', 161 'document_id_metadata': 'documentIdMetadata', 162 'error_details': 'errorDetails', 163 'extension_data': 'extensionData', 164 'form_order': 'formOrder', 165 'form_order_metadata': 'formOrderMetadata', 166 'form_page_label': 'formPageLabel', 167 'form_page_label_metadata': 'formPageLabelMetadata', 168 'form_page_number': 'formPageNumber', 169 'form_page_number_metadata': 'formPageNumberMetadata', 170 'group_label': 'groupLabel', 171 'group_label_metadata': 'groupLabelMetadata', 172 'group_rule': 'groupRule', 173 'group_rule_metadata': 'groupRuleMetadata', 174 'height': 'height', 175 'height_metadata': 'heightMetadata', 176 'maximum_allowed': 'maximumAllowed', 177 'maximum_allowed_metadata': 'maximumAllowedMetadata', 178 'merge_field': 'mergeField', 179 'merge_field_xml': 'mergeFieldXml', 180 'minimum_required': 'minimumRequired', 181 'minimum_required_metadata': 'minimumRequiredMetadata', 182 'page_number': 'pageNumber', 183 'page_number_metadata': 'pageNumberMetadata', 184 'recipient_id': 'recipientId', 185 'recipient_id_guid': 'recipientIdGuid', 186 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 187 'recipient_id_metadata': 'recipientIdMetadata', 188 'smart_contract_information': 'smartContractInformation', 189 'source': 'source', 190 'status': 'status', 191 'status_metadata': 'statusMetadata', 192 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 193 'tab_group_labels': 'tabGroupLabels', 194 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 195 'tab_id': 'tabId', 196 'tab_id_metadata': 'tabIdMetadata', 197 'tab_order': 'tabOrder', 198 'tab_order_metadata': 'tabOrderMetadata', 199 'tab_scope': 'tabScope', 200 'tab_scope_metadata': 'tabScopeMetadata', 201 'tab_type': 'tabType', 202 'tab_type_metadata': 'tabTypeMetadata', 203 'template_locked': 'templateLocked', 204 'template_locked_metadata': 'templateLockedMetadata', 205 'template_required': 'templateRequired', 206 'template_required_metadata': 'templateRequiredMetadata', 207 'tooltip': 'tooltip', 208 'tool_tip_metadata': 'toolTipMetadata', 209 'validation_message': 'validationMessage', 210 'validation_message_metadata': 'validationMessageMetadata', 211 'warning_details': 'warningDetails', 212 'width': 'width', 213 'width_metadata': 'widthMetadata', 214 'x_position': 'xPosition', 215 'x_position_metadata': 'xPositionMetadata', 216 'y_position': 'yPosition', 217 'y_position_metadata': 'yPositionMetadata' 218 } 219 220 def __init__(self, _configuration=None, **kwargs): # noqa: E501 221 """TabGroup - a model defined in Swagger""" # noqa: E501 222 if _configuration is None: 223 _configuration = Configuration() 224 self._configuration = _configuration 225 226 self._agreement_attribute = None 227 self._agreement_attribute_locked = None 228 self._anchor_allow_white_space_in_characters = None 229 self._anchor_allow_white_space_in_characters_metadata = None 230 self._anchor_case_sensitive = None 231 self._anchor_case_sensitive_metadata = None 232 self._anchor_horizontal_alignment = None 233 self._anchor_horizontal_alignment_metadata = None 234 self._anchor_ignore_if_not_present = None 235 self._anchor_ignore_if_not_present_metadata = None 236 self._anchor_match_whole_word = None 237 self._anchor_match_whole_word_metadata = None 238 self._anchor_string = None 239 self._anchor_string_metadata = None 240 self._anchor_tab_processor_version = None 241 self._anchor_tab_processor_version_metadata = None 242 self._anchor_units = None 243 self._anchor_units_metadata = None 244 self._anchor_x_offset = None 245 self._anchor_x_offset_metadata = None 246 self._anchor_y_offset = None 247 self._anchor_y_offset_metadata = None 248 self._caption = None 249 self._caption_metadata = None 250 self._conditional_parent_label = None 251 self._conditional_parent_label_metadata = None 252 self._conditional_parent_value = None 253 self._conditional_parent_value_metadata = None 254 self._connected_object_details = None 255 self._custom_tab_id = None 256 self._custom_tab_id_metadata = None 257 self._document_id = None 258 self._document_id_metadata = None 259 self._error_details = None 260 self._extension_data = None 261 self._form_order = None 262 self._form_order_metadata = None 263 self._form_page_label = None 264 self._form_page_label_metadata = None 265 self._form_page_number = None 266 self._form_page_number_metadata = None 267 self._group_label = None 268 self._group_label_metadata = None 269 self._group_rule = None 270 self._group_rule_metadata = None 271 self._height = None 272 self._height_metadata = None 273 self._maximum_allowed = None 274 self._maximum_allowed_metadata = None 275 self._merge_field = None 276 self._merge_field_xml = None 277 self._minimum_required = None 278 self._minimum_required_metadata = None 279 self._page_number = None 280 self._page_number_metadata = None 281 self._recipient_id = None 282 self._recipient_id_guid = None 283 self._recipient_id_guid_metadata = None 284 self._recipient_id_metadata = None 285 self._smart_contract_information = None 286 self._source = None 287 self._status = None 288 self._status_metadata = None 289 self._tab_fully_qualified_path = None 290 self._tab_group_labels = None 291 self._tab_group_labels_metadata = None 292 self._tab_id = None 293 self._tab_id_metadata = None 294 self._tab_order = None 295 self._tab_order_metadata = None 296 self._tab_scope = None 297 self._tab_scope_metadata = None 298 self._tab_type = None 299 self._tab_type_metadata = None 300 self._template_locked = None 301 self._template_locked_metadata = None 302 self._template_required = None 303 self._template_required_metadata = None 304 self._tooltip = None 305 self._tool_tip_metadata = None 306 self._validation_message = None 307 self._validation_message_metadata = None 308 self._warning_details = None 309 self._width = None 310 self._width_metadata = None 311 self._x_position = None 312 self._x_position_metadata = None 313 self._y_position = None 314 self._y_position_metadata = None 315 self.discriminator = None 316 317 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 318 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 319 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 320 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 321 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 322 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 323 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 324 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 325 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 326 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 327 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 328 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 329 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 330 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 331 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 332 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 333 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 334 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 335 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 336 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 337 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 338 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 339 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 340 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 341 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 342 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 343 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 344 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 345 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 346 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 347 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 348 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 349 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 350 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 351 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 352 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 353 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 354 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 355 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 356 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 357 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 358 setattr(self, "_{}".format('group_label'), kwargs.get('group_label', None)) 359 setattr(self, "_{}".format('group_label_metadata'), kwargs.get('group_label_metadata', None)) 360 setattr(self, "_{}".format('group_rule'), kwargs.get('group_rule', None)) 361 setattr(self, "_{}".format('group_rule_metadata'), kwargs.get('group_rule_metadata', None)) 362 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 363 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 364 setattr(self, "_{}".format('maximum_allowed'), kwargs.get('maximum_allowed', None)) 365 setattr(self, "_{}".format('maximum_allowed_metadata'), kwargs.get('maximum_allowed_metadata', None)) 366 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 367 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 368 setattr(self, "_{}".format('minimum_required'), kwargs.get('minimum_required', None)) 369 setattr(self, "_{}".format('minimum_required_metadata'), kwargs.get('minimum_required_metadata', None)) 370 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 371 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 372 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 373 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 374 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 375 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 376 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 377 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 378 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 379 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 380 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 381 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 382 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 383 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 384 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 385 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 386 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 387 setattr(self, "_{}".format('tab_scope'), kwargs.get('tab_scope', None)) 388 setattr(self, "_{}".format('tab_scope_metadata'), kwargs.get('tab_scope_metadata', None)) 389 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 390 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 391 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 392 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 393 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 394 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 395 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 396 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 397 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 398 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 399 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 400 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 401 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 402 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 403 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 404 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 405 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 406 407 @property 408 def agreement_attribute(self): 409 """Gets the agreement_attribute of this TabGroup. # noqa: E501 410 411 # noqa: E501 412 413 :return: The agreement_attribute of this TabGroup. # noqa: E501 414 :rtype: str 415 """ 416 return self._agreement_attribute 417 418 @agreement_attribute.setter 419 def agreement_attribute(self, agreement_attribute): 420 """Sets the agreement_attribute of this TabGroup. 421 422 # noqa: E501 423 424 :param agreement_attribute: The agreement_attribute of this TabGroup. # noqa: E501 425 :type: str 426 """ 427 428 self._agreement_attribute = agreement_attribute 429 430 @property 431 def agreement_attribute_locked(self): 432 """Gets the agreement_attribute_locked of this TabGroup. # noqa: E501 433 434 # noqa: E501 435 436 :return: The agreement_attribute_locked of this TabGroup. # noqa: E501 437 :rtype: str 438 """ 439 return self._agreement_attribute_locked 440 441 @agreement_attribute_locked.setter 442 def agreement_attribute_locked(self, agreement_attribute_locked): 443 """Sets the agreement_attribute_locked of this TabGroup. 444 445 # noqa: E501 446 447 :param agreement_attribute_locked: The agreement_attribute_locked of this TabGroup. # noqa: E501 448 :type: str 449 """ 450 451 self._agreement_attribute_locked = agreement_attribute_locked 452 453 @property 454 def anchor_allow_white_space_in_characters(self): 455 """Gets the anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501 456 457 # noqa: E501 458 459 :return: The anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501 460 :rtype: str 461 """ 462 return self._anchor_allow_white_space_in_characters 463 464 @anchor_allow_white_space_in_characters.setter 465 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 466 """Sets the anchor_allow_white_space_in_characters of this TabGroup. 467 468 # noqa: E501 469 470 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501 471 :type: str 472 """ 473 474 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 475 476 @property 477 def anchor_allow_white_space_in_characters_metadata(self): 478 """Gets the anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501 479 480 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 481 482 :return: The anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501 483 :rtype: PropertyMetadata 484 """ 485 return self._anchor_allow_white_space_in_characters_metadata 486 487 @anchor_allow_white_space_in_characters_metadata.setter 488 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 489 """Sets the anchor_allow_white_space_in_characters_metadata of this TabGroup. 490 491 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 492 493 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501 494 :type: PropertyMetadata 495 """ 496 497 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 498 499 @property 500 def anchor_case_sensitive(self): 501 """Gets the anchor_case_sensitive of this TabGroup. # noqa: E501 502 503 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 504 505 :return: The anchor_case_sensitive of this TabGroup. # noqa: E501 506 :rtype: str 507 """ 508 return self._anchor_case_sensitive 509 510 @anchor_case_sensitive.setter 511 def anchor_case_sensitive(self, anchor_case_sensitive): 512 """Sets the anchor_case_sensitive of this TabGroup. 513 514 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 515 516 :param anchor_case_sensitive: The anchor_case_sensitive of this TabGroup. # noqa: E501 517 :type: str 518 """ 519 520 self._anchor_case_sensitive = anchor_case_sensitive 521 522 @property 523 def anchor_case_sensitive_metadata(self): 524 """Gets the anchor_case_sensitive_metadata of this TabGroup. # noqa: E501 525 526 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 527 528 :return: The anchor_case_sensitive_metadata of this TabGroup. # noqa: E501 529 :rtype: PropertyMetadata 530 """ 531 return self._anchor_case_sensitive_metadata 532 533 @anchor_case_sensitive_metadata.setter 534 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 535 """Sets the anchor_case_sensitive_metadata of this TabGroup. 536 537 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 538 539 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this TabGroup. # noqa: E501 540 :type: PropertyMetadata 541 """ 542 543 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 544 545 @property 546 def anchor_horizontal_alignment(self): 547 """Gets the anchor_horizontal_alignment of this TabGroup. # noqa: E501 548 549 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 550 551 :return: The anchor_horizontal_alignment of this TabGroup. # noqa: E501 552 :rtype: str 553 """ 554 return self._anchor_horizontal_alignment 555 556 @anchor_horizontal_alignment.setter 557 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 558 """Sets the anchor_horizontal_alignment of this TabGroup. 559 560 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 561 562 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this TabGroup. # noqa: E501 563 :type: str 564 """ 565 566 self._anchor_horizontal_alignment = anchor_horizontal_alignment 567 568 @property 569 def anchor_horizontal_alignment_metadata(self): 570 """Gets the anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501 571 572 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 573 574 :return: The anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501 575 :rtype: PropertyMetadata 576 """ 577 return self._anchor_horizontal_alignment_metadata 578 579 @anchor_horizontal_alignment_metadata.setter 580 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 581 """Sets the anchor_horizontal_alignment_metadata of this TabGroup. 582 583 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 584 585 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501 586 :type: PropertyMetadata 587 """ 588 589 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 590 591 @property 592 def anchor_ignore_if_not_present(self): 593 """Gets the anchor_ignore_if_not_present of this TabGroup. # noqa: E501 594 595 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 596 597 :return: The anchor_ignore_if_not_present of this TabGroup. # noqa: E501 598 :rtype: str 599 """ 600 return self._anchor_ignore_if_not_present 601 602 @anchor_ignore_if_not_present.setter 603 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 604 """Sets the anchor_ignore_if_not_present of this TabGroup. 605 606 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 607 608 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this TabGroup. # noqa: E501 609 :type: str 610 """ 611 612 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 613 614 @property 615 def anchor_ignore_if_not_present_metadata(self): 616 """Gets the anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501 617 618 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 619 620 :return: The anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501 621 :rtype: PropertyMetadata 622 """ 623 return self._anchor_ignore_if_not_present_metadata 624 625 @anchor_ignore_if_not_present_metadata.setter 626 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 627 """Sets the anchor_ignore_if_not_present_metadata of this TabGroup. 628 629 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 630 631 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501 632 :type: PropertyMetadata 633 """ 634 635 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 636 637 @property 638 def anchor_match_whole_word(self): 639 """Gets the anchor_match_whole_word of this TabGroup. # noqa: E501 640 641 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 642 643 :return: The anchor_match_whole_word of this TabGroup. # noqa: E501 644 :rtype: str 645 """ 646 return self._anchor_match_whole_word 647 648 @anchor_match_whole_word.setter 649 def anchor_match_whole_word(self, anchor_match_whole_word): 650 """Sets the anchor_match_whole_word of this TabGroup. 651 652 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 653 654 :param anchor_match_whole_word: The anchor_match_whole_word of this TabGroup. # noqa: E501 655 :type: str 656 """ 657 658 self._anchor_match_whole_word = anchor_match_whole_word 659 660 @property 661 def anchor_match_whole_word_metadata(self): 662 """Gets the anchor_match_whole_word_metadata of this TabGroup. # noqa: E501 663 664 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 665 666 :return: The anchor_match_whole_word_metadata of this TabGroup. # noqa: E501 667 :rtype: PropertyMetadata 668 """ 669 return self._anchor_match_whole_word_metadata 670 671 @anchor_match_whole_word_metadata.setter 672 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 673 """Sets the anchor_match_whole_word_metadata of this TabGroup. 674 675 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 676 677 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this TabGroup. # noqa: E501 678 :type: PropertyMetadata 679 """ 680 681 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 682 683 @property 684 def anchor_string(self): 685 """Gets the anchor_string of this TabGroup. # noqa: E501 686 687 Anchor text information for a radio button. # noqa: E501 688 689 :return: The anchor_string of this TabGroup. # noqa: E501 690 :rtype: str 691 """ 692 return self._anchor_string 693 694 @anchor_string.setter 695 def anchor_string(self, anchor_string): 696 """Sets the anchor_string of this TabGroup. 697 698 Anchor text information for a radio button. # noqa: E501 699 700 :param anchor_string: The anchor_string of this TabGroup. # noqa: E501 701 :type: str 702 """ 703 704 self._anchor_string = anchor_string 705 706 @property 707 def anchor_string_metadata(self): 708 """Gets the anchor_string_metadata of this TabGroup. # noqa: E501 709 710 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 711 712 :return: The anchor_string_metadata of this TabGroup. # noqa: E501 713 :rtype: PropertyMetadata 714 """ 715 return self._anchor_string_metadata 716 717 @anchor_string_metadata.setter 718 def anchor_string_metadata(self, anchor_string_metadata): 719 """Sets the anchor_string_metadata of this TabGroup. 720 721 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 722 723 :param anchor_string_metadata: The anchor_string_metadata of this TabGroup. # noqa: E501 724 :type: PropertyMetadata 725 """ 726 727 self._anchor_string_metadata = anchor_string_metadata 728 729 @property 730 def anchor_tab_processor_version(self): 731 """Gets the anchor_tab_processor_version of this TabGroup. # noqa: E501 732 733 # noqa: E501 734 735 :return: The anchor_tab_processor_version of this TabGroup. # noqa: E501 736 :rtype: str 737 """ 738 return self._anchor_tab_processor_version 739 740 @anchor_tab_processor_version.setter 741 def anchor_tab_processor_version(self, anchor_tab_processor_version): 742 """Sets the anchor_tab_processor_version of this TabGroup. 743 744 # noqa: E501 745 746 :param anchor_tab_processor_version: The anchor_tab_processor_version of this TabGroup. # noqa: E501 747 :type: str 748 """ 749 750 self._anchor_tab_processor_version = anchor_tab_processor_version 751 752 @property 753 def anchor_tab_processor_version_metadata(self): 754 """Gets the anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501 755 756 Reserved for DocuSign. # noqa: E501 757 758 :return: The anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501 759 :rtype: PropertyMetadata 760 """ 761 return self._anchor_tab_processor_version_metadata 762 763 @anchor_tab_processor_version_metadata.setter 764 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 765 """Sets the anchor_tab_processor_version_metadata of this TabGroup. 766 767 Reserved for DocuSign. # noqa: E501 768 769 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501 770 :type: PropertyMetadata 771 """ 772 773 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 774 775 @property 776 def anchor_units(self): 777 """Gets the anchor_units of this TabGroup. # noqa: E501 778 779 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 780 781 :return: The anchor_units of this TabGroup. # noqa: E501 782 :rtype: str 783 """ 784 return self._anchor_units 785 786 @anchor_units.setter 787 def anchor_units(self, anchor_units): 788 """Sets the anchor_units of this TabGroup. 789 790 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 791 792 :param anchor_units: The anchor_units of this TabGroup. # noqa: E501 793 :type: str 794 """ 795 796 self._anchor_units = anchor_units 797 798 @property 799 def anchor_units_metadata(self): 800 """Gets the anchor_units_metadata of this TabGroup. # noqa: E501 801 802 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 803 804 :return: The anchor_units_metadata of this TabGroup. # noqa: E501 805 :rtype: PropertyMetadata 806 """ 807 return self._anchor_units_metadata 808 809 @anchor_units_metadata.setter 810 def anchor_units_metadata(self, anchor_units_metadata): 811 """Sets the anchor_units_metadata of this TabGroup. 812 813 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 814 815 :param anchor_units_metadata: The anchor_units_metadata of this TabGroup. # noqa: E501 816 :type: PropertyMetadata 817 """ 818 819 self._anchor_units_metadata = anchor_units_metadata 820 821 @property 822 def anchor_x_offset(self): 823 """Gets the anchor_x_offset of this TabGroup. # noqa: E501 824 825 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 826 827 :return: The anchor_x_offset of this TabGroup. # noqa: E501 828 :rtype: str 829 """ 830 return self._anchor_x_offset 831 832 @anchor_x_offset.setter 833 def anchor_x_offset(self, anchor_x_offset): 834 """Sets the anchor_x_offset of this TabGroup. 835 836 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 837 838 :param anchor_x_offset: The anchor_x_offset of this TabGroup. # noqa: E501 839 :type: str 840 """ 841 842 self._anchor_x_offset = anchor_x_offset 843 844 @property 845 def anchor_x_offset_metadata(self): 846 """Gets the anchor_x_offset_metadata of this TabGroup. # noqa: E501 847 848 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 849 850 :return: The anchor_x_offset_metadata of this TabGroup. # noqa: E501 851 :rtype: PropertyMetadata 852 """ 853 return self._anchor_x_offset_metadata 854 855 @anchor_x_offset_metadata.setter 856 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 857 """Sets the anchor_x_offset_metadata of this TabGroup. 858 859 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 860 861 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this TabGroup. # noqa: E501 862 :type: PropertyMetadata 863 """ 864 865 self._anchor_x_offset_metadata = anchor_x_offset_metadata 866 867 @property 868 def anchor_y_offset(self): 869 """Gets the anchor_y_offset of this TabGroup. # noqa: E501 870 871 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 872 873 :return: The anchor_y_offset of this TabGroup. # noqa: E501 874 :rtype: str 875 """ 876 return self._anchor_y_offset 877 878 @anchor_y_offset.setter 879 def anchor_y_offset(self, anchor_y_offset): 880 """Sets the anchor_y_offset of this TabGroup. 881 882 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 883 884 :param anchor_y_offset: The anchor_y_offset of this TabGroup. # noqa: E501 885 :type: str 886 """ 887 888 self._anchor_y_offset = anchor_y_offset 889 890 @property 891 def anchor_y_offset_metadata(self): 892 """Gets the anchor_y_offset_metadata of this TabGroup. # noqa: E501 893 894 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 895 896 :return: The anchor_y_offset_metadata of this TabGroup. # noqa: E501 897 :rtype: PropertyMetadata 898 """ 899 return self._anchor_y_offset_metadata 900 901 @anchor_y_offset_metadata.setter 902 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 903 """Sets the anchor_y_offset_metadata of this TabGroup. 904 905 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 906 907 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this TabGroup. # noqa: E501 908 :type: PropertyMetadata 909 """ 910 911 self._anchor_y_offset_metadata = anchor_y_offset_metadata 912 913 @property 914 def caption(self): 915 """Gets the caption of this TabGroup. # noqa: E501 916 917 # noqa: E501 918 919 :return: The caption of this TabGroup. # noqa: E501 920 :rtype: str 921 """ 922 return self._caption 923 924 @caption.setter 925 def caption(self, caption): 926 """Sets the caption of this TabGroup. 927 928 # noqa: E501 929 930 :param caption: The caption of this TabGroup. # noqa: E501 931 :type: str 932 """ 933 934 self._caption = caption 935 936 @property 937 def caption_metadata(self): 938 """Gets the caption_metadata of this TabGroup. # noqa: E501 939 940 # noqa: E501 941 942 :return: The caption_metadata of this TabGroup. # noqa: E501 943 :rtype: PropertyMetadata 944 """ 945 return self._caption_metadata 946 947 @caption_metadata.setter 948 def caption_metadata(self, caption_metadata): 949 """Sets the caption_metadata of this TabGroup. 950 951 # noqa: E501 952 953 :param caption_metadata: The caption_metadata of this TabGroup. # noqa: E501 954 :type: PropertyMetadata 955 """ 956 957 self._caption_metadata = caption_metadata 958 959 @property 960 def conditional_parent_label(self): 961 """Gets the conditional_parent_label of this TabGroup. # noqa: E501 962 963 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 964 965 :return: The conditional_parent_label of this TabGroup. # noqa: E501 966 :rtype: str 967 """ 968 return self._conditional_parent_label 969 970 @conditional_parent_label.setter 971 def conditional_parent_label(self, conditional_parent_label): 972 """Sets the conditional_parent_label of this TabGroup. 973 974 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 975 976 :param conditional_parent_label: The conditional_parent_label of this TabGroup. # noqa: E501 977 :type: str 978 """ 979 980 self._conditional_parent_label = conditional_parent_label 981 982 @property 983 def conditional_parent_label_metadata(self): 984 """Gets the conditional_parent_label_metadata of this TabGroup. # noqa: E501 985 986 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 987 988 :return: The conditional_parent_label_metadata of this TabGroup. # noqa: E501 989 :rtype: PropertyMetadata 990 """ 991 return self._conditional_parent_label_metadata 992 993 @conditional_parent_label_metadata.setter 994 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 995 """Sets the conditional_parent_label_metadata of this TabGroup. 996 997 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 998 999 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this TabGroup. # noqa: E501 1000 :type: PropertyMetadata 1001 """ 1002 1003 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1004 1005 @property 1006 def conditional_parent_value(self): 1007 """Gets the conditional_parent_value of this TabGroup. # noqa: E501 1008 1009 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 1010 1011 :return: The conditional_parent_value of this TabGroup. # noqa: E501 1012 :rtype: str 1013 """ 1014 return self._conditional_parent_value 1015 1016 @conditional_parent_value.setter 1017 def conditional_parent_value(self, conditional_parent_value): 1018 """Sets the conditional_parent_value of this TabGroup. 1019 1020 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 1021 1022 :param conditional_parent_value: The conditional_parent_value of this TabGroup. # noqa: E501 1023 :type: str 1024 """ 1025 1026 self._conditional_parent_value = conditional_parent_value 1027 1028 @property 1029 def conditional_parent_value_metadata(self): 1030 """Gets the conditional_parent_value_metadata of this TabGroup. # noqa: E501 1031 1032 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1033 1034 :return: The conditional_parent_value_metadata of this TabGroup. # noqa: E501 1035 :rtype: PropertyMetadata 1036 """ 1037 return self._conditional_parent_value_metadata 1038 1039 @conditional_parent_value_metadata.setter 1040 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1041 """Sets the conditional_parent_value_metadata of this TabGroup. 1042 1043 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1044 1045 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this TabGroup. # noqa: E501 1046 :type: PropertyMetadata 1047 """ 1048 1049 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1050 1051 @property 1052 def connected_object_details(self): 1053 """Gets the connected_object_details of this TabGroup. # noqa: E501 1054 1055 # noqa: E501 1056 1057 :return: The connected_object_details of this TabGroup. # noqa: E501 1058 :rtype: ConnectedObjectDetails 1059 """ 1060 return self._connected_object_details 1061 1062 @connected_object_details.setter 1063 def connected_object_details(self, connected_object_details): 1064 """Sets the connected_object_details of this TabGroup. 1065 1066 # noqa: E501 1067 1068 :param connected_object_details: The connected_object_details of this TabGroup. # noqa: E501 1069 :type: ConnectedObjectDetails 1070 """ 1071 1072 self._connected_object_details = connected_object_details 1073 1074 @property 1075 def custom_tab_id(self): 1076 """Gets the custom_tab_id of this TabGroup. # noqa: E501 1077 1078 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 1079 1080 :return: The custom_tab_id of this TabGroup. # noqa: E501 1081 :rtype: str 1082 """ 1083 return self._custom_tab_id 1084 1085 @custom_tab_id.setter 1086 def custom_tab_id(self, custom_tab_id): 1087 """Sets the custom_tab_id of this TabGroup. 1088 1089 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 1090 1091 :param custom_tab_id: The custom_tab_id of this TabGroup. # noqa: E501 1092 :type: str 1093 """ 1094 1095 self._custom_tab_id = custom_tab_id 1096 1097 @property 1098 def custom_tab_id_metadata(self): 1099 """Gets the custom_tab_id_metadata of this TabGroup. # noqa: E501 1100 1101 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1102 1103 :return: The custom_tab_id_metadata of this TabGroup. # noqa: E501 1104 :rtype: PropertyMetadata 1105 """ 1106 return self._custom_tab_id_metadata 1107 1108 @custom_tab_id_metadata.setter 1109 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1110 """Sets the custom_tab_id_metadata of this TabGroup. 1111 1112 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1113 1114 :param custom_tab_id_metadata: The custom_tab_id_metadata of this TabGroup. # noqa: E501 1115 :type: PropertyMetadata 1116 """ 1117 1118 self._custom_tab_id_metadata = custom_tab_id_metadata 1119 1120 @property 1121 def document_id(self): 1122 """Gets the document_id of this TabGroup. # noqa: E501 1123 1124 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1125 1126 :return: The document_id of this TabGroup. # noqa: E501 1127 :rtype: str 1128 """ 1129 return self._document_id 1130 1131 @document_id.setter 1132 def document_id(self, document_id): 1133 """Sets the document_id of this TabGroup. 1134 1135 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1136 1137 :param document_id: The document_id of this TabGroup. # noqa: E501 1138 :type: str 1139 """ 1140 1141 self._document_id = document_id 1142 1143 @property 1144 def document_id_metadata(self): 1145 """Gets the document_id_metadata of this TabGroup. # noqa: E501 1146 1147 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1148 1149 :return: The document_id_metadata of this TabGroup. # noqa: E501 1150 :rtype: PropertyMetadata 1151 """ 1152 return self._document_id_metadata 1153 1154 @document_id_metadata.setter 1155 def document_id_metadata(self, document_id_metadata): 1156 """Sets the document_id_metadata of this TabGroup. 1157 1158 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1159 1160 :param document_id_metadata: The document_id_metadata of this TabGroup. # noqa: E501 1161 :type: PropertyMetadata 1162 """ 1163 1164 self._document_id_metadata = document_id_metadata 1165 1166 @property 1167 def error_details(self): 1168 """Gets the error_details of this TabGroup. # noqa: E501 1169 1170 Array or errors. # noqa: E501 1171 1172 :return: The error_details of this TabGroup. # noqa: E501 1173 :rtype: ErrorDetails 1174 """ 1175 return self._error_details 1176 1177 @error_details.setter 1178 def error_details(self, error_details): 1179 """Sets the error_details of this TabGroup. 1180 1181 Array or errors. # noqa: E501 1182 1183 :param error_details: The error_details of this TabGroup. # noqa: E501 1184 :type: ErrorDetails 1185 """ 1186 1187 self._error_details = error_details 1188 1189 @property 1190 def extension_data(self): 1191 """Gets the extension_data of this TabGroup. # noqa: E501 1192 1193 # noqa: E501 1194 1195 :return: The extension_data of this TabGroup. # noqa: E501 1196 :rtype: ExtensionData 1197 """ 1198 return self._extension_data 1199 1200 @extension_data.setter 1201 def extension_data(self, extension_data): 1202 """Sets the extension_data of this TabGroup. 1203 1204 # noqa: E501 1205 1206 :param extension_data: The extension_data of this TabGroup. # noqa: E501 1207 :type: ExtensionData 1208 """ 1209 1210 self._extension_data = extension_data 1211 1212 @property 1213 def form_order(self): 1214 """Gets the form_order of this TabGroup. # noqa: E501 1215 1216 # noqa: E501 1217 1218 :return: The form_order of this TabGroup. # noqa: E501 1219 :rtype: str 1220 """ 1221 return self._form_order 1222 1223 @form_order.setter 1224 def form_order(self, form_order): 1225 """Sets the form_order of this TabGroup. 1226 1227 # noqa: E501 1228 1229 :param form_order: The form_order of this TabGroup. # noqa: E501 1230 :type: str 1231 """ 1232 1233 self._form_order = form_order 1234 1235 @property 1236 def form_order_metadata(self): 1237 """Gets the form_order_metadata of this TabGroup. # noqa: E501 1238 1239 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1240 1241 :return: The form_order_metadata of this TabGroup. # noqa: E501 1242 :rtype: PropertyMetadata 1243 """ 1244 return self._form_order_metadata 1245 1246 @form_order_metadata.setter 1247 def form_order_metadata(self, form_order_metadata): 1248 """Sets the form_order_metadata of this TabGroup. 1249 1250 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1251 1252 :param form_order_metadata: The form_order_metadata of this TabGroup. # noqa: E501 1253 :type: PropertyMetadata 1254 """ 1255 1256 self._form_order_metadata = form_order_metadata 1257 1258 @property 1259 def form_page_label(self): 1260 """Gets the form_page_label of this TabGroup. # noqa: E501 1261 1262 # noqa: E501 1263 1264 :return: The form_page_label of this TabGroup. # noqa: E501 1265 :rtype: str 1266 """ 1267 return self._form_page_label 1268 1269 @form_page_label.setter 1270 def form_page_label(self, form_page_label): 1271 """Sets the form_page_label of this TabGroup. 1272 1273 # noqa: E501 1274 1275 :param form_page_label: The form_page_label of this TabGroup. # noqa: E501 1276 :type: str 1277 """ 1278 1279 self._form_page_label = form_page_label 1280 1281 @property 1282 def form_page_label_metadata(self): 1283 """Gets the form_page_label_metadata of this TabGroup. # noqa: E501 1284 1285 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1286 1287 :return: The form_page_label_metadata of this TabGroup. # noqa: E501 1288 :rtype: PropertyMetadata 1289 """ 1290 return self._form_page_label_metadata 1291 1292 @form_page_label_metadata.setter 1293 def form_page_label_metadata(self, form_page_label_metadata): 1294 """Sets the form_page_label_metadata of this TabGroup. 1295 1296 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1297 1298 :param form_page_label_metadata: The form_page_label_metadata of this TabGroup. # noqa: E501 1299 :type: PropertyMetadata 1300 """ 1301 1302 self._form_page_label_metadata = form_page_label_metadata 1303 1304 @property 1305 def form_page_number(self): 1306 """Gets the form_page_number of this TabGroup. # noqa: E501 1307 1308 # noqa: E501 1309 1310 :return: The form_page_number of this TabGroup. # noqa: E501 1311 :rtype: str 1312 """ 1313 return self._form_page_number 1314 1315 @form_page_number.setter 1316 def form_page_number(self, form_page_number): 1317 """Sets the form_page_number of this TabGroup. 1318 1319 # noqa: E501 1320 1321 :param form_page_number: The form_page_number of this TabGroup. # noqa: E501 1322 :type: str 1323 """ 1324 1325 self._form_page_number = form_page_number 1326 1327 @property 1328 def form_page_number_metadata(self): 1329 """Gets the form_page_number_metadata of this TabGroup. # noqa: E501 1330 1331 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1332 1333 :return: The form_page_number_metadata of this TabGroup. # noqa: E501 1334 :rtype: PropertyMetadata 1335 """ 1336 return self._form_page_number_metadata 1337 1338 @form_page_number_metadata.setter 1339 def form_page_number_metadata(self, form_page_number_metadata): 1340 """Sets the form_page_number_metadata of this TabGroup. 1341 1342 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1343 1344 :param form_page_number_metadata: The form_page_number_metadata of this TabGroup. # noqa: E501 1345 :type: PropertyMetadata 1346 """ 1347 1348 self._form_page_number_metadata = form_page_number_metadata 1349 1350 @property 1351 def group_label(self): 1352 """Gets the group_label of this TabGroup. # noqa: E501 1353 1354 # noqa: E501 1355 1356 :return: The group_label of this TabGroup. # noqa: E501 1357 :rtype: str 1358 """ 1359 return self._group_label 1360 1361 @group_label.setter 1362 def group_label(self, group_label): 1363 """Sets the group_label of this TabGroup. 1364 1365 # noqa: E501 1366 1367 :param group_label: The group_label of this TabGroup. # noqa: E501 1368 :type: str 1369 """ 1370 1371 self._group_label = group_label 1372 1373 @property 1374 def group_label_metadata(self): 1375 """Gets the group_label_metadata of this TabGroup. # noqa: E501 1376 1377 Metadata that indicates whether the `groupLabel` property is editable. # noqa: E501 1378 1379 :return: The group_label_metadata of this TabGroup. # noqa: E501 1380 :rtype: PropertyMetadata 1381 """ 1382 return self._group_label_metadata 1383 1384 @group_label_metadata.setter 1385 def group_label_metadata(self, group_label_metadata): 1386 """Sets the group_label_metadata of this TabGroup. 1387 1388 Metadata that indicates whether the `groupLabel` property is editable. # noqa: E501 1389 1390 :param group_label_metadata: The group_label_metadata of this TabGroup. # noqa: E501 1391 :type: PropertyMetadata 1392 """ 1393 1394 self._group_label_metadata = group_label_metadata 1395 1396 @property 1397 def group_rule(self): 1398 """Gets the group_rule of this TabGroup. # noqa: E501 1399 1400 # noqa: E501 1401 1402 :return: The group_rule of this TabGroup. # noqa: E501 1403 :rtype: str 1404 """ 1405 return self._group_rule 1406 1407 @group_rule.setter 1408 def group_rule(self, group_rule): 1409 """Sets the group_rule of this TabGroup. 1410 1411 # noqa: E501 1412 1413 :param group_rule: The group_rule of this TabGroup. # noqa: E501 1414 :type: str 1415 """ 1416 1417 self._group_rule = group_rule 1418 1419 @property 1420 def group_rule_metadata(self): 1421 """Gets the group_rule_metadata of this TabGroup. # noqa: E501 1422 1423 Metadata that indicates whether the `groupRule` property is editable. # noqa: E501 1424 1425 :return: The group_rule_metadata of this TabGroup. # noqa: E501 1426 :rtype: PropertyMetadata 1427 """ 1428 return self._group_rule_metadata 1429 1430 @group_rule_metadata.setter 1431 def group_rule_metadata(self, group_rule_metadata): 1432 """Sets the group_rule_metadata of this TabGroup. 1433 1434 Metadata that indicates whether the `groupRule` property is editable. # noqa: E501 1435 1436 :param group_rule_metadata: The group_rule_metadata of this TabGroup. # noqa: E501 1437 :type: PropertyMetadata 1438 """ 1439 1440 self._group_rule_metadata = group_rule_metadata 1441 1442 @property 1443 def height(self): 1444 """Gets the height of this TabGroup. # noqa: E501 1445 1446 Height of the tab in pixels. # noqa: E501 1447 1448 :return: The height of this TabGroup. # noqa: E501 1449 :rtype: str 1450 """ 1451 return self._height 1452 1453 @height.setter 1454 def height(self, height): 1455 """Sets the height of this TabGroup. 1456 1457 Height of the tab in pixels. # noqa: E501 1458 1459 :param height: The height of this TabGroup. # noqa: E501 1460 :type: str 1461 """ 1462 1463 self._height = height 1464 1465 @property 1466 def height_metadata(self): 1467 """Gets the height_metadata of this TabGroup. # noqa: E501 1468 1469 Metadata that indicates whether the `height` property is editable. # noqa: E501 1470 1471 :return: The height_metadata of this TabGroup. # noqa: E501 1472 :rtype: PropertyMetadata 1473 """ 1474 return self._height_metadata 1475 1476 @height_metadata.setter 1477 def height_metadata(self, height_metadata): 1478 """Sets the height_metadata of this TabGroup. 1479 1480 Metadata that indicates whether the `height` property is editable. # noqa: E501 1481 1482 :param height_metadata: The height_metadata of this TabGroup. # noqa: E501 1483 :type: PropertyMetadata 1484 """ 1485 1486 self._height_metadata = height_metadata 1487 1488 @property 1489 def maximum_allowed(self): 1490 """Gets the maximum_allowed of this TabGroup. # noqa: E501 1491 1492 # noqa: E501 1493 1494 :return: The maximum_allowed of this TabGroup. # noqa: E501 1495 :rtype: str 1496 """ 1497 return self._maximum_allowed 1498 1499 @maximum_allowed.setter 1500 def maximum_allowed(self, maximum_allowed): 1501 """Sets the maximum_allowed of this TabGroup. 1502 1503 # noqa: E501 1504 1505 :param maximum_allowed: The maximum_allowed of this TabGroup. # noqa: E501 1506 :type: str 1507 """ 1508 1509 self._maximum_allowed = maximum_allowed 1510 1511 @property 1512 def maximum_allowed_metadata(self): 1513 """Gets the maximum_allowed_metadata of this TabGroup. # noqa: E501 1514 1515 Metadata that indicates whether the `maximumAllowed` property is editable. # noqa: E501 1516 1517 :return: The maximum_allowed_metadata of this TabGroup. # noqa: E501 1518 :rtype: PropertyMetadata 1519 """ 1520 return self._maximum_allowed_metadata 1521 1522 @maximum_allowed_metadata.setter 1523 def maximum_allowed_metadata(self, maximum_allowed_metadata): 1524 """Sets the maximum_allowed_metadata of this TabGroup. 1525 1526 Metadata that indicates whether the `maximumAllowed` property is editable. # noqa: E501 1527 1528 :param maximum_allowed_metadata: The maximum_allowed_metadata of this TabGroup. # noqa: E501 1529 :type: PropertyMetadata 1530 """ 1531 1532 self._maximum_allowed_metadata = maximum_allowed_metadata 1533 1534 @property 1535 def merge_field(self): 1536 """Gets the merge_field of this TabGroup. # noqa: E501 1537 1538 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1539 1540 :return: The merge_field of this TabGroup. # noqa: E501 1541 :rtype: MergeField 1542 """ 1543 return self._merge_field 1544 1545 @merge_field.setter 1546 def merge_field(self, merge_field): 1547 """Sets the merge_field of this TabGroup. 1548 1549 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1550 1551 :param merge_field: The merge_field of this TabGroup. # noqa: E501 1552 :type: MergeField 1553 """ 1554 1555 self._merge_field = merge_field 1556 1557 @property 1558 def merge_field_xml(self): 1559 """Gets the merge_field_xml of this TabGroup. # noqa: E501 1560 1561 # noqa: E501 1562 1563 :return: The merge_field_xml of this TabGroup. # noqa: E501 1564 :rtype: str 1565 """ 1566 return self._merge_field_xml 1567 1568 @merge_field_xml.setter 1569 def merge_field_xml(self, merge_field_xml): 1570 """Sets the merge_field_xml of this TabGroup. 1571 1572 # noqa: E501 1573 1574 :param merge_field_xml: The merge_field_xml of this TabGroup. # noqa: E501 1575 :type: str 1576 """ 1577 1578 self._merge_field_xml = merge_field_xml 1579 1580 @property 1581 def minimum_required(self): 1582 """Gets the minimum_required of this TabGroup. # noqa: E501 1583 1584 # noqa: E501 1585 1586 :return: The minimum_required of this TabGroup. # noqa: E501 1587 :rtype: str 1588 """ 1589 return self._minimum_required 1590 1591 @minimum_required.setter 1592 def minimum_required(self, minimum_required): 1593 """Sets the minimum_required of this TabGroup. 1594 1595 # noqa: E501 1596 1597 :param minimum_required: The minimum_required of this TabGroup. # noqa: E501 1598 :type: str 1599 """ 1600 1601 self._minimum_required = minimum_required 1602 1603 @property 1604 def minimum_required_metadata(self): 1605 """Gets the minimum_required_metadata of this TabGroup. # noqa: E501 1606 1607 Metadata that indicates whether the `minimumRequired` property is editable. # noqa: E501 1608 1609 :return: The minimum_required_metadata of this TabGroup. # noqa: E501 1610 :rtype: PropertyMetadata 1611 """ 1612 return self._minimum_required_metadata 1613 1614 @minimum_required_metadata.setter 1615 def minimum_required_metadata(self, minimum_required_metadata): 1616 """Sets the minimum_required_metadata of this TabGroup. 1617 1618 Metadata that indicates whether the `minimumRequired` property is editable. # noqa: E501 1619 1620 :param minimum_required_metadata: The minimum_required_metadata of this TabGroup. # noqa: E501 1621 :type: PropertyMetadata 1622 """ 1623 1624 self._minimum_required_metadata = minimum_required_metadata 1625 1626 @property 1627 def page_number(self): 1628 """Gets the page_number of this TabGroup. # noqa: E501 1629 1630 Specifies the page number on which the tab is located. # noqa: E501 1631 1632 :return: The page_number of this TabGroup. # noqa: E501 1633 :rtype: str 1634 """ 1635 return self._page_number 1636 1637 @page_number.setter 1638 def page_number(self, page_number): 1639 """Sets the page_number of this TabGroup. 1640 1641 Specifies the page number on which the tab is located. # noqa: E501 1642 1643 :param page_number: The page_number of this TabGroup. # noqa: E501 1644 :type: str 1645 """ 1646 1647 self._page_number = page_number 1648 1649 @property 1650 def page_number_metadata(self): 1651 """Gets the page_number_metadata of this TabGroup. # noqa: E501 1652 1653 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1654 1655 :return: The page_number_metadata of this TabGroup. # noqa: E501 1656 :rtype: PropertyMetadata 1657 """ 1658 return self._page_number_metadata 1659 1660 @page_number_metadata.setter 1661 def page_number_metadata(self, page_number_metadata): 1662 """Sets the page_number_metadata of this TabGroup. 1663 1664 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1665 1666 :param page_number_metadata: The page_number_metadata of this TabGroup. # noqa: E501 1667 :type: PropertyMetadata 1668 """ 1669 1670 self._page_number_metadata = page_number_metadata 1671 1672 @property 1673 def recipient_id(self): 1674 """Gets the recipient_id of this TabGroup. # noqa: E501 1675 1676 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1677 1678 :return: The recipient_id of this TabGroup. # noqa: E501 1679 :rtype: str 1680 """ 1681 return self._recipient_id 1682 1683 @recipient_id.setter 1684 def recipient_id(self, recipient_id): 1685 """Sets the recipient_id of this TabGroup. 1686 1687 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1688 1689 :param recipient_id: The recipient_id of this TabGroup. # noqa: E501 1690 :type: str 1691 """ 1692 1693 self._recipient_id = recipient_id 1694 1695 @property 1696 def recipient_id_guid(self): 1697 """Gets the recipient_id_guid of this TabGroup. # noqa: E501 1698 1699 # noqa: E501 1700 1701 :return: The recipient_id_guid of this TabGroup. # noqa: E501 1702 :rtype: str 1703 """ 1704 return self._recipient_id_guid 1705 1706 @recipient_id_guid.setter 1707 def recipient_id_guid(self, recipient_id_guid): 1708 """Sets the recipient_id_guid of this TabGroup. 1709 1710 # noqa: E501 1711 1712 :param recipient_id_guid: The recipient_id_guid of this TabGroup. # noqa: E501 1713 :type: str 1714 """ 1715 1716 self._recipient_id_guid = recipient_id_guid 1717 1718 @property 1719 def recipient_id_guid_metadata(self): 1720 """Gets the recipient_id_guid_metadata of this TabGroup. # noqa: E501 1721 1722 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1723 1724 :return: The recipient_id_guid_metadata of this TabGroup. # noqa: E501 1725 :rtype: PropertyMetadata 1726 """ 1727 return self._recipient_id_guid_metadata 1728 1729 @recipient_id_guid_metadata.setter 1730 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 1731 """Sets the recipient_id_guid_metadata of this TabGroup. 1732 1733 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1734 1735 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this TabGroup. # noqa: E501 1736 :type: PropertyMetadata 1737 """ 1738 1739 self._recipient_id_guid_metadata = recipient_id_guid_metadata 1740 1741 @property 1742 def recipient_id_metadata(self): 1743 """Gets the recipient_id_metadata of this TabGroup. # noqa: E501 1744 1745 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1746 1747 :return: The recipient_id_metadata of this TabGroup. # noqa: E501 1748 :rtype: PropertyMetadata 1749 """ 1750 return self._recipient_id_metadata 1751 1752 @recipient_id_metadata.setter 1753 def recipient_id_metadata(self, recipient_id_metadata): 1754 """Sets the recipient_id_metadata of this TabGroup. 1755 1756 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1757 1758 :param recipient_id_metadata: The recipient_id_metadata of this TabGroup. # noqa: E501 1759 :type: PropertyMetadata 1760 """ 1761 1762 self._recipient_id_metadata = recipient_id_metadata 1763 1764 @property 1765 def smart_contract_information(self): 1766 """Gets the smart_contract_information of this TabGroup. # noqa: E501 1767 1768 Reserved for DocuSign. # noqa: E501 1769 1770 :return: The smart_contract_information of this TabGroup. # noqa: E501 1771 :rtype: SmartContractInformation 1772 """ 1773 return self._smart_contract_information 1774 1775 @smart_contract_information.setter 1776 def smart_contract_information(self, smart_contract_information): 1777 """Sets the smart_contract_information of this TabGroup. 1778 1779 Reserved for DocuSign. # noqa: E501 1780 1781 :param smart_contract_information: The smart_contract_information of this TabGroup. # noqa: E501 1782 :type: SmartContractInformation 1783 """ 1784 1785 self._smart_contract_information = smart_contract_information 1786 1787 @property 1788 def source(self): 1789 """Gets the source of this TabGroup. # noqa: E501 1790 1791 # noqa: E501 1792 1793 :return: The source of this TabGroup. # noqa: E501 1794 :rtype: str 1795 """ 1796 return self._source 1797 1798 @source.setter 1799 def source(self, source): 1800 """Sets the source of this TabGroup. 1801 1802 # noqa: E501 1803 1804 :param source: The source of this TabGroup. # noqa: E501 1805 :type: str 1806 """ 1807 1808 self._source = source 1809 1810 @property 1811 def status(self): 1812 """Gets the status of this TabGroup. # noqa: E501 1813 1814 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 1815 1816 :return: The status of this TabGroup. # noqa: E501 1817 :rtype: str 1818 """ 1819 return self._status 1820 1821 @status.setter 1822 def status(self, status): 1823 """Sets the status of this TabGroup. 1824 1825 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 1826 1827 :param status: The status of this TabGroup. # noqa: E501 1828 :type: str 1829 """ 1830 1831 self._status = status 1832 1833 @property 1834 def status_metadata(self): 1835 """Gets the status_metadata of this TabGroup. # noqa: E501 1836 1837 Metadata that indicates whether the `status` property is editable. # noqa: E501 1838 1839 :return: The status_metadata of this TabGroup. # noqa: E501 1840 :rtype: PropertyMetadata 1841 """ 1842 return self._status_metadata 1843 1844 @status_metadata.setter 1845 def status_metadata(self, status_metadata): 1846 """Sets the status_metadata of this TabGroup. 1847 1848 Metadata that indicates whether the `status` property is editable. # noqa: E501 1849 1850 :param status_metadata: The status_metadata of this TabGroup. # noqa: E501 1851 :type: PropertyMetadata 1852 """ 1853 1854 self._status_metadata = status_metadata 1855 1856 @property 1857 def tab_fully_qualified_path(self): 1858 """Gets the tab_fully_qualified_path of this TabGroup. # noqa: E501 1859 1860 # noqa: E501 1861 1862 :return: The tab_fully_qualified_path of this TabGroup. # noqa: E501 1863 :rtype: str 1864 """ 1865 return self._tab_fully_qualified_path 1866 1867 @tab_fully_qualified_path.setter 1868 def tab_fully_qualified_path(self, tab_fully_qualified_path): 1869 """Sets the tab_fully_qualified_path of this TabGroup. 1870 1871 # noqa: E501 1872 1873 :param tab_fully_qualified_path: The tab_fully_qualified_path of this TabGroup. # noqa: E501 1874 :type: str 1875 """ 1876 1877 self._tab_fully_qualified_path = tab_fully_qualified_path 1878 1879 @property 1880 def tab_group_labels(self): 1881 """Gets the tab_group_labels of this TabGroup. # noqa: E501 1882 1883 # noqa: E501 1884 1885 :return: The tab_group_labels of this TabGroup. # noqa: E501 1886 :rtype: list[str] 1887 """ 1888 return self._tab_group_labels 1889 1890 @tab_group_labels.setter 1891 def tab_group_labels(self, tab_group_labels): 1892 """Sets the tab_group_labels of this TabGroup. 1893 1894 # noqa: E501 1895 1896 :param tab_group_labels: The tab_group_labels of this TabGroup. # noqa: E501 1897 :type: list[str] 1898 """ 1899 1900 self._tab_group_labels = tab_group_labels 1901 1902 @property 1903 def tab_group_labels_metadata(self): 1904 """Gets the tab_group_labels_metadata of this TabGroup. # noqa: E501 1905 1906 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1907 1908 :return: The tab_group_labels_metadata of this TabGroup. # noqa: E501 1909 :rtype: PropertyMetadata 1910 """ 1911 return self._tab_group_labels_metadata 1912 1913 @tab_group_labels_metadata.setter 1914 def tab_group_labels_metadata(self, tab_group_labels_metadata): 1915 """Sets the tab_group_labels_metadata of this TabGroup. 1916 1917 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1918 1919 :param tab_group_labels_metadata: The tab_group_labels_metadata of this TabGroup. # noqa: E501 1920 :type: PropertyMetadata 1921 """ 1922 1923 self._tab_group_labels_metadata = tab_group_labels_metadata 1924 1925 @property 1926 def tab_id(self): 1927 """Gets the tab_id of this TabGroup. # noqa: E501 1928 1929 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1930 1931 :return: The tab_id of this TabGroup. # noqa: E501 1932 :rtype: str 1933 """ 1934 return self._tab_id 1935 1936 @tab_id.setter 1937 def tab_id(self, tab_id): 1938 """Sets the tab_id of this TabGroup. 1939 1940 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1941 1942 :param tab_id: The tab_id of this TabGroup. # noqa: E501 1943 :type: str 1944 """ 1945 1946 self._tab_id = tab_id 1947 1948 @property 1949 def tab_id_metadata(self): 1950 """Gets the tab_id_metadata of this TabGroup. # noqa: E501 1951 1952 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1953 1954 :return: The tab_id_metadata of this TabGroup. # noqa: E501 1955 :rtype: PropertyMetadata 1956 """ 1957 return self._tab_id_metadata 1958 1959 @tab_id_metadata.setter 1960 def tab_id_metadata(self, tab_id_metadata): 1961 """Sets the tab_id_metadata of this TabGroup. 1962 1963 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1964 1965 :param tab_id_metadata: The tab_id_metadata of this TabGroup. # noqa: E501 1966 :type: PropertyMetadata 1967 """ 1968 1969 self._tab_id_metadata = tab_id_metadata 1970 1971 @property 1972 def tab_order(self): 1973 """Gets the tab_order of this TabGroup. # noqa: E501 1974 1975 # noqa: E501 1976 1977 :return: The tab_order of this TabGroup. # noqa: E501 1978 :rtype: str 1979 """ 1980 return self._tab_order 1981 1982 @tab_order.setter 1983 def tab_order(self, tab_order): 1984 """Sets the tab_order of this TabGroup. 1985 1986 # noqa: E501 1987 1988 :param tab_order: The tab_order of this TabGroup. # noqa: E501 1989 :type: str 1990 """ 1991 1992 self._tab_order = tab_order 1993 1994 @property 1995 def tab_order_metadata(self): 1996 """Gets the tab_order_metadata of this TabGroup. # noqa: E501 1997 1998 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 1999 2000 :return: The tab_order_metadata of this TabGroup. # noqa: E501 2001 :rtype: PropertyMetadata 2002 """ 2003 return self._tab_order_metadata 2004 2005 @tab_order_metadata.setter 2006 def tab_order_metadata(self, tab_order_metadata): 2007 """Sets the tab_order_metadata of this TabGroup. 2008 2009 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 2010 2011 :param tab_order_metadata: The tab_order_metadata of this TabGroup. # noqa: E501 2012 :type: PropertyMetadata 2013 """ 2014 2015 self._tab_order_metadata = tab_order_metadata 2016 2017 @property 2018 def tab_scope(self): 2019 """Gets the tab_scope of this TabGroup. # noqa: E501 2020 2021 # noqa: E501 2022 2023 :return: The tab_scope of this TabGroup. # noqa: E501 2024 :rtype: str 2025 """ 2026 return self._tab_scope 2027 2028 @tab_scope.setter 2029 def tab_scope(self, tab_scope): 2030 """Sets the tab_scope of this TabGroup. 2031 2032 # noqa: E501 2033 2034 :param tab_scope: The tab_scope of this TabGroup. # noqa: E501 2035 :type: str 2036 """ 2037 2038 self._tab_scope = tab_scope 2039 2040 @property 2041 def tab_scope_metadata(self): 2042 """Gets the tab_scope_metadata of this TabGroup. # noqa: E501 2043 2044 Metadata that indicates whether the `tabScope` property is editable. # noqa: E501 2045 2046 :return: The tab_scope_metadata of this TabGroup. # noqa: E501 2047 :rtype: PropertyMetadata 2048 """ 2049 return self._tab_scope_metadata 2050 2051 @tab_scope_metadata.setter 2052 def tab_scope_metadata(self, tab_scope_metadata): 2053 """Sets the tab_scope_metadata of this TabGroup. 2054 2055 Metadata that indicates whether the `tabScope` property is editable. # noqa: E501 2056 2057 :param tab_scope_metadata: The tab_scope_metadata of this TabGroup. # noqa: E501 2058 :type: PropertyMetadata 2059 """ 2060 2061 self._tab_scope_metadata = tab_scope_metadata 2062 2063 @property 2064 def tab_type(self): 2065 """Gets the tab_type of this TabGroup. # noqa: E501 2066 2067 # noqa: E501 2068 2069 :return: The tab_type of this TabGroup. # noqa: E501 2070 :rtype: str 2071 """ 2072 return self._tab_type 2073 2074 @tab_type.setter 2075 def tab_type(self, tab_type): 2076 """Sets the tab_type of this TabGroup. 2077 2078 # noqa: E501 2079 2080 :param tab_type: The tab_type of this TabGroup. # noqa: E501 2081 :type: str 2082 """ 2083 2084 self._tab_type = tab_type 2085 2086 @property 2087 def tab_type_metadata(self): 2088 """Gets the tab_type_metadata of this TabGroup. # noqa: E501 2089 2090 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2091 2092 :return: The tab_type_metadata of this TabGroup. # noqa: E501 2093 :rtype: PropertyMetadata 2094 """ 2095 return self._tab_type_metadata 2096 2097 @tab_type_metadata.setter 2098 def tab_type_metadata(self, tab_type_metadata): 2099 """Sets the tab_type_metadata of this TabGroup. 2100 2101 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2102 2103 :param tab_type_metadata: The tab_type_metadata of this TabGroup. # noqa: E501 2104 :type: PropertyMetadata 2105 """ 2106 2107 self._tab_type_metadata = tab_type_metadata 2108 2109 @property 2110 def template_locked(self): 2111 """Gets the template_locked of this TabGroup. # noqa: E501 2112 2113 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2114 2115 :return: The template_locked of this TabGroup. # noqa: E501 2116 :rtype: str 2117 """ 2118 return self._template_locked 2119 2120 @template_locked.setter 2121 def template_locked(self, template_locked): 2122 """Sets the template_locked of this TabGroup. 2123 2124 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2125 2126 :param template_locked: The template_locked of this TabGroup. # noqa: E501 2127 :type: str 2128 """ 2129 2130 self._template_locked = template_locked 2131 2132 @property 2133 def template_locked_metadata(self): 2134 """Gets the template_locked_metadata of this TabGroup. # noqa: E501 2135 2136 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2137 2138 :return: The template_locked_metadata of this TabGroup. # noqa: E501 2139 :rtype: PropertyMetadata 2140 """ 2141 return self._template_locked_metadata 2142 2143 @template_locked_metadata.setter 2144 def template_locked_metadata(self, template_locked_metadata): 2145 """Sets the template_locked_metadata of this TabGroup. 2146 2147 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2148 2149 :param template_locked_metadata: The template_locked_metadata of this TabGroup. # noqa: E501 2150 :type: PropertyMetadata 2151 """ 2152 2153 self._template_locked_metadata = template_locked_metadata 2154 2155 @property 2156 def template_required(self): 2157 """Gets the template_required of this TabGroup. # noqa: E501 2158 2159 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2160 2161 :return: The template_required of this TabGroup. # noqa: E501 2162 :rtype: str 2163 """ 2164 return self._template_required 2165 2166 @template_required.setter 2167 def template_required(self, template_required): 2168 """Sets the template_required of this TabGroup. 2169 2170 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2171 2172 :param template_required: The template_required of this TabGroup. # noqa: E501 2173 :type: str 2174 """ 2175 2176 self._template_required = template_required 2177 2178 @property 2179 def template_required_metadata(self): 2180 """Gets the template_required_metadata of this TabGroup. # noqa: E501 2181 2182 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2183 2184 :return: The template_required_metadata of this TabGroup. # noqa: E501 2185 :rtype: PropertyMetadata 2186 """ 2187 return self._template_required_metadata 2188 2189 @template_required_metadata.setter 2190 def template_required_metadata(self, template_required_metadata): 2191 """Sets the template_required_metadata of this TabGroup. 2192 2193 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2194 2195 :param template_required_metadata: The template_required_metadata of this TabGroup. # noqa: E501 2196 :type: PropertyMetadata 2197 """ 2198 2199 self._template_required_metadata = template_required_metadata 2200 2201 @property 2202 def tooltip(self): 2203 """Gets the tooltip of this TabGroup. # noqa: E501 2204 2205 # noqa: E501 2206 2207 :return: The tooltip of this TabGroup. # noqa: E501 2208 :rtype: str 2209 """ 2210 return self._tooltip 2211 2212 @tooltip.setter 2213 def tooltip(self, tooltip): 2214 """Sets the tooltip of this TabGroup. 2215 2216 # noqa: E501 2217 2218 :param tooltip: The tooltip of this TabGroup. # noqa: E501 2219 :type: str 2220 """ 2221 2222 self._tooltip = tooltip 2223 2224 @property 2225 def tool_tip_metadata(self): 2226 """Gets the tool_tip_metadata of this TabGroup. # noqa: E501 2227 2228 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2229 2230 :return: The tool_tip_metadata of this TabGroup. # noqa: E501 2231 :rtype: PropertyMetadata 2232 """ 2233 return self._tool_tip_metadata 2234 2235 @tool_tip_metadata.setter 2236 def tool_tip_metadata(self, tool_tip_metadata): 2237 """Sets the tool_tip_metadata of this TabGroup. 2238 2239 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2240 2241 :param tool_tip_metadata: The tool_tip_metadata of this TabGroup. # noqa: E501 2242 :type: PropertyMetadata 2243 """ 2244 2245 self._tool_tip_metadata = tool_tip_metadata 2246 2247 @property 2248 def validation_message(self): 2249 """Gets the validation_message of this TabGroup. # noqa: E501 2250 2251 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 2252 2253 :return: The validation_message of this TabGroup. # noqa: E501 2254 :rtype: str 2255 """ 2256 return self._validation_message 2257 2258 @validation_message.setter 2259 def validation_message(self, validation_message): 2260 """Sets the validation_message of this TabGroup. 2261 2262 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 2263 2264 :param validation_message: The validation_message of this TabGroup. # noqa: E501 2265 :type: str 2266 """ 2267 2268 self._validation_message = validation_message 2269 2270 @property 2271 def validation_message_metadata(self): 2272 """Gets the validation_message_metadata of this TabGroup. # noqa: E501 2273 2274 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 2275 2276 :return: The validation_message_metadata of this TabGroup. # noqa: E501 2277 :rtype: PropertyMetadata 2278 """ 2279 return self._validation_message_metadata 2280 2281 @validation_message_metadata.setter 2282 def validation_message_metadata(self, validation_message_metadata): 2283 """Sets the validation_message_metadata of this TabGroup. 2284 2285 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 2286 2287 :param validation_message_metadata: The validation_message_metadata of this TabGroup. # noqa: E501 2288 :type: PropertyMetadata 2289 """ 2290 2291 self._validation_message_metadata = validation_message_metadata 2292 2293 @property 2294 def warning_details(self): 2295 """Gets the warning_details of this TabGroup. # noqa: E501 2296 2297 # noqa: E501 2298 2299 :return: The warning_details of this TabGroup. # noqa: E501 2300 :rtype: ErrorDetails 2301 """ 2302 return self._warning_details 2303 2304 @warning_details.setter 2305 def warning_details(self, warning_details): 2306 """Sets the warning_details of this TabGroup. 2307 2308 # noqa: E501 2309 2310 :param warning_details: The warning_details of this TabGroup. # noqa: E501 2311 :type: ErrorDetails 2312 """ 2313 2314 self._warning_details = warning_details 2315 2316 @property 2317 def width(self): 2318 """Gets the width of this TabGroup. # noqa: E501 2319 2320 Width of the tab in pixels. # noqa: E501 2321 2322 :return: The width of this TabGroup. # noqa: E501 2323 :rtype: str 2324 """ 2325 return self._width 2326 2327 @width.setter 2328 def width(self, width): 2329 """Sets the width of this TabGroup. 2330 2331 Width of the tab in pixels. # noqa: E501 2332 2333 :param width: The width of this TabGroup. # noqa: E501 2334 :type: str 2335 """ 2336 2337 self._width = width 2338 2339 @property 2340 def width_metadata(self): 2341 """Gets the width_metadata of this TabGroup. # noqa: E501 2342 2343 Metadata that indicates whether the `width` property is editable. # noqa: E501 2344 2345 :return: The width_metadata of this TabGroup. # noqa: E501 2346 :rtype: PropertyMetadata 2347 """ 2348 return self._width_metadata 2349 2350 @width_metadata.setter 2351 def width_metadata(self, width_metadata): 2352 """Sets the width_metadata of this TabGroup. 2353 2354 Metadata that indicates whether the `width` property is editable. # noqa: E501 2355 2356 :param width_metadata: The width_metadata of this TabGroup. # noqa: E501 2357 :type: PropertyMetadata 2358 """ 2359 2360 self._width_metadata = width_metadata 2361 2362 @property 2363 def x_position(self): 2364 """Gets the x_position of this TabGroup. # noqa: E501 2365 2366 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2367 2368 :return: The x_position of this TabGroup. # noqa: E501 2369 :rtype: str 2370 """ 2371 return self._x_position 2372 2373 @x_position.setter 2374 def x_position(self, x_position): 2375 """Sets the x_position of this TabGroup. 2376 2377 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2378 2379 :param x_position: The x_position of this TabGroup. # noqa: E501 2380 :type: str 2381 """ 2382 2383 self._x_position = x_position 2384 2385 @property 2386 def x_position_metadata(self): 2387 """Gets the x_position_metadata of this TabGroup. # noqa: E501 2388 2389 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2390 2391 :return: The x_position_metadata of this TabGroup. # noqa: E501 2392 :rtype: PropertyMetadata 2393 """ 2394 return self._x_position_metadata 2395 2396 @x_position_metadata.setter 2397 def x_position_metadata(self, x_position_metadata): 2398 """Sets the x_position_metadata of this TabGroup. 2399 2400 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2401 2402 :param x_position_metadata: The x_position_metadata of this TabGroup. # noqa: E501 2403 :type: PropertyMetadata 2404 """ 2405 2406 self._x_position_metadata = x_position_metadata 2407 2408 @property 2409 def y_position(self): 2410 """Gets the y_position of this TabGroup. # noqa: E501 2411 2412 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2413 2414 :return: The y_position of this TabGroup. # noqa: E501 2415 :rtype: str 2416 """ 2417 return self._y_position 2418 2419 @y_position.setter 2420 def y_position(self, y_position): 2421 """Sets the y_position of this TabGroup. 2422 2423 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2424 2425 :param y_position: The y_position of this TabGroup. # noqa: E501 2426 :type: str 2427 """ 2428 2429 self._y_position = y_position 2430 2431 @property 2432 def y_position_metadata(self): 2433 """Gets the y_position_metadata of this TabGroup. # noqa: E501 2434 2435 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2436 2437 :return: The y_position_metadata of this TabGroup. # noqa: E501 2438 :rtype: PropertyMetadata 2439 """ 2440 return self._y_position_metadata 2441 2442 @y_position_metadata.setter 2443 def y_position_metadata(self, y_position_metadata): 2444 """Sets the y_position_metadata of this TabGroup. 2445 2446 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2447 2448 :param y_position_metadata: The y_position_metadata of this TabGroup. # noqa: E501 2449 :type: PropertyMetadata 2450 """ 2451 2452 self._y_position_metadata = y_position_metadata 2453 2454 def to_dict(self): 2455 """Returns the model properties as a dict""" 2456 result = {} 2457 2458 for attr, _ in six.iteritems(self.swagger_types): 2459 value = getattr(self, attr) 2460 if isinstance(value, list): 2461 result[attr] = list(map( 2462 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2463 value 2464 )) 2465 elif hasattr(value, "to_dict"): 2466 result[attr] = value.to_dict() 2467 elif isinstance(value, dict): 2468 result[attr] = dict(map( 2469 lambda item: (item[0], item[1].to_dict()) 2470 if hasattr(item[1], "to_dict") else item, 2471 value.items() 2472 )) 2473 else: 2474 result[attr] = value 2475 if issubclass(TabGroup, dict): 2476 for key, value in self.items(): 2477 result[key] = value 2478 2479 return result 2480 2481 def to_str(self): 2482 """Returns the string representation of the model""" 2483 return pprint.pformat(self.to_dict()) 2484 2485 def __repr__(self): 2486 """For `print` and `pprint`""" 2487 return self.to_str() 2488 2489 def __eq__(self, other): 2490 """Returns true if both objects are equal""" 2491 if not isinstance(other, TabGroup): 2492 return False 2493 2494 return self.to_dict() == other.to_dict() 2495 2496 def __ne__(self, other): 2497 """Returns true if both objects are not equal""" 2498 if not isinstance(other, TabGroup): 2499 return True 2500 2501 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.
TabGroup(_configuration=None, **kwargs)
220 def __init__(self, _configuration=None, **kwargs): # noqa: E501 221 """TabGroup - a model defined in Swagger""" # noqa: E501 222 if _configuration is None: 223 _configuration = Configuration() 224 self._configuration = _configuration 225 226 self._agreement_attribute = None 227 self._agreement_attribute_locked = None 228 self._anchor_allow_white_space_in_characters = None 229 self._anchor_allow_white_space_in_characters_metadata = None 230 self._anchor_case_sensitive = None 231 self._anchor_case_sensitive_metadata = None 232 self._anchor_horizontal_alignment = None 233 self._anchor_horizontal_alignment_metadata = None 234 self._anchor_ignore_if_not_present = None 235 self._anchor_ignore_if_not_present_metadata = None 236 self._anchor_match_whole_word = None 237 self._anchor_match_whole_word_metadata = None 238 self._anchor_string = None 239 self._anchor_string_metadata = None 240 self._anchor_tab_processor_version = None 241 self._anchor_tab_processor_version_metadata = None 242 self._anchor_units = None 243 self._anchor_units_metadata = None 244 self._anchor_x_offset = None 245 self._anchor_x_offset_metadata = None 246 self._anchor_y_offset = None 247 self._anchor_y_offset_metadata = None 248 self._caption = None 249 self._caption_metadata = None 250 self._conditional_parent_label = None 251 self._conditional_parent_label_metadata = None 252 self._conditional_parent_value = None 253 self._conditional_parent_value_metadata = None 254 self._connected_object_details = None 255 self._custom_tab_id = None 256 self._custom_tab_id_metadata = None 257 self._document_id = None 258 self._document_id_metadata = None 259 self._error_details = None 260 self._extension_data = None 261 self._form_order = None 262 self._form_order_metadata = None 263 self._form_page_label = None 264 self._form_page_label_metadata = None 265 self._form_page_number = None 266 self._form_page_number_metadata = None 267 self._group_label = None 268 self._group_label_metadata = None 269 self._group_rule = None 270 self._group_rule_metadata = None 271 self._height = None 272 self._height_metadata = None 273 self._maximum_allowed = None 274 self._maximum_allowed_metadata = None 275 self._merge_field = None 276 self._merge_field_xml = None 277 self._minimum_required = None 278 self._minimum_required_metadata = None 279 self._page_number = None 280 self._page_number_metadata = None 281 self._recipient_id = None 282 self._recipient_id_guid = None 283 self._recipient_id_guid_metadata = None 284 self._recipient_id_metadata = None 285 self._smart_contract_information = None 286 self._source = None 287 self._status = None 288 self._status_metadata = None 289 self._tab_fully_qualified_path = None 290 self._tab_group_labels = None 291 self._tab_group_labels_metadata = None 292 self._tab_id = None 293 self._tab_id_metadata = None 294 self._tab_order = None 295 self._tab_order_metadata = None 296 self._tab_scope = None 297 self._tab_scope_metadata = None 298 self._tab_type = None 299 self._tab_type_metadata = None 300 self._template_locked = None 301 self._template_locked_metadata = None 302 self._template_required = None 303 self._template_required_metadata = None 304 self._tooltip = None 305 self._tool_tip_metadata = None 306 self._validation_message = None 307 self._validation_message_metadata = None 308 self._warning_details = None 309 self._width = None 310 self._width_metadata = None 311 self._x_position = None 312 self._x_position_metadata = None 313 self._y_position = None 314 self._y_position_metadata = None 315 self.discriminator = None 316 317 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 318 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 319 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 320 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 321 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 322 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 323 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 324 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 325 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 326 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 327 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 328 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 329 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 330 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 331 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 332 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 333 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 334 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 335 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 336 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 337 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 338 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 339 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 340 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 341 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 342 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 343 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 344 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 345 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 346 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 347 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 348 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 349 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 350 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 351 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 352 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 353 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 354 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 355 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 356 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 357 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 358 setattr(self, "_{}".format('group_label'), kwargs.get('group_label', None)) 359 setattr(self, "_{}".format('group_label_metadata'), kwargs.get('group_label_metadata', None)) 360 setattr(self, "_{}".format('group_rule'), kwargs.get('group_rule', None)) 361 setattr(self, "_{}".format('group_rule_metadata'), kwargs.get('group_rule_metadata', None)) 362 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 363 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 364 setattr(self, "_{}".format('maximum_allowed'), kwargs.get('maximum_allowed', None)) 365 setattr(self, "_{}".format('maximum_allowed_metadata'), kwargs.get('maximum_allowed_metadata', None)) 366 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 367 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 368 setattr(self, "_{}".format('minimum_required'), kwargs.get('minimum_required', None)) 369 setattr(self, "_{}".format('minimum_required_metadata'), kwargs.get('minimum_required_metadata', None)) 370 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 371 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 372 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 373 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 374 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 375 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 376 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 377 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 378 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 379 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 380 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 381 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 382 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 383 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 384 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 385 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 386 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 387 setattr(self, "_{}".format('tab_scope'), kwargs.get('tab_scope', None)) 388 setattr(self, "_{}".format('tab_scope_metadata'), kwargs.get('tab_scope_metadata', None)) 389 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 390 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 391 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 392 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 393 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 394 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 395 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 396 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 397 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 398 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 399 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 400 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 401 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 402 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 403 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 404 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 405 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None))
TabGroup - a model defined in Swagger
swagger_types = {'agreement_attribute': 'str', 'agreement_attribute_locked': 'str', 'anchor_allow_white_space_in_characters': 'str', 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 'anchor_case_sensitive': 'str', 'anchor_case_sensitive_metadata': 'PropertyMetadata', 'anchor_horizontal_alignment': 'str', 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 'anchor_ignore_if_not_present': 'str', 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 'anchor_match_whole_word': 'str', 'anchor_match_whole_word_metadata': 'PropertyMetadata', 'anchor_string': 'str', 'anchor_string_metadata': 'PropertyMetadata', 'anchor_tab_processor_version': 'str', 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 'anchor_units': 'str', 'anchor_units_metadata': 'PropertyMetadata', 'anchor_x_offset': 'str', 'anchor_x_offset_metadata': 'PropertyMetadata', 'anchor_y_offset': 'str', 'anchor_y_offset_metadata': 'PropertyMetadata', 'caption': 'str', 'caption_metadata': 'PropertyMetadata', 'conditional_parent_label': 'str', 'conditional_parent_label_metadata': 'PropertyMetadata', 'conditional_parent_value': 'str', 'conditional_parent_value_metadata': 'PropertyMetadata', 'connected_object_details': 'ConnectedObjectDetails', 'custom_tab_id': 'str', 'custom_tab_id_metadata': 'PropertyMetadata', 'document_id': 'str', 'document_id_metadata': 'PropertyMetadata', 'error_details': 'ErrorDetails', 'extension_data': 'ExtensionData', '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', 'group_label': 'str', 'group_label_metadata': 'PropertyMetadata', 'group_rule': 'str', 'group_rule_metadata': 'PropertyMetadata', 'height': 'str', 'height_metadata': 'PropertyMetadata', 'maximum_allowed': 'str', 'maximum_allowed_metadata': 'PropertyMetadata', 'merge_field': 'MergeField', 'merge_field_xml': 'str', 'minimum_required': 'str', 'minimum_required_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', 'smart_contract_information': 'SmartContractInformation', 'source': 'str', 'status': 'str', 'status_metadata': 'PropertyMetadata', 'tab_fully_qualified_path': 'str', 'tab_group_labels': 'list[str]', 'tab_group_labels_metadata': 'PropertyMetadata', 'tab_id': 'str', 'tab_id_metadata': 'PropertyMetadata', 'tab_order': 'str', 'tab_order_metadata': 'PropertyMetadata', 'tab_scope': 'str', 'tab_scope_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', 'validation_message': 'str', 'validation_message_metadata': 'PropertyMetadata', 'warning_details': 'ErrorDetails', 'width': 'str', 'width_metadata': 'PropertyMetadata', 'x_position': 'str', 'x_position_metadata': 'PropertyMetadata', 'y_position': 'str', 'y_position_metadata': 'PropertyMetadata'}
attribute_map = {'agreement_attribute': 'agreementAttribute', 'agreement_attribute_locked': 'agreementAttributeLocked', 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive': 'anchorCaseSensitive', 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word': 'anchorMatchWholeWord', 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 'anchor_string': 'anchorString', 'anchor_string_metadata': 'anchorStringMetadata', 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 'anchor_units': 'anchorUnits', 'anchor_units_metadata': 'anchorUnitsMetadata', 'anchor_x_offset': 'anchorXOffset', 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 'anchor_y_offset': 'anchorYOffset', 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 'caption': 'caption', 'caption_metadata': 'captionMetadata', 'conditional_parent_label': 'conditionalParentLabel', 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 'conditional_parent_value': 'conditionalParentValue', 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 'connected_object_details': 'connectedObjectDetails', 'custom_tab_id': 'customTabId', 'custom_tab_id_metadata': 'customTabIdMetadata', 'document_id': 'documentId', 'document_id_metadata': 'documentIdMetadata', 'error_details': 'errorDetails', 'extension_data': 'extensionData', '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', 'group_label': 'groupLabel', 'group_label_metadata': 'groupLabelMetadata', 'group_rule': 'groupRule', 'group_rule_metadata': 'groupRuleMetadata', 'height': 'height', 'height_metadata': 'heightMetadata', 'maximum_allowed': 'maximumAllowed', 'maximum_allowed_metadata': 'maximumAllowedMetadata', 'merge_field': 'mergeField', 'merge_field_xml': 'mergeFieldXml', 'minimum_required': 'minimumRequired', 'minimum_required_metadata': 'minimumRequiredMetadata', 'page_number': 'pageNumber', 'page_number_metadata': 'pageNumberMetadata', 'recipient_id': 'recipientId', 'recipient_id_guid': 'recipientIdGuid', 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 'recipient_id_metadata': 'recipientIdMetadata', 'smart_contract_information': 'smartContractInformation', 'source': 'source', 'status': 'status', 'status_metadata': 'statusMetadata', 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 'tab_group_labels': 'tabGroupLabels', 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 'tab_id': 'tabId', 'tab_id_metadata': 'tabIdMetadata', 'tab_order': 'tabOrder', 'tab_order_metadata': 'tabOrderMetadata', 'tab_scope': 'tabScope', 'tab_scope_metadata': 'tabScopeMetadata', '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', 'validation_message': 'validationMessage', 'validation_message_metadata': 'validationMessageMetadata', 'warning_details': 'warningDetails', 'width': 'width', 'width_metadata': 'widthMetadata', 'x_position': 'xPosition', 'x_position_metadata': 'xPositionMetadata', 'y_position': 'yPosition', 'y_position_metadata': 'yPositionMetadata'}
agreement_attribute
Gets the agreement_attribute of this TabGroup. # noqa: E501
# noqa: E501
Returns
The agreement_attribute of this TabGroup. # noqa: E501
agreement_attribute_locked
Gets the agreement_attribute_locked of this TabGroup. # noqa: E501
# noqa: E501
Returns
The agreement_attribute_locked of this TabGroup. # noqa: E501
anchor_allow_white_space_in_characters
Gets the anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501
# noqa: E501
Returns
The anchor_allow_white_space_in_characters of this TabGroup. # noqa: E501
anchor_allow_white_space_in_characters_metadata
Gets the anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable. # noqa: E501
Returns
The anchor_allow_white_space_in_characters_metadata of this TabGroup. # noqa: E501
anchor_case_sensitive
Gets the anchor_case_sensitive of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_case_sensitive_metadata
Gets the anchor_case_sensitive_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorCaseSensitive property is editable. # noqa: E501
Returns
The anchor_case_sensitive_metadata of this TabGroup. # noqa: E501
anchor_horizontal_alignment
Gets the anchor_horizontal_alignment of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_horizontal_alignment_metadata
Gets the anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorHorizontalAlignment property is editable. # noqa: E501
Returns
The anchor_horizontal_alignment_metadata of this TabGroup. # noqa: E501
anchor_ignore_if_not_present
Gets the anchor_ignore_if_not_present of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_ignore_if_not_present_metadata
Gets the anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable. # noqa: E501
Returns
The anchor_ignore_if_not_present_metadata of this TabGroup. # noqa: E501
anchor_match_whole_word
Gets the anchor_match_whole_word of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_match_whole_word_metadata
Gets the anchor_match_whole_word_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorMatchWholeWord property is editable. # noqa: E501
Returns
The anchor_match_whole_word_metadata of this TabGroup. # noqa: E501
anchor_string
Gets the anchor_string of this TabGroup. # noqa: E501
Anchor text information for a radio button. # noqa: E501
Returns
The anchor_string of this TabGroup. # noqa: E501
anchor_string_metadata
Gets the anchor_string_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorString property is editable. # noqa: E501
Returns
The anchor_string_metadata of this TabGroup. # noqa: E501
anchor_tab_processor_version
Gets the anchor_tab_processor_version of this TabGroup. # noqa: E501
# noqa: E501
Returns
The anchor_tab_processor_version of this TabGroup. # noqa: E501
anchor_tab_processor_version_metadata
Gets the anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The anchor_tab_processor_version_metadata of this TabGroup. # noqa: E501
anchor_units
Gets the anchor_units of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_units_metadata
Gets the anchor_units_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorUnits property is editable. # noqa: E501
Returns
The anchor_units_metadata of this TabGroup. # noqa: E501
anchor_x_offset
Gets the anchor_x_offset of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_x_offset_metadata
Gets the anchor_x_offset_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorXOffset property is editable. # noqa: E501
Returns
The anchor_x_offset_metadata of this TabGroup. # noqa: E501
anchor_y_offset
Gets the anchor_y_offset of this TabGroup. # 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 TabGroup. # noqa: E501
anchor_y_offset_metadata
Gets the anchor_y_offset_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the anchorYOffset property is editable. # noqa: E501
Returns
The anchor_y_offset_metadata of this TabGroup. # noqa: E501
caption
Gets the caption of this TabGroup. # noqa: E501
# noqa: E501
Returns
The caption of this TabGroup. # noqa: E501
caption_metadata
Gets the caption_metadata of this TabGroup. # noqa: E501
# noqa: E501
Returns
The caption_metadata of this TabGroup. # noqa: E501
conditional_parent_label
Gets the conditional_parent_label of this TabGroup. # 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 TabGroup. # noqa: E501
conditional_parent_label_metadata
Gets the conditional_parent_label_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the conditionalParentLabel property is editable. # noqa: E501
Returns
The conditional_parent_label_metadata of this TabGroup. # noqa: E501
conditional_parent_value
Gets the conditional_parent_value of this TabGroup. # 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 TabGroup. # noqa: E501
conditional_parent_value_metadata
Gets the conditional_parent_value_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the conditionalParentValue property is editable. # noqa: E501
Returns
The conditional_parent_value_metadata of this TabGroup. # noqa: E501
connected_object_details
Gets the connected_object_details of this TabGroup. # noqa: E501
# noqa: E501
Returns
The connected_object_details of this TabGroup. # noqa: E501
custom_tab_id
Gets the custom_tab_id of this TabGroup. # 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 TabGroup. # noqa: E501
custom_tab_id_metadata
Gets the custom_tab_id_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the customTabId property is editable. # noqa: E501
Returns
The custom_tab_id_metadata of this TabGroup. # noqa: E501
document_id
Gets the document_id of this TabGroup. # 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 TabGroup. # noqa: E501
document_id_metadata
Gets the document_id_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the documentId property is editable. # noqa: E501
Returns
The document_id_metadata of this TabGroup. # noqa: E501
error_details
Gets the error_details of this TabGroup. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this TabGroup. # noqa: E501
extension_data
Gets the extension_data of this TabGroup. # noqa: E501
# noqa: E501
Returns
The extension_data of this TabGroup. # noqa: E501
form_order
Gets the form_order of this TabGroup. # noqa: E501
# noqa: E501
Returns
The form_order of this TabGroup. # noqa: E501
form_order_metadata
Gets the form_order_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the formOrder property is editable. # noqa: E501
Returns
The form_order_metadata of this TabGroup. # noqa: E501
form_page_label
Gets the form_page_label of this TabGroup. # noqa: E501
# noqa: E501
Returns
The form_page_label of this TabGroup. # noqa: E501
form_page_label_metadata
Gets the form_page_label_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the formPageLabel property is editable. # noqa: E501
Returns
The form_page_label_metadata of this TabGroup. # noqa: E501
form_page_number
Gets the form_page_number of this TabGroup. # noqa: E501
# noqa: E501
Returns
The form_page_number of this TabGroup. # noqa: E501
form_page_number_metadata
Gets the form_page_number_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the fromPageNumber property is editable. # noqa: E501
Returns
The form_page_number_metadata of this TabGroup. # noqa: E501
group_label
Gets the group_label of this TabGroup. # noqa: E501
# noqa: E501
Returns
The group_label of this TabGroup. # noqa: E501
group_label_metadata
Gets the group_label_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the groupLabel property is editable. # noqa: E501
Returns
The group_label_metadata of this TabGroup. # noqa: E501
group_rule
Gets the group_rule of this TabGroup. # noqa: E501
# noqa: E501
Returns
The group_rule of this TabGroup. # noqa: E501
group_rule_metadata
Gets the group_rule_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the groupRule property is editable. # noqa: E501
Returns
The group_rule_metadata of this TabGroup. # noqa: E501
height
Gets the height of this TabGroup. # noqa: E501
Height of the tab in pixels. # noqa: E501
Returns
The height of this TabGroup. # noqa: E501
height_metadata
Gets the height_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the height property is editable. # noqa: E501
Returns
The height_metadata of this TabGroup. # noqa: E501
maximum_allowed
Gets the maximum_allowed of this TabGroup. # noqa: E501
# noqa: E501
Returns
The maximum_allowed of this TabGroup. # noqa: E501
maximum_allowed_metadata
Gets the maximum_allowed_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the maximumAllowed property is editable. # noqa: E501
Returns
The maximum_allowed_metadata of this TabGroup. # noqa: E501
merge_field
Gets the merge_field of this TabGroup. # noqa: E501
Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501
Returns
The merge_field of this TabGroup. # noqa: E501
merge_field_xml
Gets the merge_field_xml of this TabGroup. # noqa: E501
# noqa: E501
Returns
The merge_field_xml of this TabGroup. # noqa: E501
minimum_required
Gets the minimum_required of this TabGroup. # noqa: E501
# noqa: E501
Returns
The minimum_required of this TabGroup. # noqa: E501
minimum_required_metadata
Gets the minimum_required_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the minimumRequired property is editable. # noqa: E501
Returns
The minimum_required_metadata of this TabGroup. # noqa: E501
page_number
Gets the page_number of this TabGroup. # noqa: E501
Specifies the page number on which the tab is located. # noqa: E501
Returns
The page_number of this TabGroup. # noqa: E501
page_number_metadata
Gets the page_number_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the pageNumber property is editable. # noqa: E501
Returns
The page_number_metadata of this TabGroup. # noqa: E501
recipient_id
Gets the recipient_id of this TabGroup. # 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 TabGroup. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this TabGroup. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this TabGroup. # noqa: E501
recipient_id_guid_metadata
Gets the recipient_id_guid_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the recipientIdGuid property is editable. # noqa: E501
Returns
The recipient_id_guid_metadata of this TabGroup. # noqa: E501
recipient_id_metadata
Gets the recipient_id_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the recipientId property is editable. # noqa: E501
Returns
The recipient_id_metadata of this TabGroup. # noqa: E501
smart_contract_information
Gets the smart_contract_information of this TabGroup. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The smart_contract_information of this TabGroup. # noqa: E501
source
Gets the source of this TabGroup. # noqa: E501
# noqa: E501
Returns
The source of this TabGroup. # noqa: E501
status
Gets the status of this TabGroup. # 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 TabGroup. # noqa: E501
status_metadata
Gets the status_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the status property is editable. # noqa: E501
Returns
The status_metadata of this TabGroup. # noqa: E501
tab_fully_qualified_path
Gets the tab_fully_qualified_path of this TabGroup. # noqa: E501
# noqa: E501
Returns
The tab_fully_qualified_path of this TabGroup. # noqa: E501
tab_group_labels
Gets the tab_group_labels of this TabGroup. # noqa: E501
# noqa: E501
Returns
The tab_group_labels of this TabGroup. # noqa: E501
tab_group_labels_metadata
Gets the tab_group_labels_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the tabGroupLabels property is editable. # noqa: E501
Returns
The tab_group_labels_metadata of this TabGroup. # noqa: E501
tab_id
Gets the tab_id of this TabGroup. # 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 TabGroup. # noqa: E501
tab_id_metadata
Gets the tab_id_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the tabId property is editable. # noqa: E501
Returns
The tab_id_metadata of this TabGroup. # noqa: E501
tab_order
Gets the tab_order of this TabGroup. # noqa: E501
# noqa: E501
Returns
The tab_order of this TabGroup. # noqa: E501
tab_order_metadata
Gets the tab_order_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the tabOrder property is editable. # noqa: E501
Returns
The tab_order_metadata of this TabGroup. # noqa: E501
tab_scope
Gets the tab_scope of this TabGroup. # noqa: E501
# noqa: E501
Returns
The tab_scope of this TabGroup. # noqa: E501
tab_scope_metadata
Gets the tab_scope_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the tabScope property is editable. # noqa: E501
Returns
The tab_scope_metadata of this TabGroup. # noqa: E501
tab_type
Gets the tab_type of this TabGroup. # noqa: E501
# noqa: E501
Returns
The tab_type of this TabGroup. # noqa: E501
tab_type_metadata
Gets the tab_type_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the tabType property is editable. # noqa: E501
Returns
The tab_type_metadata of this TabGroup. # noqa: E501
template_locked
Gets the template_locked of this TabGroup. # 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 TabGroup. # noqa: E501
template_locked_metadata
Gets the template_locked_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the templateLocked property is editable. # noqa: E501
Returns
The template_locked_metadata of this TabGroup. # noqa: E501
template_required
Gets the template_required of this TabGroup. # 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 TabGroup. # noqa: E501
template_required_metadata
Gets the template_required_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the templateRequired property is editable. # noqa: E501
Returns
The template_required_metadata of this TabGroup. # noqa: E501
tooltip
Gets the tooltip of this TabGroup. # noqa: E501
# noqa: E501
Returns
The tooltip of this TabGroup. # noqa: E501
tool_tip_metadata
Gets the tool_tip_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the toolTip property is editable. # noqa: E501
Returns
The tool_tip_metadata of this TabGroup. # noqa: E501
validation_message
Gets the validation_message of this TabGroup. # noqa: E501
The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501
Returns
The validation_message of this TabGroup. # noqa: E501
validation_message_metadata
Gets the validation_message_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the validationMessage property is editable. # noqa: E501
Returns
The validation_message_metadata of this TabGroup. # noqa: E501
warning_details
Gets the warning_details of this TabGroup. # noqa: E501
# noqa: E501
Returns
The warning_details of this TabGroup. # noqa: E501
width
Gets the width of this TabGroup. # noqa: E501
Width of the tab in pixels. # noqa: E501
Returns
The width of this TabGroup. # noqa: E501
width_metadata
Gets the width_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the width property is editable. # noqa: E501
Returns
The width_metadata of this TabGroup. # noqa: E501
x_position
Gets the x_position of this TabGroup. # 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 TabGroup. # noqa: E501
x_position_metadata
Gets the x_position_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the xPosition property is editable. # noqa: E501
Returns
The x_position_metadata of this TabGroup. # noqa: E501
y_position
Gets the y_position of this TabGroup. # 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 TabGroup. # noqa: E501
y_position_metadata
Gets the y_position_metadata of this TabGroup. # noqa: E501
Metadata that indicates whether the yPosition property is editable. # noqa: E501
Returns
The y_position_metadata of this TabGroup. # noqa: E501
def
to_dict(self)
2454 def to_dict(self): 2455 """Returns the model properties as a dict""" 2456 result = {} 2457 2458 for attr, _ in six.iteritems(self.swagger_types): 2459 value = getattr(self, attr) 2460 if isinstance(value, list): 2461 result[attr] = list(map( 2462 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2463 value 2464 )) 2465 elif hasattr(value, "to_dict"): 2466 result[attr] = value.to_dict() 2467 elif isinstance(value, dict): 2468 result[attr] = dict(map( 2469 lambda item: (item[0], item[1].to_dict()) 2470 if hasattr(item[1], "to_dict") else item, 2471 value.items() 2472 )) 2473 else: 2474 result[attr] = value 2475 if issubclass(TabGroup, dict): 2476 for key, value in self.items(): 2477 result[key] = value 2478 2479 return result
Returns the model properties as a dict