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