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