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