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