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