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