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 # noqa: E501 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 # noqa: E501 885 886 :param caption_metadata: The caption_metadata of this SignHere. # noqa: E501 887 :type: PropertyMetadata 888 """ 889 890 self._caption_metadata = caption_metadata 891 892 @property 893 def conditional_parent_label(self): 894 """Gets the conditional_parent_label of this SignHere. # noqa: E501 895 896 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 897 898 :return: The conditional_parent_label of this SignHere. # noqa: E501 899 :rtype: str 900 """ 901 return self._conditional_parent_label 902 903 @conditional_parent_label.setter 904 def conditional_parent_label(self, conditional_parent_label): 905 """Sets the conditional_parent_label of this SignHere. 906 907 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 908 909 :param conditional_parent_label: The conditional_parent_label of this SignHere. # noqa: E501 910 :type: str 911 """ 912 913 self._conditional_parent_label = conditional_parent_label 914 915 @property 916 def conditional_parent_label_metadata(self): 917 """Gets the conditional_parent_label_metadata of this SignHere. # noqa: E501 918 919 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 920 921 :return: The conditional_parent_label_metadata of this SignHere. # noqa: E501 922 :rtype: PropertyMetadata 923 """ 924 return self._conditional_parent_label_metadata 925 926 @conditional_parent_label_metadata.setter 927 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 928 """Sets the conditional_parent_label_metadata of this SignHere. 929 930 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 931 932 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this SignHere. # noqa: E501 933 :type: PropertyMetadata 934 """ 935 936 self._conditional_parent_label_metadata = conditional_parent_label_metadata 937 938 @property 939 def conditional_parent_value(self): 940 """Gets the conditional_parent_value of this SignHere. # noqa: E501 941 942 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 943 944 :return: The conditional_parent_value of this SignHere. # noqa: E501 945 :rtype: str 946 """ 947 return self._conditional_parent_value 948 949 @conditional_parent_value.setter 950 def conditional_parent_value(self, conditional_parent_value): 951 """Sets the conditional_parent_value of this SignHere. 952 953 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 954 955 :param conditional_parent_value: The conditional_parent_value of this SignHere. # noqa: E501 956 :type: str 957 """ 958 959 self._conditional_parent_value = conditional_parent_value 960 961 @property 962 def conditional_parent_value_metadata(self): 963 """Gets the conditional_parent_value_metadata of this SignHere. # noqa: E501 964 965 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 966 967 :return: The conditional_parent_value_metadata of this SignHere. # noqa: E501 968 :rtype: PropertyMetadata 969 """ 970 return self._conditional_parent_value_metadata 971 972 @conditional_parent_value_metadata.setter 973 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 974 """Sets the conditional_parent_value_metadata of this SignHere. 975 976 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 977 978 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this SignHere. # noqa: E501 979 :type: PropertyMetadata 980 """ 981 982 self._conditional_parent_value_metadata = conditional_parent_value_metadata 983 984 @property 985 def custom_tab_id(self): 986 """Gets the custom_tab_id of this SignHere. # noqa: E501 987 988 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 989 990 :return: The custom_tab_id of this SignHere. # noqa: E501 991 :rtype: str 992 """ 993 return self._custom_tab_id 994 995 @custom_tab_id.setter 996 def custom_tab_id(self, custom_tab_id): 997 """Sets the custom_tab_id of this SignHere. 998 999 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 1000 1001 :param custom_tab_id: The custom_tab_id of this SignHere. # noqa: E501 1002 :type: str 1003 """ 1004 1005 self._custom_tab_id = custom_tab_id 1006 1007 @property 1008 def custom_tab_id_metadata(self): 1009 """Gets the custom_tab_id_metadata of this SignHere. # noqa: E501 1010 1011 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1012 1013 :return: The custom_tab_id_metadata of this SignHere. # noqa: E501 1014 :rtype: PropertyMetadata 1015 """ 1016 return self._custom_tab_id_metadata 1017 1018 @custom_tab_id_metadata.setter 1019 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1020 """Sets the custom_tab_id_metadata of this SignHere. 1021 1022 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1023 1024 :param custom_tab_id_metadata: The custom_tab_id_metadata of this SignHere. # noqa: E501 1025 :type: PropertyMetadata 1026 """ 1027 1028 self._custom_tab_id_metadata = custom_tab_id_metadata 1029 1030 @property 1031 def document_id(self): 1032 """Gets the document_id of this SignHere. # noqa: E501 1033 1034 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1035 1036 :return: The document_id of this SignHere. # noqa: E501 1037 :rtype: str 1038 """ 1039 return self._document_id 1040 1041 @document_id.setter 1042 def document_id(self, document_id): 1043 """Sets the document_id of this SignHere. 1044 1045 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1046 1047 :param document_id: The document_id of this SignHere. # noqa: E501 1048 :type: str 1049 """ 1050 1051 self._document_id = document_id 1052 1053 @property 1054 def document_id_metadata(self): 1055 """Gets the document_id_metadata of this SignHere. # noqa: E501 1056 1057 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1058 1059 :return: The document_id_metadata of this SignHere. # noqa: E501 1060 :rtype: PropertyMetadata 1061 """ 1062 return self._document_id_metadata 1063 1064 @document_id_metadata.setter 1065 def document_id_metadata(self, document_id_metadata): 1066 """Sets the document_id_metadata of this SignHere. 1067 1068 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1069 1070 :param document_id_metadata: The document_id_metadata of this SignHere. # noqa: E501 1071 :type: PropertyMetadata 1072 """ 1073 1074 self._document_id_metadata = document_id_metadata 1075 1076 @property 1077 def error_details(self): 1078 """Gets the error_details of this SignHere. # noqa: E501 1079 1080 Array or errors. # noqa: E501 1081 1082 :return: The error_details of this SignHere. # noqa: E501 1083 :rtype: ErrorDetails 1084 """ 1085 return self._error_details 1086 1087 @error_details.setter 1088 def error_details(self, error_details): 1089 """Sets the error_details of this SignHere. 1090 1091 Array or errors. # noqa: E501 1092 1093 :param error_details: The error_details of this SignHere. # noqa: E501 1094 :type: ErrorDetails 1095 """ 1096 1097 self._error_details = error_details 1098 1099 @property 1100 def form_order(self): 1101 """Gets the form_order of this SignHere. # noqa: E501 1102 1103 # noqa: E501 1104 1105 :return: The form_order of this SignHere. # noqa: E501 1106 :rtype: str 1107 """ 1108 return self._form_order 1109 1110 @form_order.setter 1111 def form_order(self, form_order): 1112 """Sets the form_order of this SignHere. 1113 1114 # noqa: E501 1115 1116 :param form_order: The form_order of this SignHere. # noqa: E501 1117 :type: str 1118 """ 1119 1120 self._form_order = form_order 1121 1122 @property 1123 def form_order_metadata(self): 1124 """Gets the form_order_metadata of this SignHere. # noqa: E501 1125 1126 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1127 1128 :return: The form_order_metadata of this SignHere. # noqa: E501 1129 :rtype: PropertyMetadata 1130 """ 1131 return self._form_order_metadata 1132 1133 @form_order_metadata.setter 1134 def form_order_metadata(self, form_order_metadata): 1135 """Sets the form_order_metadata of this SignHere. 1136 1137 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1138 1139 :param form_order_metadata: The form_order_metadata of this SignHere. # noqa: E501 1140 :type: PropertyMetadata 1141 """ 1142 1143 self._form_order_metadata = form_order_metadata 1144 1145 @property 1146 def form_page_label(self): 1147 """Gets the form_page_label of this SignHere. # noqa: E501 1148 1149 # noqa: E501 1150 1151 :return: The form_page_label of this SignHere. # noqa: E501 1152 :rtype: str 1153 """ 1154 return self._form_page_label 1155 1156 @form_page_label.setter 1157 def form_page_label(self, form_page_label): 1158 """Sets the form_page_label of this SignHere. 1159 1160 # noqa: E501 1161 1162 :param form_page_label: The form_page_label of this SignHere. # noqa: E501 1163 :type: str 1164 """ 1165 1166 self._form_page_label = form_page_label 1167 1168 @property 1169 def form_page_label_metadata(self): 1170 """Gets the form_page_label_metadata of this SignHere. # noqa: E501 1171 1172 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1173 1174 :return: The form_page_label_metadata of this SignHere. # noqa: E501 1175 :rtype: PropertyMetadata 1176 """ 1177 return self._form_page_label_metadata 1178 1179 @form_page_label_metadata.setter 1180 def form_page_label_metadata(self, form_page_label_metadata): 1181 """Sets the form_page_label_metadata of this SignHere. 1182 1183 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1184 1185 :param form_page_label_metadata: The form_page_label_metadata of this SignHere. # noqa: E501 1186 :type: PropertyMetadata 1187 """ 1188 1189 self._form_page_label_metadata = form_page_label_metadata 1190 1191 @property 1192 def form_page_number(self): 1193 """Gets the form_page_number of this SignHere. # noqa: E501 1194 1195 # noqa: E501 1196 1197 :return: The form_page_number of this SignHere. # noqa: E501 1198 :rtype: str 1199 """ 1200 return self._form_page_number 1201 1202 @form_page_number.setter 1203 def form_page_number(self, form_page_number): 1204 """Sets the form_page_number of this SignHere. 1205 1206 # noqa: E501 1207 1208 :param form_page_number: The form_page_number of this SignHere. # noqa: E501 1209 :type: str 1210 """ 1211 1212 self._form_page_number = form_page_number 1213 1214 @property 1215 def form_page_number_metadata(self): 1216 """Gets the form_page_number_metadata of this SignHere. # noqa: E501 1217 1218 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1219 1220 :return: The form_page_number_metadata of this SignHere. # noqa: E501 1221 :rtype: PropertyMetadata 1222 """ 1223 return self._form_page_number_metadata 1224 1225 @form_page_number_metadata.setter 1226 def form_page_number_metadata(self, form_page_number_metadata): 1227 """Sets the form_page_number_metadata of this SignHere. 1228 1229 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1230 1231 :param form_page_number_metadata: The form_page_number_metadata of this SignHere. # noqa: E501 1232 :type: PropertyMetadata 1233 """ 1234 1235 self._form_page_number_metadata = form_page_number_metadata 1236 1237 @property 1238 def hand_draw_required(self): 1239 """Gets the hand_draw_required of this SignHere. # noqa: E501 1240 1241 # noqa: E501 1242 1243 :return: The hand_draw_required of this SignHere. # noqa: E501 1244 :rtype: str 1245 """ 1246 return self._hand_draw_required 1247 1248 @hand_draw_required.setter 1249 def hand_draw_required(self, hand_draw_required): 1250 """Sets the hand_draw_required of this SignHere. 1251 1252 # noqa: E501 1253 1254 :param hand_draw_required: The hand_draw_required of this SignHere. # noqa: E501 1255 :type: str 1256 """ 1257 1258 self._hand_draw_required = hand_draw_required 1259 1260 @property 1261 def height(self): 1262 """Gets the height of this SignHere. # noqa: E501 1263 1264 Height of the tab in pixels. # noqa: E501 1265 1266 :return: The height of this SignHere. # noqa: E501 1267 :rtype: str 1268 """ 1269 return self._height 1270 1271 @height.setter 1272 def height(self, height): 1273 """Sets the height of this SignHere. 1274 1275 Height of the tab in pixels. # noqa: E501 1276 1277 :param height: The height of this SignHere. # noqa: E501 1278 :type: str 1279 """ 1280 1281 self._height = height 1282 1283 @property 1284 def height_metadata(self): 1285 """Gets the height_metadata of this SignHere. # noqa: E501 1286 1287 Metadata that indicates whether the `height` property is editable. # noqa: E501 1288 1289 :return: The height_metadata of this SignHere. # noqa: E501 1290 :rtype: PropertyMetadata 1291 """ 1292 return self._height_metadata 1293 1294 @height_metadata.setter 1295 def height_metadata(self, height_metadata): 1296 """Sets the height_metadata of this SignHere. 1297 1298 Metadata that indicates whether the `height` property is editable. # noqa: E501 1299 1300 :param height_metadata: The height_metadata of this SignHere. # noqa: E501 1301 :type: PropertyMetadata 1302 """ 1303 1304 self._height_metadata = height_metadata 1305 1306 @property 1307 def is_seal_sign_tab(self): 1308 """Gets the is_seal_sign_tab of this SignHere. # noqa: E501 1309 1310 # noqa: E501 1311 1312 :return: The is_seal_sign_tab of this SignHere. # noqa: E501 1313 :rtype: str 1314 """ 1315 return self._is_seal_sign_tab 1316 1317 @is_seal_sign_tab.setter 1318 def is_seal_sign_tab(self, is_seal_sign_tab): 1319 """Sets the is_seal_sign_tab of this SignHere. 1320 1321 # noqa: E501 1322 1323 :param is_seal_sign_tab: The is_seal_sign_tab of this SignHere. # noqa: E501 1324 :type: str 1325 """ 1326 1327 self._is_seal_sign_tab = is_seal_sign_tab 1328 1329 @property 1330 def merge_field(self): 1331 """Gets the merge_field of this SignHere. # noqa: E501 1332 1333 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1334 1335 :return: The merge_field of this SignHere. # noqa: E501 1336 :rtype: MergeField 1337 """ 1338 return self._merge_field 1339 1340 @merge_field.setter 1341 def merge_field(self, merge_field): 1342 """Sets the merge_field of this SignHere. 1343 1344 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1345 1346 :param merge_field: The merge_field of this SignHere. # noqa: E501 1347 :type: MergeField 1348 """ 1349 1350 self._merge_field = merge_field 1351 1352 @property 1353 def merge_field_xml(self): 1354 """Gets the merge_field_xml of this SignHere. # noqa: E501 1355 1356 # noqa: E501 1357 1358 :return: The merge_field_xml of this SignHere. # noqa: E501 1359 :rtype: str 1360 """ 1361 return self._merge_field_xml 1362 1363 @merge_field_xml.setter 1364 def merge_field_xml(self, merge_field_xml): 1365 """Sets the merge_field_xml of this SignHere. 1366 1367 # noqa: E501 1368 1369 :param merge_field_xml: The merge_field_xml of this SignHere. # noqa: E501 1370 :type: str 1371 """ 1372 1373 self._merge_field_xml = merge_field_xml 1374 1375 @property 1376 def name(self): 1377 """Gets the name of this SignHere. # noqa: E501 1378 1379 Specifies the tool tip text for the tab. # noqa: E501 1380 1381 :return: The name of this SignHere. # noqa: E501 1382 :rtype: str 1383 """ 1384 return self._name 1385 1386 @name.setter 1387 def name(self, name): 1388 """Sets the name of this SignHere. 1389 1390 Specifies the tool tip text for the tab. # noqa: E501 1391 1392 :param name: The name of this SignHere. # noqa: E501 1393 :type: str 1394 """ 1395 1396 self._name = name 1397 1398 @property 1399 def name_metadata(self): 1400 """Gets the name_metadata of this SignHere. # noqa: E501 1401 1402 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1403 1404 :return: The name_metadata of this SignHere. # noqa: E501 1405 :rtype: PropertyMetadata 1406 """ 1407 return self._name_metadata 1408 1409 @name_metadata.setter 1410 def name_metadata(self, name_metadata): 1411 """Sets the name_metadata of this SignHere. 1412 1413 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1414 1415 :param name_metadata: The name_metadata of this SignHere. # noqa: E501 1416 :type: PropertyMetadata 1417 """ 1418 1419 self._name_metadata = name_metadata 1420 1421 @property 1422 def optional(self): 1423 """Gets the optional of this SignHere. # noqa: E501 1424 1425 # noqa: E501 1426 1427 :return: The optional of this SignHere. # noqa: E501 1428 :rtype: str 1429 """ 1430 return self._optional 1431 1432 @optional.setter 1433 def optional(self, optional): 1434 """Sets the optional of this SignHere. 1435 1436 # noqa: E501 1437 1438 :param optional: The optional of this SignHere. # noqa: E501 1439 :type: str 1440 """ 1441 1442 self._optional = optional 1443 1444 @property 1445 def optional_metadata(self): 1446 """Gets the optional_metadata of this SignHere. # noqa: E501 1447 1448 Metadata that indicates whether the `optional` property is editable. # noqa: E501 1449 1450 :return: The optional_metadata of this SignHere. # noqa: E501 1451 :rtype: PropertyMetadata 1452 """ 1453 return self._optional_metadata 1454 1455 @optional_metadata.setter 1456 def optional_metadata(self, optional_metadata): 1457 """Sets the optional_metadata of this SignHere. 1458 1459 Metadata that indicates whether the `optional` property is editable. # noqa: E501 1460 1461 :param optional_metadata: The optional_metadata of this SignHere. # noqa: E501 1462 :type: PropertyMetadata 1463 """ 1464 1465 self._optional_metadata = optional_metadata 1466 1467 @property 1468 def page_number(self): 1469 """Gets the page_number of this SignHere. # noqa: E501 1470 1471 Specifies the page number on which the tab is located. # noqa: E501 1472 1473 :return: The page_number of this SignHere. # noqa: E501 1474 :rtype: str 1475 """ 1476 return self._page_number 1477 1478 @page_number.setter 1479 def page_number(self, page_number): 1480 """Sets the page_number of this SignHere. 1481 1482 Specifies the page number on which the tab is located. # noqa: E501 1483 1484 :param page_number: The page_number of this SignHere. # noqa: E501 1485 :type: str 1486 """ 1487 1488 self._page_number = page_number 1489 1490 @property 1491 def page_number_metadata(self): 1492 """Gets the page_number_metadata of this SignHere. # noqa: E501 1493 1494 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1495 1496 :return: The page_number_metadata of this SignHere. # noqa: E501 1497 :rtype: PropertyMetadata 1498 """ 1499 return self._page_number_metadata 1500 1501 @page_number_metadata.setter 1502 def page_number_metadata(self, page_number_metadata): 1503 """Sets the page_number_metadata of this SignHere. 1504 1505 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1506 1507 :param page_number_metadata: The page_number_metadata of this SignHere. # noqa: E501 1508 :type: PropertyMetadata 1509 """ 1510 1511 self._page_number_metadata = page_number_metadata 1512 1513 @property 1514 def recipient_id(self): 1515 """Gets the recipient_id of this SignHere. # noqa: E501 1516 1517 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1518 1519 :return: The recipient_id of this SignHere. # noqa: E501 1520 :rtype: str 1521 """ 1522 return self._recipient_id 1523 1524 @recipient_id.setter 1525 def recipient_id(self, recipient_id): 1526 """Sets the recipient_id of this SignHere. 1527 1528 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1529 1530 :param recipient_id: The recipient_id of this SignHere. # noqa: E501 1531 :type: str 1532 """ 1533 1534 self._recipient_id = recipient_id 1535 1536 @property 1537 def recipient_id_guid(self): 1538 """Gets the recipient_id_guid of this SignHere. # noqa: E501 1539 1540 # noqa: E501 1541 1542 :return: The recipient_id_guid of this SignHere. # noqa: E501 1543 :rtype: str 1544 """ 1545 return self._recipient_id_guid 1546 1547 @recipient_id_guid.setter 1548 def recipient_id_guid(self, recipient_id_guid): 1549 """Sets the recipient_id_guid of this SignHere. 1550 1551 # noqa: E501 1552 1553 :param recipient_id_guid: The recipient_id_guid of this SignHere. # noqa: E501 1554 :type: str 1555 """ 1556 1557 self._recipient_id_guid = recipient_id_guid 1558 1559 @property 1560 def recipient_id_guid_metadata(self): 1561 """Gets the recipient_id_guid_metadata of this SignHere. # noqa: E501 1562 1563 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1564 1565 :return: The recipient_id_guid_metadata of this SignHere. # noqa: E501 1566 :rtype: PropertyMetadata 1567 """ 1568 return self._recipient_id_guid_metadata 1569 1570 @recipient_id_guid_metadata.setter 1571 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 1572 """Sets the recipient_id_guid_metadata of this SignHere. 1573 1574 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1575 1576 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this SignHere. # noqa: E501 1577 :type: PropertyMetadata 1578 """ 1579 1580 self._recipient_id_guid_metadata = recipient_id_guid_metadata 1581 1582 @property 1583 def recipient_id_metadata(self): 1584 """Gets the recipient_id_metadata of this SignHere. # noqa: E501 1585 1586 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1587 1588 :return: The recipient_id_metadata of this SignHere. # noqa: E501 1589 :rtype: PropertyMetadata 1590 """ 1591 return self._recipient_id_metadata 1592 1593 @recipient_id_metadata.setter 1594 def recipient_id_metadata(self, recipient_id_metadata): 1595 """Sets the recipient_id_metadata of this SignHere. 1596 1597 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1598 1599 :param recipient_id_metadata: The recipient_id_metadata of this SignHere. # noqa: E501 1600 :type: PropertyMetadata 1601 """ 1602 1603 self._recipient_id_metadata = recipient_id_metadata 1604 1605 @property 1606 def scale_value(self): 1607 """Gets the scale_value of this SignHere. # noqa: E501 1608 1609 # noqa: E501 1610 1611 :return: The scale_value of this SignHere. # noqa: E501 1612 :rtype: str 1613 """ 1614 return self._scale_value 1615 1616 @scale_value.setter 1617 def scale_value(self, scale_value): 1618 """Sets the scale_value of this SignHere. 1619 1620 # noqa: E501 1621 1622 :param scale_value: The scale_value of this SignHere. # noqa: E501 1623 :type: str 1624 """ 1625 1626 self._scale_value = scale_value 1627 1628 @property 1629 def scale_value_metadata(self): 1630 """Gets the scale_value_metadata of this SignHere. # noqa: E501 1631 1632 Metadata that indicates whether the `scaleValue` property is editable. # noqa: E501 1633 1634 :return: The scale_value_metadata of this SignHere. # noqa: E501 1635 :rtype: PropertyMetadata 1636 """ 1637 return self._scale_value_metadata 1638 1639 @scale_value_metadata.setter 1640 def scale_value_metadata(self, scale_value_metadata): 1641 """Sets the scale_value_metadata of this SignHere. 1642 1643 Metadata that indicates whether the `scaleValue` property is editable. # noqa: E501 1644 1645 :param scale_value_metadata: The scale_value_metadata of this SignHere. # noqa: E501 1646 :type: PropertyMetadata 1647 """ 1648 1649 self._scale_value_metadata = scale_value_metadata 1650 1651 @property 1652 def smart_contract_information(self): 1653 """Gets the smart_contract_information of this SignHere. # noqa: E501 1654 1655 Reserved for DocuSign. # noqa: E501 1656 1657 :return: The smart_contract_information of this SignHere. # noqa: E501 1658 :rtype: SmartContractInformation 1659 """ 1660 return self._smart_contract_information 1661 1662 @smart_contract_information.setter 1663 def smart_contract_information(self, smart_contract_information): 1664 """Sets the smart_contract_information of this SignHere. 1665 1666 Reserved for DocuSign. # noqa: E501 1667 1668 :param smart_contract_information: The smart_contract_information of this SignHere. # noqa: E501 1669 :type: SmartContractInformation 1670 """ 1671 1672 self._smart_contract_information = smart_contract_information 1673 1674 @property 1675 def source(self): 1676 """Gets the source of this SignHere. # noqa: E501 1677 1678 # noqa: E501 1679 1680 :return: The source of this SignHere. # noqa: E501 1681 :rtype: str 1682 """ 1683 return self._source 1684 1685 @source.setter 1686 def source(self, source): 1687 """Sets the source of this SignHere. 1688 1689 # noqa: E501 1690 1691 :param source: The source of this SignHere. # noqa: E501 1692 :type: str 1693 """ 1694 1695 self._source = source 1696 1697 @property 1698 def stamp(self): 1699 """Gets the stamp of this SignHere. # noqa: E501 1700 1701 # noqa: E501 1702 1703 :return: The stamp of this SignHere. # noqa: E501 1704 :rtype: Stamp 1705 """ 1706 return self._stamp 1707 1708 @stamp.setter 1709 def stamp(self, stamp): 1710 """Sets the stamp of this SignHere. 1711 1712 # noqa: E501 1713 1714 :param stamp: The stamp of this SignHere. # noqa: E501 1715 :type: Stamp 1716 """ 1717 1718 self._stamp = stamp 1719 1720 @property 1721 def stamp_type(self): 1722 """Gets the stamp_type of this SignHere. # noqa: E501 1723 1724 # noqa: E501 1725 1726 :return: The stamp_type of this SignHere. # noqa: E501 1727 :rtype: str 1728 """ 1729 return self._stamp_type 1730 1731 @stamp_type.setter 1732 def stamp_type(self, stamp_type): 1733 """Sets the stamp_type of this SignHere. 1734 1735 # noqa: E501 1736 1737 :param stamp_type: The stamp_type of this SignHere. # noqa: E501 1738 :type: str 1739 """ 1740 1741 self._stamp_type = stamp_type 1742 1743 @property 1744 def stamp_type_metadata(self): 1745 """Gets the stamp_type_metadata of this SignHere. # noqa: E501 1746 1747 Metadata that indicates whether the `stampType` property is editable. # noqa: E501 1748 1749 :return: The stamp_type_metadata of this SignHere. # noqa: E501 1750 :rtype: PropertyMetadata 1751 """ 1752 return self._stamp_type_metadata 1753 1754 @stamp_type_metadata.setter 1755 def stamp_type_metadata(self, stamp_type_metadata): 1756 """Sets the stamp_type_metadata of this SignHere. 1757 1758 Metadata that indicates whether the `stampType` property is editable. # noqa: E501 1759 1760 :param stamp_type_metadata: The stamp_type_metadata of this SignHere. # noqa: E501 1761 :type: PropertyMetadata 1762 """ 1763 1764 self._stamp_type_metadata = stamp_type_metadata 1765 1766 @property 1767 def status(self): 1768 """Gets the status of this SignHere. # noqa: E501 1769 1770 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 1771 1772 :return: The status of this SignHere. # noqa: E501 1773 :rtype: str 1774 """ 1775 return self._status 1776 1777 @status.setter 1778 def status(self, status): 1779 """Sets the status of this SignHere. 1780 1781 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 1782 1783 :param status: The status of this SignHere. # noqa: E501 1784 :type: str 1785 """ 1786 1787 self._status = status 1788 1789 @property 1790 def status_metadata(self): 1791 """Gets the status_metadata of this SignHere. # noqa: E501 1792 1793 Metadata that indicates whether the `status` property is editable. # noqa: E501 1794 1795 :return: The status_metadata of this SignHere. # noqa: E501 1796 :rtype: PropertyMetadata 1797 """ 1798 return self._status_metadata 1799 1800 @status_metadata.setter 1801 def status_metadata(self, status_metadata): 1802 """Sets the status_metadata of this SignHere. 1803 1804 Metadata that indicates whether the `status` property is editable. # noqa: E501 1805 1806 :param status_metadata: The status_metadata of this SignHere. # noqa: E501 1807 :type: PropertyMetadata 1808 """ 1809 1810 self._status_metadata = status_metadata 1811 1812 @property 1813 def tab_group_labels(self): 1814 """Gets the tab_group_labels of this SignHere. # noqa: E501 1815 1816 # noqa: E501 1817 1818 :return: The tab_group_labels of this SignHere. # noqa: E501 1819 :rtype: list[str] 1820 """ 1821 return self._tab_group_labels 1822 1823 @tab_group_labels.setter 1824 def tab_group_labels(self, tab_group_labels): 1825 """Sets the tab_group_labels of this SignHere. 1826 1827 # noqa: E501 1828 1829 :param tab_group_labels: The tab_group_labels of this SignHere. # noqa: E501 1830 :type: list[str] 1831 """ 1832 1833 self._tab_group_labels = tab_group_labels 1834 1835 @property 1836 def tab_group_labels_metadata(self): 1837 """Gets the tab_group_labels_metadata of this SignHere. # noqa: E501 1838 1839 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1840 1841 :return: The tab_group_labels_metadata of this SignHere. # noqa: E501 1842 :rtype: PropertyMetadata 1843 """ 1844 return self._tab_group_labels_metadata 1845 1846 @tab_group_labels_metadata.setter 1847 def tab_group_labels_metadata(self, tab_group_labels_metadata): 1848 """Sets the tab_group_labels_metadata of this SignHere. 1849 1850 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1851 1852 :param tab_group_labels_metadata: The tab_group_labels_metadata of this SignHere. # noqa: E501 1853 :type: PropertyMetadata 1854 """ 1855 1856 self._tab_group_labels_metadata = tab_group_labels_metadata 1857 1858 @property 1859 def tab_id(self): 1860 """Gets the tab_id of this SignHere. # noqa: E501 1861 1862 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1863 1864 :return: The tab_id of this SignHere. # noqa: E501 1865 :rtype: str 1866 """ 1867 return self._tab_id 1868 1869 @tab_id.setter 1870 def tab_id(self, tab_id): 1871 """Sets the tab_id of this SignHere. 1872 1873 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1874 1875 :param tab_id: The tab_id of this SignHere. # noqa: E501 1876 :type: str 1877 """ 1878 1879 self._tab_id = tab_id 1880 1881 @property 1882 def tab_id_metadata(self): 1883 """Gets the tab_id_metadata of this SignHere. # noqa: E501 1884 1885 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1886 1887 :return: The tab_id_metadata of this SignHere. # noqa: E501 1888 :rtype: PropertyMetadata 1889 """ 1890 return self._tab_id_metadata 1891 1892 @tab_id_metadata.setter 1893 def tab_id_metadata(self, tab_id_metadata): 1894 """Sets the tab_id_metadata of this SignHere. 1895 1896 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1897 1898 :param tab_id_metadata: The tab_id_metadata of this SignHere. # noqa: E501 1899 :type: PropertyMetadata 1900 """ 1901 1902 self._tab_id_metadata = tab_id_metadata 1903 1904 @property 1905 def tab_label(self): 1906 """Gets the tab_label of this SignHere. # noqa: E501 1907 1908 The label string associated with the tab. # noqa: E501 1909 1910 :return: The tab_label of this SignHere. # noqa: E501 1911 :rtype: str 1912 """ 1913 return self._tab_label 1914 1915 @tab_label.setter 1916 def tab_label(self, tab_label): 1917 """Sets the tab_label of this SignHere. 1918 1919 The label string associated with the tab. # noqa: E501 1920 1921 :param tab_label: The tab_label of this SignHere. # noqa: E501 1922 :type: str 1923 """ 1924 1925 self._tab_label = tab_label 1926 1927 @property 1928 def tab_label_metadata(self): 1929 """Gets the tab_label_metadata of this SignHere. # noqa: E501 1930 1931 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 1932 1933 :return: The tab_label_metadata of this SignHere. # noqa: E501 1934 :rtype: PropertyMetadata 1935 """ 1936 return self._tab_label_metadata 1937 1938 @tab_label_metadata.setter 1939 def tab_label_metadata(self, tab_label_metadata): 1940 """Sets the tab_label_metadata of this SignHere. 1941 1942 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 1943 1944 :param tab_label_metadata: The tab_label_metadata of this SignHere. # noqa: E501 1945 :type: PropertyMetadata 1946 """ 1947 1948 self._tab_label_metadata = tab_label_metadata 1949 1950 @property 1951 def tab_order(self): 1952 """Gets the tab_order of this SignHere. # noqa: E501 1953 1954 # noqa: E501 1955 1956 :return: The tab_order of this SignHere. # noqa: E501 1957 :rtype: str 1958 """ 1959 return self._tab_order 1960 1961 @tab_order.setter 1962 def tab_order(self, tab_order): 1963 """Sets the tab_order of this SignHere. 1964 1965 # noqa: E501 1966 1967 :param tab_order: The tab_order of this SignHere. # noqa: E501 1968 :type: str 1969 """ 1970 1971 self._tab_order = tab_order 1972 1973 @property 1974 def tab_order_metadata(self): 1975 """Gets the tab_order_metadata of this SignHere. # noqa: E501 1976 1977 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 1978 1979 :return: The tab_order_metadata of this SignHere. # noqa: E501 1980 :rtype: PropertyMetadata 1981 """ 1982 return self._tab_order_metadata 1983 1984 @tab_order_metadata.setter 1985 def tab_order_metadata(self, tab_order_metadata): 1986 """Sets the tab_order_metadata of this SignHere. 1987 1988 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 1989 1990 :param tab_order_metadata: The tab_order_metadata of this SignHere. # noqa: E501 1991 :type: PropertyMetadata 1992 """ 1993 1994 self._tab_order_metadata = tab_order_metadata 1995 1996 @property 1997 def tab_type(self): 1998 """Gets the tab_type of this SignHere. # noqa: E501 1999 2000 # noqa: E501 2001 2002 :return: The tab_type of this SignHere. # noqa: E501 2003 :rtype: str 2004 """ 2005 return self._tab_type 2006 2007 @tab_type.setter 2008 def tab_type(self, tab_type): 2009 """Sets the tab_type of this SignHere. 2010 2011 # noqa: E501 2012 2013 :param tab_type: The tab_type of this SignHere. # noqa: E501 2014 :type: str 2015 """ 2016 2017 self._tab_type = tab_type 2018 2019 @property 2020 def tab_type_metadata(self): 2021 """Gets the tab_type_metadata of this SignHere. # noqa: E501 2022 2023 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2024 2025 :return: The tab_type_metadata of this SignHere. # noqa: E501 2026 :rtype: PropertyMetadata 2027 """ 2028 return self._tab_type_metadata 2029 2030 @tab_type_metadata.setter 2031 def tab_type_metadata(self, tab_type_metadata): 2032 """Sets the tab_type_metadata of this SignHere. 2033 2034 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2035 2036 :param tab_type_metadata: The tab_type_metadata of this SignHere. # noqa: E501 2037 :type: PropertyMetadata 2038 """ 2039 2040 self._tab_type_metadata = tab_type_metadata 2041 2042 @property 2043 def template_locked(self): 2044 """Gets the template_locked of this SignHere. # noqa: E501 2045 2046 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2047 2048 :return: The template_locked of this SignHere. # noqa: E501 2049 :rtype: str 2050 """ 2051 return self._template_locked 2052 2053 @template_locked.setter 2054 def template_locked(self, template_locked): 2055 """Sets the template_locked of this SignHere. 2056 2057 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2058 2059 :param template_locked: The template_locked of this SignHere. # noqa: E501 2060 :type: str 2061 """ 2062 2063 self._template_locked = template_locked 2064 2065 @property 2066 def template_locked_metadata(self): 2067 """Gets the template_locked_metadata of this SignHere. # noqa: E501 2068 2069 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2070 2071 :return: The template_locked_metadata of this SignHere. # noqa: E501 2072 :rtype: PropertyMetadata 2073 """ 2074 return self._template_locked_metadata 2075 2076 @template_locked_metadata.setter 2077 def template_locked_metadata(self, template_locked_metadata): 2078 """Sets the template_locked_metadata of this SignHere. 2079 2080 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2081 2082 :param template_locked_metadata: The template_locked_metadata of this SignHere. # noqa: E501 2083 :type: PropertyMetadata 2084 """ 2085 2086 self._template_locked_metadata = template_locked_metadata 2087 2088 @property 2089 def template_required(self): 2090 """Gets the template_required of this SignHere. # noqa: E501 2091 2092 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2093 2094 :return: The template_required of this SignHere. # noqa: E501 2095 :rtype: str 2096 """ 2097 return self._template_required 2098 2099 @template_required.setter 2100 def template_required(self, template_required): 2101 """Sets the template_required of this SignHere. 2102 2103 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2104 2105 :param template_required: The template_required of this SignHere. # noqa: E501 2106 :type: str 2107 """ 2108 2109 self._template_required = template_required 2110 2111 @property 2112 def template_required_metadata(self): 2113 """Gets the template_required_metadata of this SignHere. # noqa: E501 2114 2115 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2116 2117 :return: The template_required_metadata of this SignHere. # noqa: E501 2118 :rtype: PropertyMetadata 2119 """ 2120 return self._template_required_metadata 2121 2122 @template_required_metadata.setter 2123 def template_required_metadata(self, template_required_metadata): 2124 """Sets the template_required_metadata of this SignHere. 2125 2126 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2127 2128 :param template_required_metadata: The template_required_metadata of this SignHere. # noqa: E501 2129 :type: PropertyMetadata 2130 """ 2131 2132 self._template_required_metadata = template_required_metadata 2133 2134 @property 2135 def tooltip(self): 2136 """Gets the tooltip of this SignHere. # noqa: E501 2137 2138 # noqa: E501 2139 2140 :return: The tooltip of this SignHere. # noqa: E501 2141 :rtype: str 2142 """ 2143 return self._tooltip 2144 2145 @tooltip.setter 2146 def tooltip(self, tooltip): 2147 """Sets the tooltip of this SignHere. 2148 2149 # noqa: E501 2150 2151 :param tooltip: The tooltip of this SignHere. # noqa: E501 2152 :type: str 2153 """ 2154 2155 self._tooltip = tooltip 2156 2157 @property 2158 def tool_tip_metadata(self): 2159 """Gets the tool_tip_metadata of this SignHere. # noqa: E501 2160 2161 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2162 2163 :return: The tool_tip_metadata of this SignHere. # noqa: E501 2164 :rtype: PropertyMetadata 2165 """ 2166 return self._tool_tip_metadata 2167 2168 @tool_tip_metadata.setter 2169 def tool_tip_metadata(self, tool_tip_metadata): 2170 """Sets the tool_tip_metadata of this SignHere. 2171 2172 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2173 2174 :param tool_tip_metadata: The tool_tip_metadata of this SignHere. # noqa: E501 2175 :type: PropertyMetadata 2176 """ 2177 2178 self._tool_tip_metadata = tool_tip_metadata 2179 2180 @property 2181 def width(self): 2182 """Gets the width of this SignHere. # noqa: E501 2183 2184 Width of the tab in pixels. # noqa: E501 2185 2186 :return: The width of this SignHere. # noqa: E501 2187 :rtype: str 2188 """ 2189 return self._width 2190 2191 @width.setter 2192 def width(self, width): 2193 """Sets the width of this SignHere. 2194 2195 Width of the tab in pixels. # noqa: E501 2196 2197 :param width: The width of this SignHere. # noqa: E501 2198 :type: str 2199 """ 2200 2201 self._width = width 2202 2203 @property 2204 def width_metadata(self): 2205 """Gets the width_metadata of this SignHere. # noqa: E501 2206 2207 Metadata that indicates whether the `width` property is editable. # noqa: E501 2208 2209 :return: The width_metadata of this SignHere. # noqa: E501 2210 :rtype: PropertyMetadata 2211 """ 2212 return self._width_metadata 2213 2214 @width_metadata.setter 2215 def width_metadata(self, width_metadata): 2216 """Sets the width_metadata of this SignHere. 2217 2218 Metadata that indicates whether the `width` property is editable. # noqa: E501 2219 2220 :param width_metadata: The width_metadata of this SignHere. # noqa: E501 2221 :type: PropertyMetadata 2222 """ 2223 2224 self._width_metadata = width_metadata 2225 2226 @property 2227 def x_position(self): 2228 """Gets the x_position of this SignHere. # noqa: E501 2229 2230 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2231 2232 :return: The x_position of this SignHere. # noqa: E501 2233 :rtype: str 2234 """ 2235 return self._x_position 2236 2237 @x_position.setter 2238 def x_position(self, x_position): 2239 """Sets the x_position of this SignHere. 2240 2241 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2242 2243 :param x_position: The x_position of this SignHere. # noqa: E501 2244 :type: str 2245 """ 2246 2247 self._x_position = x_position 2248 2249 @property 2250 def x_position_metadata(self): 2251 """Gets the x_position_metadata of this SignHere. # noqa: E501 2252 2253 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2254 2255 :return: The x_position_metadata of this SignHere. # noqa: E501 2256 :rtype: PropertyMetadata 2257 """ 2258 return self._x_position_metadata 2259 2260 @x_position_metadata.setter 2261 def x_position_metadata(self, x_position_metadata): 2262 """Sets the x_position_metadata of this SignHere. 2263 2264 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2265 2266 :param x_position_metadata: The x_position_metadata of this SignHere. # noqa: E501 2267 :type: PropertyMetadata 2268 """ 2269 2270 self._x_position_metadata = x_position_metadata 2271 2272 @property 2273 def y_position(self): 2274 """Gets the y_position of this SignHere. # noqa: E501 2275 2276 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2277 2278 :return: The y_position of this SignHere. # noqa: E501 2279 :rtype: str 2280 """ 2281 return self._y_position 2282 2283 @y_position.setter 2284 def y_position(self, y_position): 2285 """Sets the y_position of this SignHere. 2286 2287 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2288 2289 :param y_position: The y_position of this SignHere. # noqa: E501 2290 :type: str 2291 """ 2292 2293 self._y_position = y_position 2294 2295 @property 2296 def y_position_metadata(self): 2297 """Gets the y_position_metadata of this SignHere. # noqa: E501 2298 2299 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2300 2301 :return: The y_position_metadata of this SignHere. # noqa: E501 2302 :rtype: PropertyMetadata 2303 """ 2304 return self._y_position_metadata 2305 2306 @y_position_metadata.setter 2307 def y_position_metadata(self, y_position_metadata): 2308 """Sets the y_position_metadata of this SignHere. 2309 2310 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2311 2312 :param y_position_metadata: The y_position_metadata of this SignHere. # noqa: E501 2313 :type: PropertyMetadata 2314 """ 2315 2316 self._y_position_metadata = y_position_metadata 2317 2318 def to_dict(self): 2319 """Returns the model properties as a dict""" 2320 result = {} 2321 2322 for attr, _ in six.iteritems(self.swagger_types): 2323 value = getattr(self, attr) 2324 if isinstance(value, list): 2325 result[attr] = list(map( 2326 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2327 value 2328 )) 2329 elif hasattr(value, "to_dict"): 2330 result[attr] = value.to_dict() 2331 elif isinstance(value, dict): 2332 result[attr] = dict(map( 2333 lambda item: (item[0], item[1].to_dict()) 2334 if hasattr(item[1], "to_dict") else item, 2335 value.items() 2336 )) 2337 else: 2338 result[attr] = value 2339 if issubclass(SignHere, dict): 2340 for key, value in self.items(): 2341 result[key] = value 2342 2343 return result 2344 2345 def to_str(self): 2346 """Returns the string representation of the model""" 2347 return pprint.pformat(self.to_dict()) 2348 2349 def __repr__(self): 2350 """For `print` and `pprint`""" 2351 return self.to_str() 2352 2353 def __eq__(self, other): 2354 """Returns true if both objects are equal""" 2355 if not isinstance(other, SignHere): 2356 return False 2357 2358 return self.to_dict() == other.to_dict() 2359 2360 def __ne__(self, other): 2361 """Returns true if both objects are not equal""" 2362 if not isinstance(other, SignHere): 2363 return True 2364 2365 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 # noqa: E501 875 876 :return: The caption_metadata of this SignHere. # noqa: E501 877 :rtype: PropertyMetadata 878 """ 879 return self._caption_metadata 880 881 @caption_metadata.setter 882 def caption_metadata(self, caption_metadata): 883 """Sets the caption_metadata of this SignHere. 884 885 # noqa: E501 886 887 :param caption_metadata: The caption_metadata of this SignHere. # noqa: E501 888 :type: PropertyMetadata 889 """ 890 891 self._caption_metadata = caption_metadata 892 893 @property 894 def conditional_parent_label(self): 895 """Gets the conditional_parent_label of this SignHere. # noqa: E501 896 897 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 898 899 :return: The conditional_parent_label of this SignHere. # noqa: E501 900 :rtype: str 901 """ 902 return self._conditional_parent_label 903 904 @conditional_parent_label.setter 905 def conditional_parent_label(self, conditional_parent_label): 906 """Sets the conditional_parent_label of this SignHere. 907 908 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 909 910 :param conditional_parent_label: The conditional_parent_label of this SignHere. # noqa: E501 911 :type: str 912 """ 913 914 self._conditional_parent_label = conditional_parent_label 915 916 @property 917 def conditional_parent_label_metadata(self): 918 """Gets the conditional_parent_label_metadata of this SignHere. # noqa: E501 919 920 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 921 922 :return: The conditional_parent_label_metadata of this SignHere. # noqa: E501 923 :rtype: PropertyMetadata 924 """ 925 return self._conditional_parent_label_metadata 926 927 @conditional_parent_label_metadata.setter 928 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 929 """Sets the conditional_parent_label_metadata of this SignHere. 930 931 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 932 933 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this SignHere. # noqa: E501 934 :type: PropertyMetadata 935 """ 936 937 self._conditional_parent_label_metadata = conditional_parent_label_metadata 938 939 @property 940 def conditional_parent_value(self): 941 """Gets the conditional_parent_value of this SignHere. # noqa: E501 942 943 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 944 945 :return: The conditional_parent_value of this SignHere. # noqa: E501 946 :rtype: str 947 """ 948 return self._conditional_parent_value 949 950 @conditional_parent_value.setter 951 def conditional_parent_value(self, conditional_parent_value): 952 """Sets the conditional_parent_value of this SignHere. 953 954 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 955 956 :param conditional_parent_value: The conditional_parent_value of this SignHere. # noqa: E501 957 :type: str 958 """ 959 960 self._conditional_parent_value = conditional_parent_value 961 962 @property 963 def conditional_parent_value_metadata(self): 964 """Gets the conditional_parent_value_metadata of this SignHere. # noqa: E501 965 966 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 967 968 :return: The conditional_parent_value_metadata of this SignHere. # noqa: E501 969 :rtype: PropertyMetadata 970 """ 971 return self._conditional_parent_value_metadata 972 973 @conditional_parent_value_metadata.setter 974 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 975 """Sets the conditional_parent_value_metadata of this SignHere. 976 977 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 978 979 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this SignHere. # noqa: E501 980 :type: PropertyMetadata 981 """ 982 983 self._conditional_parent_value_metadata = conditional_parent_value_metadata 984 985 @property 986 def custom_tab_id(self): 987 """Gets the custom_tab_id of this SignHere. # noqa: E501 988 989 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 990 991 :return: The custom_tab_id of this SignHere. # noqa: E501 992 :rtype: str 993 """ 994 return self._custom_tab_id 995 996 @custom_tab_id.setter 997 def custom_tab_id(self, custom_tab_id): 998 """Sets the custom_tab_id of this SignHere. 999 1000 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 1001 1002 :param custom_tab_id: The custom_tab_id of this SignHere. # noqa: E501 1003 :type: str 1004 """ 1005 1006 self._custom_tab_id = custom_tab_id 1007 1008 @property 1009 def custom_tab_id_metadata(self): 1010 """Gets the custom_tab_id_metadata of this SignHere. # noqa: E501 1011 1012 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1013 1014 :return: The custom_tab_id_metadata of this SignHere. # noqa: E501 1015 :rtype: PropertyMetadata 1016 """ 1017 return self._custom_tab_id_metadata 1018 1019 @custom_tab_id_metadata.setter 1020 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1021 """Sets the custom_tab_id_metadata of this SignHere. 1022 1023 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1024 1025 :param custom_tab_id_metadata: The custom_tab_id_metadata of this SignHere. # noqa: E501 1026 :type: PropertyMetadata 1027 """ 1028 1029 self._custom_tab_id_metadata = custom_tab_id_metadata 1030 1031 @property 1032 def document_id(self): 1033 """Gets the document_id of this SignHere. # noqa: E501 1034 1035 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1036 1037 :return: The document_id of this SignHere. # noqa: E501 1038 :rtype: str 1039 """ 1040 return self._document_id 1041 1042 @document_id.setter 1043 def document_id(self, document_id): 1044 """Sets the document_id of this SignHere. 1045 1046 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1047 1048 :param document_id: The document_id of this SignHere. # noqa: E501 1049 :type: str 1050 """ 1051 1052 self._document_id = document_id 1053 1054 @property 1055 def document_id_metadata(self): 1056 """Gets the document_id_metadata of this SignHere. # noqa: E501 1057 1058 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1059 1060 :return: The document_id_metadata of this SignHere. # noqa: E501 1061 :rtype: PropertyMetadata 1062 """ 1063 return self._document_id_metadata 1064 1065 @document_id_metadata.setter 1066 def document_id_metadata(self, document_id_metadata): 1067 """Sets the document_id_metadata of this SignHere. 1068 1069 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1070 1071 :param document_id_metadata: The document_id_metadata of this SignHere. # noqa: E501 1072 :type: PropertyMetadata 1073 """ 1074 1075 self._document_id_metadata = document_id_metadata 1076 1077 @property 1078 def error_details(self): 1079 """Gets the error_details of this SignHere. # noqa: E501 1080 1081 Array or errors. # noqa: E501 1082 1083 :return: The error_details of this SignHere. # noqa: E501 1084 :rtype: ErrorDetails 1085 """ 1086 return self._error_details 1087 1088 @error_details.setter 1089 def error_details(self, error_details): 1090 """Sets the error_details of this SignHere. 1091 1092 Array or errors. # noqa: E501 1093 1094 :param error_details: The error_details of this SignHere. # noqa: E501 1095 :type: ErrorDetails 1096 """ 1097 1098 self._error_details = error_details 1099 1100 @property 1101 def form_order(self): 1102 """Gets the form_order of this SignHere. # noqa: E501 1103 1104 # noqa: E501 1105 1106 :return: The form_order of this SignHere. # noqa: E501 1107 :rtype: str 1108 """ 1109 return self._form_order 1110 1111 @form_order.setter 1112 def form_order(self, form_order): 1113 """Sets the form_order of this SignHere. 1114 1115 # noqa: E501 1116 1117 :param form_order: The form_order of this SignHere. # noqa: E501 1118 :type: str 1119 """ 1120 1121 self._form_order = form_order 1122 1123 @property 1124 def form_order_metadata(self): 1125 """Gets the form_order_metadata of this SignHere. # noqa: E501 1126 1127 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1128 1129 :return: The form_order_metadata of this SignHere. # noqa: E501 1130 :rtype: PropertyMetadata 1131 """ 1132 return self._form_order_metadata 1133 1134 @form_order_metadata.setter 1135 def form_order_metadata(self, form_order_metadata): 1136 """Sets the form_order_metadata of this SignHere. 1137 1138 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1139 1140 :param form_order_metadata: The form_order_metadata of this SignHere. # noqa: E501 1141 :type: PropertyMetadata 1142 """ 1143 1144 self._form_order_metadata = form_order_metadata 1145 1146 @property 1147 def form_page_label(self): 1148 """Gets the form_page_label of this SignHere. # noqa: E501 1149 1150 # noqa: E501 1151 1152 :return: The form_page_label of this SignHere. # noqa: E501 1153 :rtype: str 1154 """ 1155 return self._form_page_label 1156 1157 @form_page_label.setter 1158 def form_page_label(self, form_page_label): 1159 """Sets the form_page_label of this SignHere. 1160 1161 # noqa: E501 1162 1163 :param form_page_label: The form_page_label of this SignHere. # noqa: E501 1164 :type: str 1165 """ 1166 1167 self._form_page_label = form_page_label 1168 1169 @property 1170 def form_page_label_metadata(self): 1171 """Gets the form_page_label_metadata of this SignHere. # noqa: E501 1172 1173 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1174 1175 :return: The form_page_label_metadata of this SignHere. # noqa: E501 1176 :rtype: PropertyMetadata 1177 """ 1178 return self._form_page_label_metadata 1179 1180 @form_page_label_metadata.setter 1181 def form_page_label_metadata(self, form_page_label_metadata): 1182 """Sets the form_page_label_metadata of this SignHere. 1183 1184 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1185 1186 :param form_page_label_metadata: The form_page_label_metadata of this SignHere. # noqa: E501 1187 :type: PropertyMetadata 1188 """ 1189 1190 self._form_page_label_metadata = form_page_label_metadata 1191 1192 @property 1193 def form_page_number(self): 1194 """Gets the form_page_number of this SignHere. # noqa: E501 1195 1196 # noqa: E501 1197 1198 :return: The form_page_number of this SignHere. # noqa: E501 1199 :rtype: str 1200 """ 1201 return self._form_page_number 1202 1203 @form_page_number.setter 1204 def form_page_number(self, form_page_number): 1205 """Sets the form_page_number of this SignHere. 1206 1207 # noqa: E501 1208 1209 :param form_page_number: The form_page_number of this SignHere. # noqa: E501 1210 :type: str 1211 """ 1212 1213 self._form_page_number = form_page_number 1214 1215 @property 1216 def form_page_number_metadata(self): 1217 """Gets the form_page_number_metadata of this SignHere. # noqa: E501 1218 1219 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1220 1221 :return: The form_page_number_metadata of this SignHere. # noqa: E501 1222 :rtype: PropertyMetadata 1223 """ 1224 return self._form_page_number_metadata 1225 1226 @form_page_number_metadata.setter 1227 def form_page_number_metadata(self, form_page_number_metadata): 1228 """Sets the form_page_number_metadata of this SignHere. 1229 1230 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1231 1232 :param form_page_number_metadata: The form_page_number_metadata of this SignHere. # noqa: E501 1233 :type: PropertyMetadata 1234 """ 1235 1236 self._form_page_number_metadata = form_page_number_metadata 1237 1238 @property 1239 def hand_draw_required(self): 1240 """Gets the hand_draw_required of this SignHere. # noqa: E501 1241 1242 # noqa: E501 1243 1244 :return: The hand_draw_required of this SignHere. # noqa: E501 1245 :rtype: str 1246 """ 1247 return self._hand_draw_required 1248 1249 @hand_draw_required.setter 1250 def hand_draw_required(self, hand_draw_required): 1251 """Sets the hand_draw_required of this SignHere. 1252 1253 # noqa: E501 1254 1255 :param hand_draw_required: The hand_draw_required of this SignHere. # noqa: E501 1256 :type: str 1257 """ 1258 1259 self._hand_draw_required = hand_draw_required 1260 1261 @property 1262 def height(self): 1263 """Gets the height of this SignHere. # noqa: E501 1264 1265 Height of the tab in pixels. # noqa: E501 1266 1267 :return: The height of this SignHere. # noqa: E501 1268 :rtype: str 1269 """ 1270 return self._height 1271 1272 @height.setter 1273 def height(self, height): 1274 """Sets the height of this SignHere. 1275 1276 Height of the tab in pixels. # noqa: E501 1277 1278 :param height: The height of this SignHere. # noqa: E501 1279 :type: str 1280 """ 1281 1282 self._height = height 1283 1284 @property 1285 def height_metadata(self): 1286 """Gets the height_metadata of this SignHere. # noqa: E501 1287 1288 Metadata that indicates whether the `height` property is editable. # noqa: E501 1289 1290 :return: The height_metadata of this SignHere. # noqa: E501 1291 :rtype: PropertyMetadata 1292 """ 1293 return self._height_metadata 1294 1295 @height_metadata.setter 1296 def height_metadata(self, height_metadata): 1297 """Sets the height_metadata of this SignHere. 1298 1299 Metadata that indicates whether the `height` property is editable. # noqa: E501 1300 1301 :param height_metadata: The height_metadata of this SignHere. # noqa: E501 1302 :type: PropertyMetadata 1303 """ 1304 1305 self._height_metadata = height_metadata 1306 1307 @property 1308 def is_seal_sign_tab(self): 1309 """Gets the is_seal_sign_tab of this SignHere. # noqa: E501 1310 1311 # noqa: E501 1312 1313 :return: The is_seal_sign_tab of this SignHere. # noqa: E501 1314 :rtype: str 1315 """ 1316 return self._is_seal_sign_tab 1317 1318 @is_seal_sign_tab.setter 1319 def is_seal_sign_tab(self, is_seal_sign_tab): 1320 """Sets the is_seal_sign_tab of this SignHere. 1321 1322 # noqa: E501 1323 1324 :param is_seal_sign_tab: The is_seal_sign_tab of this SignHere. # noqa: E501 1325 :type: str 1326 """ 1327 1328 self._is_seal_sign_tab = is_seal_sign_tab 1329 1330 @property 1331 def merge_field(self): 1332 """Gets the merge_field of this SignHere. # noqa: E501 1333 1334 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1335 1336 :return: The merge_field of this SignHere. # noqa: E501 1337 :rtype: MergeField 1338 """ 1339 return self._merge_field 1340 1341 @merge_field.setter 1342 def merge_field(self, merge_field): 1343 """Sets the merge_field of this SignHere. 1344 1345 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1346 1347 :param merge_field: The merge_field of this SignHere. # noqa: E501 1348 :type: MergeField 1349 """ 1350 1351 self._merge_field = merge_field 1352 1353 @property 1354 def merge_field_xml(self): 1355 """Gets the merge_field_xml of this SignHere. # noqa: E501 1356 1357 # noqa: E501 1358 1359 :return: The merge_field_xml of this SignHere. # noqa: E501 1360 :rtype: str 1361 """ 1362 return self._merge_field_xml 1363 1364 @merge_field_xml.setter 1365 def merge_field_xml(self, merge_field_xml): 1366 """Sets the merge_field_xml of this SignHere. 1367 1368 # noqa: E501 1369 1370 :param merge_field_xml: The merge_field_xml of this SignHere. # noqa: E501 1371 :type: str 1372 """ 1373 1374 self._merge_field_xml = merge_field_xml 1375 1376 @property 1377 def name(self): 1378 """Gets the name of this SignHere. # noqa: E501 1379 1380 Specifies the tool tip text for the tab. # noqa: E501 1381 1382 :return: The name of this SignHere. # noqa: E501 1383 :rtype: str 1384 """ 1385 return self._name 1386 1387 @name.setter 1388 def name(self, name): 1389 """Sets the name of this SignHere. 1390 1391 Specifies the tool tip text for the tab. # noqa: E501 1392 1393 :param name: The name of this SignHere. # noqa: E501 1394 :type: str 1395 """ 1396 1397 self._name = name 1398 1399 @property 1400 def name_metadata(self): 1401 """Gets the name_metadata of this SignHere. # noqa: E501 1402 1403 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1404 1405 :return: The name_metadata of this SignHere. # noqa: E501 1406 :rtype: PropertyMetadata 1407 """ 1408 return self._name_metadata 1409 1410 @name_metadata.setter 1411 def name_metadata(self, name_metadata): 1412 """Sets the name_metadata of this SignHere. 1413 1414 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 1415 1416 :param name_metadata: The name_metadata of this SignHere. # noqa: E501 1417 :type: PropertyMetadata 1418 """ 1419 1420 self._name_metadata = name_metadata 1421 1422 @property 1423 def optional(self): 1424 """Gets the optional of this SignHere. # noqa: E501 1425 1426 # noqa: E501 1427 1428 :return: The optional of this SignHere. # noqa: E501 1429 :rtype: str 1430 """ 1431 return self._optional 1432 1433 @optional.setter 1434 def optional(self, optional): 1435 """Sets the optional of this SignHere. 1436 1437 # noqa: E501 1438 1439 :param optional: The optional of this SignHere. # noqa: E501 1440 :type: str 1441 """ 1442 1443 self._optional = optional 1444 1445 @property 1446 def optional_metadata(self): 1447 """Gets the optional_metadata of this SignHere. # noqa: E501 1448 1449 Metadata that indicates whether the `optional` property is editable. # noqa: E501 1450 1451 :return: The optional_metadata of this SignHere. # noqa: E501 1452 :rtype: PropertyMetadata 1453 """ 1454 return self._optional_metadata 1455 1456 @optional_metadata.setter 1457 def optional_metadata(self, optional_metadata): 1458 """Sets the optional_metadata of this SignHere. 1459 1460 Metadata that indicates whether the `optional` property is editable. # noqa: E501 1461 1462 :param optional_metadata: The optional_metadata of this SignHere. # noqa: E501 1463 :type: PropertyMetadata 1464 """ 1465 1466 self._optional_metadata = optional_metadata 1467 1468 @property 1469 def page_number(self): 1470 """Gets the page_number of this SignHere. # noqa: E501 1471 1472 Specifies the page number on which the tab is located. # noqa: E501 1473 1474 :return: The page_number of this SignHere. # noqa: E501 1475 :rtype: str 1476 """ 1477 return self._page_number 1478 1479 @page_number.setter 1480 def page_number(self, page_number): 1481 """Sets the page_number of this SignHere. 1482 1483 Specifies the page number on which the tab is located. # noqa: E501 1484 1485 :param page_number: The page_number of this SignHere. # noqa: E501 1486 :type: str 1487 """ 1488 1489 self._page_number = page_number 1490 1491 @property 1492 def page_number_metadata(self): 1493 """Gets the page_number_metadata of this SignHere. # noqa: E501 1494 1495 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1496 1497 :return: The page_number_metadata of this SignHere. # noqa: E501 1498 :rtype: PropertyMetadata 1499 """ 1500 return self._page_number_metadata 1501 1502 @page_number_metadata.setter 1503 def page_number_metadata(self, page_number_metadata): 1504 """Sets the page_number_metadata of this SignHere. 1505 1506 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 1507 1508 :param page_number_metadata: The page_number_metadata of this SignHere. # noqa: E501 1509 :type: PropertyMetadata 1510 """ 1511 1512 self._page_number_metadata = page_number_metadata 1513 1514 @property 1515 def recipient_id(self): 1516 """Gets the recipient_id of this SignHere. # noqa: E501 1517 1518 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1519 1520 :return: The recipient_id of this SignHere. # noqa: E501 1521 :rtype: str 1522 """ 1523 return self._recipient_id 1524 1525 @recipient_id.setter 1526 def recipient_id(self, recipient_id): 1527 """Sets the recipient_id of this SignHere. 1528 1529 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 1530 1531 :param recipient_id: The recipient_id of this SignHere. # noqa: E501 1532 :type: str 1533 """ 1534 1535 self._recipient_id = recipient_id 1536 1537 @property 1538 def recipient_id_guid(self): 1539 """Gets the recipient_id_guid of this SignHere. # noqa: E501 1540 1541 # noqa: E501 1542 1543 :return: The recipient_id_guid of this SignHere. # noqa: E501 1544 :rtype: str 1545 """ 1546 return self._recipient_id_guid 1547 1548 @recipient_id_guid.setter 1549 def recipient_id_guid(self, recipient_id_guid): 1550 """Sets the recipient_id_guid of this SignHere. 1551 1552 # noqa: E501 1553 1554 :param recipient_id_guid: The recipient_id_guid of this SignHere. # noqa: E501 1555 :type: str 1556 """ 1557 1558 self._recipient_id_guid = recipient_id_guid 1559 1560 @property 1561 def recipient_id_guid_metadata(self): 1562 """Gets the recipient_id_guid_metadata of this SignHere. # noqa: E501 1563 1564 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1565 1566 :return: The recipient_id_guid_metadata of this SignHere. # noqa: E501 1567 :rtype: PropertyMetadata 1568 """ 1569 return self._recipient_id_guid_metadata 1570 1571 @recipient_id_guid_metadata.setter 1572 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 1573 """Sets the recipient_id_guid_metadata of this SignHere. 1574 1575 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 1576 1577 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this SignHere. # noqa: E501 1578 :type: PropertyMetadata 1579 """ 1580 1581 self._recipient_id_guid_metadata = recipient_id_guid_metadata 1582 1583 @property 1584 def recipient_id_metadata(self): 1585 """Gets the recipient_id_metadata of this SignHere. # noqa: E501 1586 1587 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1588 1589 :return: The recipient_id_metadata of this SignHere. # noqa: E501 1590 :rtype: PropertyMetadata 1591 """ 1592 return self._recipient_id_metadata 1593 1594 @recipient_id_metadata.setter 1595 def recipient_id_metadata(self, recipient_id_metadata): 1596 """Sets the recipient_id_metadata of this SignHere. 1597 1598 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 1599 1600 :param recipient_id_metadata: The recipient_id_metadata of this SignHere. # noqa: E501 1601 :type: PropertyMetadata 1602 """ 1603 1604 self._recipient_id_metadata = recipient_id_metadata 1605 1606 @property 1607 def scale_value(self): 1608 """Gets the scale_value of this SignHere. # noqa: E501 1609 1610 # noqa: E501 1611 1612 :return: The scale_value of this SignHere. # noqa: E501 1613 :rtype: str 1614 """ 1615 return self._scale_value 1616 1617 @scale_value.setter 1618 def scale_value(self, scale_value): 1619 """Sets the scale_value of this SignHere. 1620 1621 # noqa: E501 1622 1623 :param scale_value: The scale_value of this SignHere. # noqa: E501 1624 :type: str 1625 """ 1626 1627 self._scale_value = scale_value 1628 1629 @property 1630 def scale_value_metadata(self): 1631 """Gets the scale_value_metadata of this SignHere. # noqa: E501 1632 1633 Metadata that indicates whether the `scaleValue` property is editable. # noqa: E501 1634 1635 :return: The scale_value_metadata of this SignHere. # noqa: E501 1636 :rtype: PropertyMetadata 1637 """ 1638 return self._scale_value_metadata 1639 1640 @scale_value_metadata.setter 1641 def scale_value_metadata(self, scale_value_metadata): 1642 """Sets the scale_value_metadata of this SignHere. 1643 1644 Metadata that indicates whether the `scaleValue` property is editable. # noqa: E501 1645 1646 :param scale_value_metadata: The scale_value_metadata of this SignHere. # noqa: E501 1647 :type: PropertyMetadata 1648 """ 1649 1650 self._scale_value_metadata = scale_value_metadata 1651 1652 @property 1653 def smart_contract_information(self): 1654 """Gets the smart_contract_information of this SignHere. # noqa: E501 1655 1656 Reserved for DocuSign. # noqa: E501 1657 1658 :return: The smart_contract_information of this SignHere. # noqa: E501 1659 :rtype: SmartContractInformation 1660 """ 1661 return self._smart_contract_information 1662 1663 @smart_contract_information.setter 1664 def smart_contract_information(self, smart_contract_information): 1665 """Sets the smart_contract_information of this SignHere. 1666 1667 Reserved for DocuSign. # noqa: E501 1668 1669 :param smart_contract_information: The smart_contract_information of this SignHere. # noqa: E501 1670 :type: SmartContractInformation 1671 """ 1672 1673 self._smart_contract_information = smart_contract_information 1674 1675 @property 1676 def source(self): 1677 """Gets the source of this SignHere. # noqa: E501 1678 1679 # noqa: E501 1680 1681 :return: The source of this SignHere. # noqa: E501 1682 :rtype: str 1683 """ 1684 return self._source 1685 1686 @source.setter 1687 def source(self, source): 1688 """Sets the source of this SignHere. 1689 1690 # noqa: E501 1691 1692 :param source: The source of this SignHere. # noqa: E501 1693 :type: str 1694 """ 1695 1696 self._source = source 1697 1698 @property 1699 def stamp(self): 1700 """Gets the stamp of this SignHere. # noqa: E501 1701 1702 # noqa: E501 1703 1704 :return: The stamp of this SignHere. # noqa: E501 1705 :rtype: Stamp 1706 """ 1707 return self._stamp 1708 1709 @stamp.setter 1710 def stamp(self, stamp): 1711 """Sets the stamp of this SignHere. 1712 1713 # noqa: E501 1714 1715 :param stamp: The stamp of this SignHere. # noqa: E501 1716 :type: Stamp 1717 """ 1718 1719 self._stamp = stamp 1720 1721 @property 1722 def stamp_type(self): 1723 """Gets the stamp_type of this SignHere. # noqa: E501 1724 1725 # noqa: E501 1726 1727 :return: The stamp_type of this SignHere. # noqa: E501 1728 :rtype: str 1729 """ 1730 return self._stamp_type 1731 1732 @stamp_type.setter 1733 def stamp_type(self, stamp_type): 1734 """Sets the stamp_type of this SignHere. 1735 1736 # noqa: E501 1737 1738 :param stamp_type: The stamp_type of this SignHere. # noqa: E501 1739 :type: str 1740 """ 1741 1742 self._stamp_type = stamp_type 1743 1744 @property 1745 def stamp_type_metadata(self): 1746 """Gets the stamp_type_metadata of this SignHere. # noqa: E501 1747 1748 Metadata that indicates whether the `stampType` property is editable. # noqa: E501 1749 1750 :return: The stamp_type_metadata of this SignHere. # noqa: E501 1751 :rtype: PropertyMetadata 1752 """ 1753 return self._stamp_type_metadata 1754 1755 @stamp_type_metadata.setter 1756 def stamp_type_metadata(self, stamp_type_metadata): 1757 """Sets the stamp_type_metadata of this SignHere. 1758 1759 Metadata that indicates whether the `stampType` property is editable. # noqa: E501 1760 1761 :param stamp_type_metadata: The stamp_type_metadata of this SignHere. # noqa: E501 1762 :type: PropertyMetadata 1763 """ 1764 1765 self._stamp_type_metadata = stamp_type_metadata 1766 1767 @property 1768 def status(self): 1769 """Gets the status of this SignHere. # noqa: E501 1770 1771 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 1772 1773 :return: The status of this SignHere. # noqa: E501 1774 :rtype: str 1775 """ 1776 return self._status 1777 1778 @status.setter 1779 def status(self, status): 1780 """Sets the status of this SignHere. 1781 1782 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 1783 1784 :param status: The status of this SignHere. # noqa: E501 1785 :type: str 1786 """ 1787 1788 self._status = status 1789 1790 @property 1791 def status_metadata(self): 1792 """Gets the status_metadata of this SignHere. # noqa: E501 1793 1794 Metadata that indicates whether the `status` property is editable. # noqa: E501 1795 1796 :return: The status_metadata of this SignHere. # noqa: E501 1797 :rtype: PropertyMetadata 1798 """ 1799 return self._status_metadata 1800 1801 @status_metadata.setter 1802 def status_metadata(self, status_metadata): 1803 """Sets the status_metadata of this SignHere. 1804 1805 Metadata that indicates whether the `status` property is editable. # noqa: E501 1806 1807 :param status_metadata: The status_metadata of this SignHere. # noqa: E501 1808 :type: PropertyMetadata 1809 """ 1810 1811 self._status_metadata = status_metadata 1812 1813 @property 1814 def tab_group_labels(self): 1815 """Gets the tab_group_labels of this SignHere. # noqa: E501 1816 1817 # noqa: E501 1818 1819 :return: The tab_group_labels of this SignHere. # noqa: E501 1820 :rtype: list[str] 1821 """ 1822 return self._tab_group_labels 1823 1824 @tab_group_labels.setter 1825 def tab_group_labels(self, tab_group_labels): 1826 """Sets the tab_group_labels of this SignHere. 1827 1828 # noqa: E501 1829 1830 :param tab_group_labels: The tab_group_labels of this SignHere. # noqa: E501 1831 :type: list[str] 1832 """ 1833 1834 self._tab_group_labels = tab_group_labels 1835 1836 @property 1837 def tab_group_labels_metadata(self): 1838 """Gets the tab_group_labels_metadata of this SignHere. # noqa: E501 1839 1840 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1841 1842 :return: The tab_group_labels_metadata of this SignHere. # noqa: E501 1843 :rtype: PropertyMetadata 1844 """ 1845 return self._tab_group_labels_metadata 1846 1847 @tab_group_labels_metadata.setter 1848 def tab_group_labels_metadata(self, tab_group_labels_metadata): 1849 """Sets the tab_group_labels_metadata of this SignHere. 1850 1851 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 1852 1853 :param tab_group_labels_metadata: The tab_group_labels_metadata of this SignHere. # noqa: E501 1854 :type: PropertyMetadata 1855 """ 1856 1857 self._tab_group_labels_metadata = tab_group_labels_metadata 1858 1859 @property 1860 def tab_id(self): 1861 """Gets the tab_id of this SignHere. # noqa: E501 1862 1863 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1864 1865 :return: The tab_id of this SignHere. # noqa: E501 1866 :rtype: str 1867 """ 1868 return self._tab_id 1869 1870 @tab_id.setter 1871 def tab_id(self, tab_id): 1872 """Sets the tab_id of this SignHere. 1873 1874 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 1875 1876 :param tab_id: The tab_id of this SignHere. # noqa: E501 1877 :type: str 1878 """ 1879 1880 self._tab_id = tab_id 1881 1882 @property 1883 def tab_id_metadata(self): 1884 """Gets the tab_id_metadata of this SignHere. # noqa: E501 1885 1886 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1887 1888 :return: The tab_id_metadata of this SignHere. # noqa: E501 1889 :rtype: PropertyMetadata 1890 """ 1891 return self._tab_id_metadata 1892 1893 @tab_id_metadata.setter 1894 def tab_id_metadata(self, tab_id_metadata): 1895 """Sets the tab_id_metadata of this SignHere. 1896 1897 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 1898 1899 :param tab_id_metadata: The tab_id_metadata of this SignHere. # noqa: E501 1900 :type: PropertyMetadata 1901 """ 1902 1903 self._tab_id_metadata = tab_id_metadata 1904 1905 @property 1906 def tab_label(self): 1907 """Gets the tab_label of this SignHere. # noqa: E501 1908 1909 The label string associated with the tab. # noqa: E501 1910 1911 :return: The tab_label of this SignHere. # noqa: E501 1912 :rtype: str 1913 """ 1914 return self._tab_label 1915 1916 @tab_label.setter 1917 def tab_label(self, tab_label): 1918 """Sets the tab_label of this SignHere. 1919 1920 The label string associated with the tab. # noqa: E501 1921 1922 :param tab_label: The tab_label of this SignHere. # noqa: E501 1923 :type: str 1924 """ 1925 1926 self._tab_label = tab_label 1927 1928 @property 1929 def tab_label_metadata(self): 1930 """Gets the tab_label_metadata of this SignHere. # noqa: E501 1931 1932 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 1933 1934 :return: The tab_label_metadata of this SignHere. # noqa: E501 1935 :rtype: PropertyMetadata 1936 """ 1937 return self._tab_label_metadata 1938 1939 @tab_label_metadata.setter 1940 def tab_label_metadata(self, tab_label_metadata): 1941 """Sets the tab_label_metadata of this SignHere. 1942 1943 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 1944 1945 :param tab_label_metadata: The tab_label_metadata of this SignHere. # noqa: E501 1946 :type: PropertyMetadata 1947 """ 1948 1949 self._tab_label_metadata = tab_label_metadata 1950 1951 @property 1952 def tab_order(self): 1953 """Gets the tab_order of this SignHere. # noqa: E501 1954 1955 # noqa: E501 1956 1957 :return: The tab_order of this SignHere. # noqa: E501 1958 :rtype: str 1959 """ 1960 return self._tab_order 1961 1962 @tab_order.setter 1963 def tab_order(self, tab_order): 1964 """Sets the tab_order of this SignHere. 1965 1966 # noqa: E501 1967 1968 :param tab_order: The tab_order of this SignHere. # noqa: E501 1969 :type: str 1970 """ 1971 1972 self._tab_order = tab_order 1973 1974 @property 1975 def tab_order_metadata(self): 1976 """Gets the tab_order_metadata of this SignHere. # noqa: E501 1977 1978 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 1979 1980 :return: The tab_order_metadata of this SignHere. # noqa: E501 1981 :rtype: PropertyMetadata 1982 """ 1983 return self._tab_order_metadata 1984 1985 @tab_order_metadata.setter 1986 def tab_order_metadata(self, tab_order_metadata): 1987 """Sets the tab_order_metadata of this SignHere. 1988 1989 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 1990 1991 :param tab_order_metadata: The tab_order_metadata of this SignHere. # noqa: E501 1992 :type: PropertyMetadata 1993 """ 1994 1995 self._tab_order_metadata = tab_order_metadata 1996 1997 @property 1998 def tab_type(self): 1999 """Gets the tab_type of this SignHere. # noqa: E501 2000 2001 # noqa: E501 2002 2003 :return: The tab_type of this SignHere. # noqa: E501 2004 :rtype: str 2005 """ 2006 return self._tab_type 2007 2008 @tab_type.setter 2009 def tab_type(self, tab_type): 2010 """Sets the tab_type of this SignHere. 2011 2012 # noqa: E501 2013 2014 :param tab_type: The tab_type of this SignHere. # noqa: E501 2015 :type: str 2016 """ 2017 2018 self._tab_type = tab_type 2019 2020 @property 2021 def tab_type_metadata(self): 2022 """Gets the tab_type_metadata of this SignHere. # noqa: E501 2023 2024 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2025 2026 :return: The tab_type_metadata of this SignHere. # noqa: E501 2027 :rtype: PropertyMetadata 2028 """ 2029 return self._tab_type_metadata 2030 2031 @tab_type_metadata.setter 2032 def tab_type_metadata(self, tab_type_metadata): 2033 """Sets the tab_type_metadata of this SignHere. 2034 2035 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2036 2037 :param tab_type_metadata: The tab_type_metadata of this SignHere. # noqa: E501 2038 :type: PropertyMetadata 2039 """ 2040 2041 self._tab_type_metadata = tab_type_metadata 2042 2043 @property 2044 def template_locked(self): 2045 """Gets the template_locked of this SignHere. # noqa: E501 2046 2047 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2048 2049 :return: The template_locked of this SignHere. # noqa: E501 2050 :rtype: str 2051 """ 2052 return self._template_locked 2053 2054 @template_locked.setter 2055 def template_locked(self, template_locked): 2056 """Sets the template_locked of this SignHere. 2057 2058 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2059 2060 :param template_locked: The template_locked of this SignHere. # noqa: E501 2061 :type: str 2062 """ 2063 2064 self._template_locked = template_locked 2065 2066 @property 2067 def template_locked_metadata(self): 2068 """Gets the template_locked_metadata of this SignHere. # noqa: E501 2069 2070 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2071 2072 :return: The template_locked_metadata of this SignHere. # noqa: E501 2073 :rtype: PropertyMetadata 2074 """ 2075 return self._template_locked_metadata 2076 2077 @template_locked_metadata.setter 2078 def template_locked_metadata(self, template_locked_metadata): 2079 """Sets the template_locked_metadata of this SignHere. 2080 2081 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2082 2083 :param template_locked_metadata: The template_locked_metadata of this SignHere. # noqa: E501 2084 :type: PropertyMetadata 2085 """ 2086 2087 self._template_locked_metadata = template_locked_metadata 2088 2089 @property 2090 def template_required(self): 2091 """Gets the template_required of this SignHere. # noqa: E501 2092 2093 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2094 2095 :return: The template_required of this SignHere. # noqa: E501 2096 :rtype: str 2097 """ 2098 return self._template_required 2099 2100 @template_required.setter 2101 def template_required(self, template_required): 2102 """Sets the template_required of this SignHere. 2103 2104 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2105 2106 :param template_required: The template_required of this SignHere. # noqa: E501 2107 :type: str 2108 """ 2109 2110 self._template_required = template_required 2111 2112 @property 2113 def template_required_metadata(self): 2114 """Gets the template_required_metadata of this SignHere. # noqa: E501 2115 2116 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2117 2118 :return: The template_required_metadata of this SignHere. # noqa: E501 2119 :rtype: PropertyMetadata 2120 """ 2121 return self._template_required_metadata 2122 2123 @template_required_metadata.setter 2124 def template_required_metadata(self, template_required_metadata): 2125 """Sets the template_required_metadata of this SignHere. 2126 2127 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2128 2129 :param template_required_metadata: The template_required_metadata of this SignHere. # noqa: E501 2130 :type: PropertyMetadata 2131 """ 2132 2133 self._template_required_metadata = template_required_metadata 2134 2135 @property 2136 def tooltip(self): 2137 """Gets the tooltip of this SignHere. # noqa: E501 2138 2139 # noqa: E501 2140 2141 :return: The tooltip of this SignHere. # noqa: E501 2142 :rtype: str 2143 """ 2144 return self._tooltip 2145 2146 @tooltip.setter 2147 def tooltip(self, tooltip): 2148 """Sets the tooltip of this SignHere. 2149 2150 # noqa: E501 2151 2152 :param tooltip: The tooltip of this SignHere. # noqa: E501 2153 :type: str 2154 """ 2155 2156 self._tooltip = tooltip 2157 2158 @property 2159 def tool_tip_metadata(self): 2160 """Gets the tool_tip_metadata of this SignHere. # noqa: E501 2161 2162 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2163 2164 :return: The tool_tip_metadata of this SignHere. # noqa: E501 2165 :rtype: PropertyMetadata 2166 """ 2167 return self._tool_tip_metadata 2168 2169 @tool_tip_metadata.setter 2170 def tool_tip_metadata(self, tool_tip_metadata): 2171 """Sets the tool_tip_metadata of this SignHere. 2172 2173 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2174 2175 :param tool_tip_metadata: The tool_tip_metadata of this SignHere. # noqa: E501 2176 :type: PropertyMetadata 2177 """ 2178 2179 self._tool_tip_metadata = tool_tip_metadata 2180 2181 @property 2182 def width(self): 2183 """Gets the width of this SignHere. # noqa: E501 2184 2185 Width of the tab in pixels. # noqa: E501 2186 2187 :return: The width of this SignHere. # noqa: E501 2188 :rtype: str 2189 """ 2190 return self._width 2191 2192 @width.setter 2193 def width(self, width): 2194 """Sets the width of this SignHere. 2195 2196 Width of the tab in pixels. # noqa: E501 2197 2198 :param width: The width of this SignHere. # noqa: E501 2199 :type: str 2200 """ 2201 2202 self._width = width 2203 2204 @property 2205 def width_metadata(self): 2206 """Gets the width_metadata of this SignHere. # noqa: E501 2207 2208 Metadata that indicates whether the `width` property is editable. # noqa: E501 2209 2210 :return: The width_metadata of this SignHere. # noqa: E501 2211 :rtype: PropertyMetadata 2212 """ 2213 return self._width_metadata 2214 2215 @width_metadata.setter 2216 def width_metadata(self, width_metadata): 2217 """Sets the width_metadata of this SignHere. 2218 2219 Metadata that indicates whether the `width` property is editable. # noqa: E501 2220 2221 :param width_metadata: The width_metadata of this SignHere. # noqa: E501 2222 :type: PropertyMetadata 2223 """ 2224 2225 self._width_metadata = width_metadata 2226 2227 @property 2228 def x_position(self): 2229 """Gets the x_position of this SignHere. # noqa: E501 2230 2231 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2232 2233 :return: The x_position of this SignHere. # noqa: E501 2234 :rtype: str 2235 """ 2236 return self._x_position 2237 2238 @x_position.setter 2239 def x_position(self, x_position): 2240 """Sets the x_position of this SignHere. 2241 2242 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2243 2244 :param x_position: The x_position of this SignHere. # noqa: E501 2245 :type: str 2246 """ 2247 2248 self._x_position = x_position 2249 2250 @property 2251 def x_position_metadata(self): 2252 """Gets the x_position_metadata of this SignHere. # noqa: E501 2253 2254 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2255 2256 :return: The x_position_metadata of this SignHere. # noqa: E501 2257 :rtype: PropertyMetadata 2258 """ 2259 return self._x_position_metadata 2260 2261 @x_position_metadata.setter 2262 def x_position_metadata(self, x_position_metadata): 2263 """Sets the x_position_metadata of this SignHere. 2264 2265 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 2266 2267 :param x_position_metadata: The x_position_metadata of this SignHere. # noqa: E501 2268 :type: PropertyMetadata 2269 """ 2270 2271 self._x_position_metadata = x_position_metadata 2272 2273 @property 2274 def y_position(self): 2275 """Gets the y_position of this SignHere. # noqa: E501 2276 2277 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2278 2279 :return: The y_position of this SignHere. # noqa: E501 2280 :rtype: str 2281 """ 2282 return self._y_position 2283 2284 @y_position.setter 2285 def y_position(self, y_position): 2286 """Sets the y_position of this SignHere. 2287 2288 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 2289 2290 :param y_position: The y_position of this SignHere. # noqa: E501 2291 :type: str 2292 """ 2293 2294 self._y_position = y_position 2295 2296 @property 2297 def y_position_metadata(self): 2298 """Gets the y_position_metadata of this SignHere. # noqa: E501 2299 2300 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2301 2302 :return: The y_position_metadata of this SignHere. # noqa: E501 2303 :rtype: PropertyMetadata 2304 """ 2305 return self._y_position_metadata 2306 2307 @y_position_metadata.setter 2308 def y_position_metadata(self, y_position_metadata): 2309 """Sets the y_position_metadata of this SignHere. 2310 2311 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 2312 2313 :param y_position_metadata: The y_position_metadata of this SignHere. # noqa: E501 2314 :type: PropertyMetadata 2315 """ 2316 2317 self._y_position_metadata = y_position_metadata 2318 2319 def to_dict(self): 2320 """Returns the model properties as a dict""" 2321 result = {} 2322 2323 for attr, _ in six.iteritems(self.swagger_types): 2324 value = getattr(self, attr) 2325 if isinstance(value, list): 2326 result[attr] = list(map( 2327 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2328 value 2329 )) 2330 elif hasattr(value, "to_dict"): 2331 result[attr] = value.to_dict() 2332 elif isinstance(value, dict): 2333 result[attr] = dict(map( 2334 lambda item: (item[0], item[1].to_dict()) 2335 if hasattr(item[1], "to_dict") else item, 2336 value.items() 2337 )) 2338 else: 2339 result[attr] = value 2340 if issubclass(SignHere, dict): 2341 for key, value in self.items(): 2342 result[key] = value 2343 2344 return result 2345 2346 def to_str(self): 2347 """Returns the string representation of the model""" 2348 return pprint.pformat(self.to_dict()) 2349 2350 def __repr__(self): 2351 """For `print` and `pprint`""" 2352 return self.to_str() 2353 2354 def __eq__(self, other): 2355 """Returns true if both objects are equal""" 2356 if not isinstance(other, SignHere): 2357 return False 2358 2359 return self.to_dict() == other.to_dict() 2360 2361 def __ne__(self, other): 2362 """Returns true if both objects are not equal""" 2363 if not isinstance(other, SignHere): 2364 return True 2365 2366 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
# 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
Array or errors. # 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
merge_field
Gets the merge_field of this SignHere. # noqa: E501
Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501
Returns
The merge_field of this SignHere. # noqa: E501
merge_field_xml
Gets the merge_field_xml of this SignHere. # noqa: E501
# noqa: E501
Returns
The merge_field_xml of this SignHere. # noqa: E501
name
Gets the name of this SignHere. # noqa: E501
Specifies the tool tip text for the tab. # noqa: E501
Returns
The name of this SignHere. # noqa: E501
name_metadata
Gets the name_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this SignHere. # noqa: E501
optional
Gets the optional of this SignHere. # noqa: E501
# noqa: E501
Returns
The optional of this SignHere. # noqa: E501
optional_metadata
Gets the optional_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the optional property is editable. # noqa: E501
Returns
The optional_metadata of this SignHere. # noqa: E501
page_number
Gets the page_number of this SignHere. # noqa: E501
Specifies the page number on which the tab is located. # noqa: E501
Returns
The page_number of this SignHere. # noqa: E501
page_number_metadata
Gets the page_number_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the pageNumber property is editable. # noqa: E501
Returns
The page_number_metadata of this SignHere. # noqa: E501
recipient_id
Gets the recipient_id of this SignHere. # noqa: E501
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501
Returns
The recipient_id of this SignHere. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this SignHere. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this SignHere. # noqa: E501
recipient_id_guid_metadata
Gets the recipient_id_guid_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the recipientIdGuid property is editable. # noqa: E501
Returns
The recipient_id_guid_metadata of this SignHere. # noqa: E501
recipient_id_metadata
Gets the recipient_id_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the recipientId property is editable. # noqa: E501
Returns
The recipient_id_metadata of this SignHere. # noqa: E501
scale_value
Gets the scale_value of this SignHere. # noqa: E501
# noqa: E501
Returns
The scale_value of this SignHere. # noqa: E501
scale_value_metadata
Gets the scale_value_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the scaleValue property is editable. # noqa: E501
Returns
The scale_value_metadata of this SignHere. # noqa: E501
smart_contract_information
Gets the smart_contract_information of this SignHere. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The smart_contract_information of this SignHere. # noqa: E501
source
Gets the source of this SignHere. # noqa: E501
# noqa: E501
Returns
The source of this SignHere. # noqa: E501
stamp
Gets the stamp of this SignHere. # noqa: E501
# noqa: E501
Returns
The stamp of this SignHere. # noqa: E501
stamp_type
Gets the stamp_type of this SignHere. # noqa: E501
# noqa: E501
Returns
The stamp_type of this SignHere. # noqa: E501
stamp_type_metadata
Gets the stamp_type_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the stampType property is editable. # noqa: E501
Returns
The stamp_type_metadata of this SignHere. # noqa: E501
status
Gets the status of this SignHere. # noqa: E501
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. # noqa: E501
Returns
The status of this SignHere. # noqa: E501
status_metadata
Gets the status_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the status property is editable. # noqa: E501
Returns
The status_metadata of this SignHere. # noqa: E501
tab_group_labels
Gets the tab_group_labels of this SignHere. # noqa: E501
# noqa: E501
Returns
The tab_group_labels of this SignHere. # noqa: E501
tab_group_labels_metadata
Gets the tab_group_labels_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the tabGroupLabels property is editable. # noqa: E501
Returns
The tab_group_labels_metadata of this SignHere. # noqa: E501
tab_id
Gets the tab_id of this SignHere. # noqa: E501
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501
Returns
The tab_id of this SignHere. # noqa: E501
tab_id_metadata
Gets the tab_id_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the tabId property is editable. # noqa: E501
Returns
The tab_id_metadata of this SignHere. # noqa: E501
tab_label
Gets the tab_label of this SignHere. # noqa: E501
The label string associated with the tab. # noqa: E501
Returns
The tab_label of this SignHere. # noqa: E501
tab_label_metadata
Gets the tab_label_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the tabLabel property is editable. # noqa: E501
Returns
The tab_label_metadata of this SignHere. # noqa: E501
tab_order
Gets the tab_order of this SignHere. # noqa: E501
# noqa: E501
Returns
The tab_order of this SignHere. # noqa: E501
tab_order_metadata
Gets the tab_order_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the tabOrder property is editable. # noqa: E501
Returns
The tab_order_metadata of this SignHere. # noqa: E501
tab_type
Gets the tab_type of this SignHere. # noqa: E501
# noqa: E501
Returns
The tab_type of this SignHere. # noqa: E501
tab_type_metadata
Gets the tab_type_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the tabType property is editable. # noqa: E501
Returns
The tab_type_metadata of this SignHere. # noqa: E501
template_locked
Gets the template_locked of this SignHere. # noqa: E501
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_locked of this SignHere. # noqa: E501
template_locked_metadata
Gets the template_locked_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the templateLocked property is editable. # noqa: E501
Returns
The template_locked_metadata of this SignHere. # noqa: E501
template_required
Gets the template_required of this SignHere. # noqa: E501
When set to true, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501
Returns
The template_required of this SignHere. # noqa: E501
template_required_metadata
Gets the template_required_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the templateRequired property is editable. # noqa: E501
Returns
The template_required_metadata of this SignHere. # noqa: E501
tooltip
Gets the tooltip of this SignHere. # noqa: E501
# noqa: E501
Returns
The tooltip of this SignHere. # noqa: E501
tool_tip_metadata
Gets the tool_tip_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the toolTip property is editable. # noqa: E501
Returns
The tool_tip_metadata of this SignHere. # noqa: E501
width
Gets the width of this SignHere. # noqa: E501
Width of the tab in pixels. # noqa: E501
Returns
The width of this SignHere. # noqa: E501
width_metadata
Gets the width_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the width property is editable. # noqa: E501
Returns
The width_metadata of this SignHere. # noqa: E501
x_position
Gets the x_position of this SignHere. # noqa: E501
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501
Returns
The x_position of this SignHere. # noqa: E501
x_position_metadata
Gets the x_position_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the xPosition property is editable. # noqa: E501
Returns
The x_position_metadata of this SignHere. # noqa: E501
y_position
Gets the y_position of this SignHere. # noqa: E501
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501
Returns
The y_position of this SignHere. # noqa: E501
y_position_metadata
Gets the y_position_metadata of this SignHere. # noqa: E501
Metadata that indicates whether the yPosition property is editable. # noqa: E501
Returns
The y_position_metadata of this SignHere. # noqa: E501
def
to_dict(self)
2319 def to_dict(self): 2320 """Returns the model properties as a dict""" 2321 result = {} 2322 2323 for attr, _ in six.iteritems(self.swagger_types): 2324 value = getattr(self, attr) 2325 if isinstance(value, list): 2326 result[attr] = list(map( 2327 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 2328 value 2329 )) 2330 elif hasattr(value, "to_dict"): 2331 result[attr] = value.to_dict() 2332 elif isinstance(value, dict): 2333 result[attr] = dict(map( 2334 lambda item: (item[0], item[1].to_dict()) 2335 if hasattr(item[1], "to_dict") else item, 2336 value.items() 2337 )) 2338 else: 2339 result[attr] = value 2340 if issubclass(SignHere, dict): 2341 for key, value in self.items(): 2342 result[key] = value 2343 2344 return result
Returns the model properties as a dict