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