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