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