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