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