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