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