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