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