docusign_esign.models.zip
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 Zip(object): 23 """NOTE: This class is auto generated by the swagger code generator program. 24 25 Do not edit the class manually. 26 """ 27 28 """ 29 Attributes: 30 swagger_types (dict): The key is attribute name 31 and the value is attribute type. 32 attribute_map (dict): The key is attribute name 33 and the value is json key in definition. 34 """ 35 swagger_types = { 36 'agreement_attribute': 'str', 37 'agreement_attribute_locked': 'str', 38 'anchor_allow_white_space_in_characters': 'str', 39 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 40 'anchor_case_sensitive': 'str', 41 'anchor_case_sensitive_metadata': 'PropertyMetadata', 42 'anchor_horizontal_alignment': 'str', 43 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 44 'anchor_ignore_if_not_present': 'str', 45 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 46 'anchor_match_whole_word': 'str', 47 'anchor_match_whole_word_metadata': 'PropertyMetadata', 48 'anchor_string': 'str', 49 'anchor_string_metadata': 'PropertyMetadata', 50 'anchor_tab_processor_version': 'str', 51 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 52 'anchor_units': 'str', 53 'anchor_units_metadata': 'PropertyMetadata', 54 'anchor_x_offset': 'str', 55 'anchor_x_offset_metadata': 'PropertyMetadata', 56 'anchor_y_offset': 'str', 57 'anchor_y_offset_metadata': 'PropertyMetadata', 58 'bold': 'str', 59 'bold_metadata': 'PropertyMetadata', 60 'caption': 'str', 61 'caption_metadata': 'PropertyMetadata', 62 'conceal_value_on_document': 'str', 63 'conceal_value_on_document_metadata': 'PropertyMetadata', 64 'conditional_parent_label': 'str', 65 'conditional_parent_label_metadata': 'PropertyMetadata', 66 'conditional_parent_value': 'str', 67 'conditional_parent_value_metadata': 'PropertyMetadata', 68 'connected_object_details': 'ConnectedObjectDetails', 69 'custom_tab_id': 'str', 70 'custom_tab_id_metadata': 'PropertyMetadata', 71 'disable_auto_size': 'str', 72 'disable_auto_size_metadata': 'PropertyMetadata', 73 'document_id': 'str', 74 'document_id_metadata': 'PropertyMetadata', 75 'error_details': 'ErrorDetails', 76 'extension_data': 'ExtensionData', 77 'font': 'str', 78 'font_color': 'str', 79 'font_color_metadata': 'PropertyMetadata', 80 'font_metadata': 'PropertyMetadata', 81 'font_size': 'str', 82 'font_size_metadata': 'PropertyMetadata', 83 'form_order': 'str', 84 'form_order_metadata': 'PropertyMetadata', 85 'form_page_label': 'str', 86 'form_page_label_metadata': 'PropertyMetadata', 87 'form_page_number': 'str', 88 'form_page_number_metadata': 'PropertyMetadata', 89 'height': 'str', 90 'height_metadata': 'PropertyMetadata', 91 'italic': 'str', 92 'italic_metadata': 'PropertyMetadata', 93 'locale_policy': 'LocalePolicyTab', 94 'locked': 'str', 95 'locked_metadata': 'PropertyMetadata', 96 'max_length': 'str', 97 'max_length_metadata': 'PropertyMetadata', 98 'merge_field': 'MergeField', 99 'merge_field_xml': 'str', 100 'name': 'str', 101 'name_metadata': 'PropertyMetadata', 102 'original_value': 'str', 103 'original_value_metadata': 'PropertyMetadata', 104 'page_number': 'str', 105 'page_number_metadata': 'PropertyMetadata', 106 'recipient_id': 'str', 107 'recipient_id_guid': 'str', 108 'recipient_id_guid_metadata': 'PropertyMetadata', 109 'recipient_id_metadata': 'PropertyMetadata', 110 'require_all': 'str', 111 'require_all_metadata': 'PropertyMetadata', 112 'required': 'str', 113 'required_metadata': 'PropertyMetadata', 114 'require_initial_on_shared_change': 'str', 115 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 116 'sender_required': 'str', 117 'sender_required_metadata': 'PropertyMetadata', 118 'shared': 'str', 119 'shared_metadata': 'PropertyMetadata', 120 'share_to_recipients': 'str', 121 'share_to_recipients_metadata': 'PropertyMetadata', 122 'smart_contract_information': 'SmartContractInformation', 123 'source': 'str', 124 'status': 'str', 125 'status_metadata': 'PropertyMetadata', 126 'tab_fully_qualified_path': 'str', 127 'tab_group_labels': 'list[str]', 128 'tab_group_labels_metadata': 'PropertyMetadata', 129 'tab_id': 'str', 130 'tab_id_metadata': 'PropertyMetadata', 131 'tab_label': 'str', 132 'tab_label_metadata': 'PropertyMetadata', 133 'tab_order': 'str', 134 'tab_order_metadata': 'PropertyMetadata', 135 'tab_type': 'str', 136 'tab_type_metadata': 'PropertyMetadata', 137 'template_locked': 'str', 138 'template_locked_metadata': 'PropertyMetadata', 139 'template_required': 'str', 140 'template_required_metadata': 'PropertyMetadata', 141 'tooltip': 'str', 142 'tool_tip_metadata': 'PropertyMetadata', 143 'underline': 'str', 144 'underline_metadata': 'PropertyMetadata', 145 'use_dash4': 'str', 146 'use_dash4_metadata': 'PropertyMetadata', 147 'validation_message': 'str', 148 'validation_message_metadata': 'PropertyMetadata', 149 'validation_pattern': 'str', 150 'validation_pattern_metadata': 'PropertyMetadata', 151 'value': 'str', 152 'value_metadata': 'PropertyMetadata', 153 'warning_details': 'ErrorDetails', 154 'width': 'str', 155 'width_metadata': 'PropertyMetadata', 156 'x_position': 'str', 157 'x_position_metadata': 'PropertyMetadata', 158 'y_position': 'str', 159 'y_position_metadata': 'PropertyMetadata' 160 } 161 162 attribute_map = { 163 'agreement_attribute': 'agreementAttribute', 164 'agreement_attribute_locked': 'agreementAttributeLocked', 165 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 166 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 167 'anchor_case_sensitive': 'anchorCaseSensitive', 168 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 169 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 170 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 171 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 172 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 173 'anchor_match_whole_word': 'anchorMatchWholeWord', 174 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 175 'anchor_string': 'anchorString', 176 'anchor_string_metadata': 'anchorStringMetadata', 177 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 178 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 179 'anchor_units': 'anchorUnits', 180 'anchor_units_metadata': 'anchorUnitsMetadata', 181 'anchor_x_offset': 'anchorXOffset', 182 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 183 'anchor_y_offset': 'anchorYOffset', 184 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 185 'bold': 'bold', 186 'bold_metadata': 'boldMetadata', 187 'caption': 'caption', 188 'caption_metadata': 'captionMetadata', 189 'conceal_value_on_document': 'concealValueOnDocument', 190 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 191 'conditional_parent_label': 'conditionalParentLabel', 192 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 193 'conditional_parent_value': 'conditionalParentValue', 194 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 195 'connected_object_details': 'connectedObjectDetails', 196 'custom_tab_id': 'customTabId', 197 'custom_tab_id_metadata': 'customTabIdMetadata', 198 'disable_auto_size': 'disableAutoSize', 199 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 200 'document_id': 'documentId', 201 'document_id_metadata': 'documentIdMetadata', 202 'error_details': 'errorDetails', 203 'extension_data': 'extensionData', 204 'font': 'font', 205 'font_color': 'fontColor', 206 'font_color_metadata': 'fontColorMetadata', 207 'font_metadata': 'fontMetadata', 208 'font_size': 'fontSize', 209 'font_size_metadata': 'fontSizeMetadata', 210 'form_order': 'formOrder', 211 'form_order_metadata': 'formOrderMetadata', 212 'form_page_label': 'formPageLabel', 213 'form_page_label_metadata': 'formPageLabelMetadata', 214 'form_page_number': 'formPageNumber', 215 'form_page_number_metadata': 'formPageNumberMetadata', 216 'height': 'height', 217 'height_metadata': 'heightMetadata', 218 'italic': 'italic', 219 'italic_metadata': 'italicMetadata', 220 'locale_policy': 'localePolicy', 221 'locked': 'locked', 222 'locked_metadata': 'lockedMetadata', 223 'max_length': 'maxLength', 224 'max_length_metadata': 'maxLengthMetadata', 225 'merge_field': 'mergeField', 226 'merge_field_xml': 'mergeFieldXml', 227 'name': 'name', 228 'name_metadata': 'nameMetadata', 229 'original_value': 'originalValue', 230 'original_value_metadata': 'originalValueMetadata', 231 'page_number': 'pageNumber', 232 'page_number_metadata': 'pageNumberMetadata', 233 'recipient_id': 'recipientId', 234 'recipient_id_guid': 'recipientIdGuid', 235 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 236 'recipient_id_metadata': 'recipientIdMetadata', 237 'require_all': 'requireAll', 238 'require_all_metadata': 'requireAllMetadata', 239 'required': 'required', 240 'required_metadata': 'requiredMetadata', 241 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 242 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 243 'sender_required': 'senderRequired', 244 'sender_required_metadata': 'senderRequiredMetadata', 245 'shared': 'shared', 246 'shared_metadata': 'sharedMetadata', 247 'share_to_recipients': 'shareToRecipients', 248 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 249 'smart_contract_information': 'smartContractInformation', 250 'source': 'source', 251 'status': 'status', 252 'status_metadata': 'statusMetadata', 253 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 254 'tab_group_labels': 'tabGroupLabels', 255 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 256 'tab_id': 'tabId', 257 'tab_id_metadata': 'tabIdMetadata', 258 'tab_label': 'tabLabel', 259 'tab_label_metadata': 'tabLabelMetadata', 260 'tab_order': 'tabOrder', 261 'tab_order_metadata': 'tabOrderMetadata', 262 'tab_type': 'tabType', 263 'tab_type_metadata': 'tabTypeMetadata', 264 'template_locked': 'templateLocked', 265 'template_locked_metadata': 'templateLockedMetadata', 266 'template_required': 'templateRequired', 267 'template_required_metadata': 'templateRequiredMetadata', 268 'tooltip': 'tooltip', 269 'tool_tip_metadata': 'toolTipMetadata', 270 'underline': 'underline', 271 'underline_metadata': 'underlineMetadata', 272 'use_dash4': 'useDash4', 273 'use_dash4_metadata': 'useDash4Metadata', 274 'validation_message': 'validationMessage', 275 'validation_message_metadata': 'validationMessageMetadata', 276 'validation_pattern': 'validationPattern', 277 'validation_pattern_metadata': 'validationPatternMetadata', 278 'value': 'value', 279 'value_metadata': 'valueMetadata', 280 'warning_details': 'warningDetails', 281 'width': 'width', 282 'width_metadata': 'widthMetadata', 283 'x_position': 'xPosition', 284 'x_position_metadata': 'xPositionMetadata', 285 'y_position': 'yPosition', 286 'y_position_metadata': 'yPositionMetadata' 287 } 288 289 def __init__(self, _configuration=None, **kwargs): # noqa: E501 290 """Zip - a model defined in Swagger""" # noqa: E501 291 if _configuration is None: 292 _configuration = Configuration() 293 self._configuration = _configuration 294 295 self._agreement_attribute = None 296 self._agreement_attribute_locked = None 297 self._anchor_allow_white_space_in_characters = None 298 self._anchor_allow_white_space_in_characters_metadata = None 299 self._anchor_case_sensitive = None 300 self._anchor_case_sensitive_metadata = None 301 self._anchor_horizontal_alignment = None 302 self._anchor_horizontal_alignment_metadata = None 303 self._anchor_ignore_if_not_present = None 304 self._anchor_ignore_if_not_present_metadata = None 305 self._anchor_match_whole_word = None 306 self._anchor_match_whole_word_metadata = None 307 self._anchor_string = None 308 self._anchor_string_metadata = None 309 self._anchor_tab_processor_version = None 310 self._anchor_tab_processor_version_metadata = None 311 self._anchor_units = None 312 self._anchor_units_metadata = None 313 self._anchor_x_offset = None 314 self._anchor_x_offset_metadata = None 315 self._anchor_y_offset = None 316 self._anchor_y_offset_metadata = None 317 self._bold = None 318 self._bold_metadata = None 319 self._caption = None 320 self._caption_metadata = None 321 self._conceal_value_on_document = None 322 self._conceal_value_on_document_metadata = None 323 self._conditional_parent_label = None 324 self._conditional_parent_label_metadata = None 325 self._conditional_parent_value = None 326 self._conditional_parent_value_metadata = None 327 self._connected_object_details = None 328 self._custom_tab_id = None 329 self._custom_tab_id_metadata = None 330 self._disable_auto_size = None 331 self._disable_auto_size_metadata = None 332 self._document_id = None 333 self._document_id_metadata = None 334 self._error_details = None 335 self._extension_data = None 336 self._font = None 337 self._font_color = None 338 self._font_color_metadata = None 339 self._font_metadata = None 340 self._font_size = None 341 self._font_size_metadata = None 342 self._form_order = None 343 self._form_order_metadata = None 344 self._form_page_label = None 345 self._form_page_label_metadata = None 346 self._form_page_number = None 347 self._form_page_number_metadata = None 348 self._height = None 349 self._height_metadata = None 350 self._italic = None 351 self._italic_metadata = None 352 self._locale_policy = None 353 self._locked = None 354 self._locked_metadata = None 355 self._max_length = None 356 self._max_length_metadata = None 357 self._merge_field = None 358 self._merge_field_xml = None 359 self._name = None 360 self._name_metadata = None 361 self._original_value = None 362 self._original_value_metadata = None 363 self._page_number = None 364 self._page_number_metadata = None 365 self._recipient_id = None 366 self._recipient_id_guid = None 367 self._recipient_id_guid_metadata = None 368 self._recipient_id_metadata = None 369 self._require_all = None 370 self._require_all_metadata = None 371 self._required = None 372 self._required_metadata = None 373 self._require_initial_on_shared_change = None 374 self._require_initial_on_shared_change_metadata = None 375 self._sender_required = None 376 self._sender_required_metadata = None 377 self._shared = None 378 self._shared_metadata = None 379 self._share_to_recipients = None 380 self._share_to_recipients_metadata = None 381 self._smart_contract_information = None 382 self._source = None 383 self._status = None 384 self._status_metadata = None 385 self._tab_fully_qualified_path = None 386 self._tab_group_labels = None 387 self._tab_group_labels_metadata = None 388 self._tab_id = None 389 self._tab_id_metadata = None 390 self._tab_label = None 391 self._tab_label_metadata = None 392 self._tab_order = None 393 self._tab_order_metadata = None 394 self._tab_type = None 395 self._tab_type_metadata = None 396 self._template_locked = None 397 self._template_locked_metadata = None 398 self._template_required = None 399 self._template_required_metadata = None 400 self._tooltip = None 401 self._tool_tip_metadata = None 402 self._underline = None 403 self._underline_metadata = None 404 self._use_dash4 = None 405 self._use_dash4_metadata = None 406 self._validation_message = None 407 self._validation_message_metadata = None 408 self._validation_pattern = None 409 self._validation_pattern_metadata = None 410 self._value = None 411 self._value_metadata = None 412 self._warning_details = None 413 self._width = None 414 self._width_metadata = None 415 self._x_position = None 416 self._x_position_metadata = None 417 self._y_position = None 418 self._y_position_metadata = None 419 self.discriminator = None 420 421 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 422 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 423 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 424 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 425 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 426 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 427 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 428 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 429 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 430 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 431 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 432 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 433 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 434 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 435 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 436 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 437 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 438 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 439 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 440 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 441 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 442 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 443 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 444 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 445 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 446 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 447 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 448 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 449 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 450 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 451 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 452 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 453 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 454 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 455 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 456 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 457 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 458 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 459 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 460 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 461 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 462 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 463 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 464 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 465 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 466 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 467 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 468 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 469 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 470 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 471 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 472 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 473 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 474 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 475 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 476 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 477 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 478 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 479 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 480 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 481 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 482 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 483 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 484 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 485 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 486 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 487 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 488 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 489 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 490 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 491 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 492 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 493 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 494 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 495 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 496 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 497 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 498 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 499 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 500 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 501 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 502 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 503 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 504 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 505 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 506 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 507 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 508 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 509 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 510 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 511 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 512 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 513 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 514 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 515 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 516 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 517 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 518 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 519 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 520 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 521 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 522 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 523 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 524 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 525 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 526 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 527 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 528 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 529 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 530 setattr(self, "_{}".format('use_dash4'), kwargs.get('use_dash4', None)) 531 setattr(self, "_{}".format('use_dash4_metadata'), kwargs.get('use_dash4_metadata', None)) 532 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 533 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 534 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 535 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 536 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 537 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 538 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 539 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 540 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 541 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 542 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 543 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 544 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 545 546 @property 547 def agreement_attribute(self): 548 """Gets the agreement_attribute of this Zip. # noqa: E501 549 550 # noqa: E501 551 552 :return: The agreement_attribute of this Zip. # noqa: E501 553 :rtype: str 554 """ 555 return self._agreement_attribute 556 557 @agreement_attribute.setter 558 def agreement_attribute(self, agreement_attribute): 559 """Sets the agreement_attribute of this Zip. 560 561 # noqa: E501 562 563 :param agreement_attribute: The agreement_attribute of this Zip. # noqa: E501 564 :type: str 565 """ 566 567 self._agreement_attribute = agreement_attribute 568 569 @property 570 def agreement_attribute_locked(self): 571 """Gets the agreement_attribute_locked of this Zip. # noqa: E501 572 573 # noqa: E501 574 575 :return: The agreement_attribute_locked of this Zip. # noqa: E501 576 :rtype: str 577 """ 578 return self._agreement_attribute_locked 579 580 @agreement_attribute_locked.setter 581 def agreement_attribute_locked(self, agreement_attribute_locked): 582 """Sets the agreement_attribute_locked of this Zip. 583 584 # noqa: E501 585 586 :param agreement_attribute_locked: The agreement_attribute_locked of this Zip. # noqa: E501 587 :type: str 588 """ 589 590 self._agreement_attribute_locked = agreement_attribute_locked 591 592 @property 593 def anchor_allow_white_space_in_characters(self): 594 """Gets the anchor_allow_white_space_in_characters of this Zip. # noqa: E501 595 596 # noqa: E501 597 598 :return: The anchor_allow_white_space_in_characters of this Zip. # noqa: E501 599 :rtype: str 600 """ 601 return self._anchor_allow_white_space_in_characters 602 603 @anchor_allow_white_space_in_characters.setter 604 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 605 """Sets the anchor_allow_white_space_in_characters of this Zip. 606 607 # noqa: E501 608 609 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this Zip. # noqa: E501 610 :type: str 611 """ 612 613 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 614 615 @property 616 def anchor_allow_white_space_in_characters_metadata(self): 617 """Gets the anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501 618 619 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 620 621 :return: The anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501 622 :rtype: PropertyMetadata 623 """ 624 return self._anchor_allow_white_space_in_characters_metadata 625 626 @anchor_allow_white_space_in_characters_metadata.setter 627 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 628 """Sets the anchor_allow_white_space_in_characters_metadata of this Zip. 629 630 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 631 632 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501 633 :type: PropertyMetadata 634 """ 635 636 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 637 638 @property 639 def anchor_case_sensitive(self): 640 """Gets the anchor_case_sensitive of this Zip. # noqa: E501 641 642 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 643 644 :return: The anchor_case_sensitive of this Zip. # noqa: E501 645 :rtype: str 646 """ 647 return self._anchor_case_sensitive 648 649 @anchor_case_sensitive.setter 650 def anchor_case_sensitive(self, anchor_case_sensitive): 651 """Sets the anchor_case_sensitive of this Zip. 652 653 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 654 655 :param anchor_case_sensitive: The anchor_case_sensitive of this Zip. # noqa: E501 656 :type: str 657 """ 658 659 self._anchor_case_sensitive = anchor_case_sensitive 660 661 @property 662 def anchor_case_sensitive_metadata(self): 663 """Gets the anchor_case_sensitive_metadata of this Zip. # noqa: E501 664 665 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 666 667 :return: The anchor_case_sensitive_metadata of this Zip. # noqa: E501 668 :rtype: PropertyMetadata 669 """ 670 return self._anchor_case_sensitive_metadata 671 672 @anchor_case_sensitive_metadata.setter 673 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 674 """Sets the anchor_case_sensitive_metadata of this Zip. 675 676 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 677 678 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this Zip. # noqa: E501 679 :type: PropertyMetadata 680 """ 681 682 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 683 684 @property 685 def anchor_horizontal_alignment(self): 686 """Gets the anchor_horizontal_alignment of this Zip. # noqa: E501 687 688 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 689 690 :return: The anchor_horizontal_alignment of this Zip. # noqa: E501 691 :rtype: str 692 """ 693 return self._anchor_horizontal_alignment 694 695 @anchor_horizontal_alignment.setter 696 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 697 """Sets the anchor_horizontal_alignment of this Zip. 698 699 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 700 701 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this Zip. # noqa: E501 702 :type: str 703 """ 704 705 self._anchor_horizontal_alignment = anchor_horizontal_alignment 706 707 @property 708 def anchor_horizontal_alignment_metadata(self): 709 """Gets the anchor_horizontal_alignment_metadata of this Zip. # noqa: E501 710 711 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 712 713 :return: The anchor_horizontal_alignment_metadata of this Zip. # noqa: E501 714 :rtype: PropertyMetadata 715 """ 716 return self._anchor_horizontal_alignment_metadata 717 718 @anchor_horizontal_alignment_metadata.setter 719 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 720 """Sets the anchor_horizontal_alignment_metadata of this Zip. 721 722 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 723 724 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this Zip. # noqa: E501 725 :type: PropertyMetadata 726 """ 727 728 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 729 730 @property 731 def anchor_ignore_if_not_present(self): 732 """Gets the anchor_ignore_if_not_present of this Zip. # noqa: E501 733 734 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 735 736 :return: The anchor_ignore_if_not_present of this Zip. # noqa: E501 737 :rtype: str 738 """ 739 return self._anchor_ignore_if_not_present 740 741 @anchor_ignore_if_not_present.setter 742 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 743 """Sets the anchor_ignore_if_not_present of this Zip. 744 745 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 746 747 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this Zip. # noqa: E501 748 :type: str 749 """ 750 751 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 752 753 @property 754 def anchor_ignore_if_not_present_metadata(self): 755 """Gets the anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501 756 757 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 758 759 :return: The anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501 760 :rtype: PropertyMetadata 761 """ 762 return self._anchor_ignore_if_not_present_metadata 763 764 @anchor_ignore_if_not_present_metadata.setter 765 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 766 """Sets the anchor_ignore_if_not_present_metadata of this Zip. 767 768 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 769 770 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501 771 :type: PropertyMetadata 772 """ 773 774 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 775 776 @property 777 def anchor_match_whole_word(self): 778 """Gets the anchor_match_whole_word of this Zip. # noqa: E501 779 780 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 781 782 :return: The anchor_match_whole_word of this Zip. # noqa: E501 783 :rtype: str 784 """ 785 return self._anchor_match_whole_word 786 787 @anchor_match_whole_word.setter 788 def anchor_match_whole_word(self, anchor_match_whole_word): 789 """Sets the anchor_match_whole_word of this Zip. 790 791 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 792 793 :param anchor_match_whole_word: The anchor_match_whole_word of this Zip. # noqa: E501 794 :type: str 795 """ 796 797 self._anchor_match_whole_word = anchor_match_whole_word 798 799 @property 800 def anchor_match_whole_word_metadata(self): 801 """Gets the anchor_match_whole_word_metadata of this Zip. # noqa: E501 802 803 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 804 805 :return: The anchor_match_whole_word_metadata of this Zip. # noqa: E501 806 :rtype: PropertyMetadata 807 """ 808 return self._anchor_match_whole_word_metadata 809 810 @anchor_match_whole_word_metadata.setter 811 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 812 """Sets the anchor_match_whole_word_metadata of this Zip. 813 814 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 815 816 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this Zip. # noqa: E501 817 :type: PropertyMetadata 818 """ 819 820 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 821 822 @property 823 def anchor_string(self): 824 """Gets the anchor_string of this Zip. # noqa: E501 825 826 Anchor text information for a radio button. # noqa: E501 827 828 :return: The anchor_string of this Zip. # noqa: E501 829 :rtype: str 830 """ 831 return self._anchor_string 832 833 @anchor_string.setter 834 def anchor_string(self, anchor_string): 835 """Sets the anchor_string of this Zip. 836 837 Anchor text information for a radio button. # noqa: E501 838 839 :param anchor_string: The anchor_string of this Zip. # noqa: E501 840 :type: str 841 """ 842 843 self._anchor_string = anchor_string 844 845 @property 846 def anchor_string_metadata(self): 847 """Gets the anchor_string_metadata of this Zip. # noqa: E501 848 849 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 850 851 :return: The anchor_string_metadata of this Zip. # noqa: E501 852 :rtype: PropertyMetadata 853 """ 854 return self._anchor_string_metadata 855 856 @anchor_string_metadata.setter 857 def anchor_string_metadata(self, anchor_string_metadata): 858 """Sets the anchor_string_metadata of this Zip. 859 860 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 861 862 :param anchor_string_metadata: The anchor_string_metadata of this Zip. # noqa: E501 863 :type: PropertyMetadata 864 """ 865 866 self._anchor_string_metadata = anchor_string_metadata 867 868 @property 869 def anchor_tab_processor_version(self): 870 """Gets the anchor_tab_processor_version of this Zip. # noqa: E501 871 872 # noqa: E501 873 874 :return: The anchor_tab_processor_version of this Zip. # noqa: E501 875 :rtype: str 876 """ 877 return self._anchor_tab_processor_version 878 879 @anchor_tab_processor_version.setter 880 def anchor_tab_processor_version(self, anchor_tab_processor_version): 881 """Sets the anchor_tab_processor_version of this Zip. 882 883 # noqa: E501 884 885 :param anchor_tab_processor_version: The anchor_tab_processor_version of this Zip. # noqa: E501 886 :type: str 887 """ 888 889 self._anchor_tab_processor_version = anchor_tab_processor_version 890 891 @property 892 def anchor_tab_processor_version_metadata(self): 893 """Gets the anchor_tab_processor_version_metadata of this Zip. # noqa: E501 894 895 Reserved for DocuSign. # noqa: E501 896 897 :return: The anchor_tab_processor_version_metadata of this Zip. # noqa: E501 898 :rtype: PropertyMetadata 899 """ 900 return self._anchor_tab_processor_version_metadata 901 902 @anchor_tab_processor_version_metadata.setter 903 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 904 """Sets the anchor_tab_processor_version_metadata of this Zip. 905 906 Reserved for DocuSign. # noqa: E501 907 908 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this Zip. # noqa: E501 909 :type: PropertyMetadata 910 """ 911 912 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 913 914 @property 915 def anchor_units(self): 916 """Gets the anchor_units of this Zip. # noqa: E501 917 918 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 919 920 :return: The anchor_units of this Zip. # noqa: E501 921 :rtype: str 922 """ 923 return self._anchor_units 924 925 @anchor_units.setter 926 def anchor_units(self, anchor_units): 927 """Sets the anchor_units of this Zip. 928 929 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 930 931 :param anchor_units: The anchor_units of this Zip. # noqa: E501 932 :type: str 933 """ 934 935 self._anchor_units = anchor_units 936 937 @property 938 def anchor_units_metadata(self): 939 """Gets the anchor_units_metadata of this Zip. # noqa: E501 940 941 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 942 943 :return: The anchor_units_metadata of this Zip. # noqa: E501 944 :rtype: PropertyMetadata 945 """ 946 return self._anchor_units_metadata 947 948 @anchor_units_metadata.setter 949 def anchor_units_metadata(self, anchor_units_metadata): 950 """Sets the anchor_units_metadata of this Zip. 951 952 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 953 954 :param anchor_units_metadata: The anchor_units_metadata of this Zip. # noqa: E501 955 :type: PropertyMetadata 956 """ 957 958 self._anchor_units_metadata = anchor_units_metadata 959 960 @property 961 def anchor_x_offset(self): 962 """Gets the anchor_x_offset of this Zip. # noqa: E501 963 964 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 965 966 :return: The anchor_x_offset of this Zip. # noqa: E501 967 :rtype: str 968 """ 969 return self._anchor_x_offset 970 971 @anchor_x_offset.setter 972 def anchor_x_offset(self, anchor_x_offset): 973 """Sets the anchor_x_offset of this Zip. 974 975 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 976 977 :param anchor_x_offset: The anchor_x_offset of this Zip. # noqa: E501 978 :type: str 979 """ 980 981 self._anchor_x_offset = anchor_x_offset 982 983 @property 984 def anchor_x_offset_metadata(self): 985 """Gets the anchor_x_offset_metadata of this Zip. # noqa: E501 986 987 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 988 989 :return: The anchor_x_offset_metadata of this Zip. # noqa: E501 990 :rtype: PropertyMetadata 991 """ 992 return self._anchor_x_offset_metadata 993 994 @anchor_x_offset_metadata.setter 995 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 996 """Sets the anchor_x_offset_metadata of this Zip. 997 998 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 999 1000 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this Zip. # noqa: E501 1001 :type: PropertyMetadata 1002 """ 1003 1004 self._anchor_x_offset_metadata = anchor_x_offset_metadata 1005 1006 @property 1007 def anchor_y_offset(self): 1008 """Gets the anchor_y_offset of this Zip. # noqa: E501 1009 1010 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1011 1012 :return: The anchor_y_offset of this Zip. # noqa: E501 1013 :rtype: str 1014 """ 1015 return self._anchor_y_offset 1016 1017 @anchor_y_offset.setter 1018 def anchor_y_offset(self, anchor_y_offset): 1019 """Sets the anchor_y_offset of this Zip. 1020 1021 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1022 1023 :param anchor_y_offset: The anchor_y_offset of this Zip. # noqa: E501 1024 :type: str 1025 """ 1026 1027 self._anchor_y_offset = anchor_y_offset 1028 1029 @property 1030 def anchor_y_offset_metadata(self): 1031 """Gets the anchor_y_offset_metadata of this Zip. # noqa: E501 1032 1033 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1034 1035 :return: The anchor_y_offset_metadata of this Zip. # noqa: E501 1036 :rtype: PropertyMetadata 1037 """ 1038 return self._anchor_y_offset_metadata 1039 1040 @anchor_y_offset_metadata.setter 1041 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 1042 """Sets the anchor_y_offset_metadata of this Zip. 1043 1044 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1045 1046 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this Zip. # noqa: E501 1047 :type: PropertyMetadata 1048 """ 1049 1050 self._anchor_y_offset_metadata = anchor_y_offset_metadata 1051 1052 @property 1053 def bold(self): 1054 """Gets the bold of this Zip. # noqa: E501 1055 1056 When set to **true**, the information in the tab is bold. # noqa: E501 1057 1058 :return: The bold of this Zip. # noqa: E501 1059 :rtype: str 1060 """ 1061 return self._bold 1062 1063 @bold.setter 1064 def bold(self, bold): 1065 """Sets the bold of this Zip. 1066 1067 When set to **true**, the information in the tab is bold. # noqa: E501 1068 1069 :param bold: The bold of this Zip. # noqa: E501 1070 :type: str 1071 """ 1072 1073 self._bold = bold 1074 1075 @property 1076 def bold_metadata(self): 1077 """Gets the bold_metadata of this Zip. # noqa: E501 1078 1079 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1080 1081 :return: The bold_metadata of this Zip. # noqa: E501 1082 :rtype: PropertyMetadata 1083 """ 1084 return self._bold_metadata 1085 1086 @bold_metadata.setter 1087 def bold_metadata(self, bold_metadata): 1088 """Sets the bold_metadata of this Zip. 1089 1090 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1091 1092 :param bold_metadata: The bold_metadata of this Zip. # noqa: E501 1093 :type: PropertyMetadata 1094 """ 1095 1096 self._bold_metadata = bold_metadata 1097 1098 @property 1099 def caption(self): 1100 """Gets the caption of this Zip. # noqa: E501 1101 1102 # noqa: E501 1103 1104 :return: The caption of this Zip. # noqa: E501 1105 :rtype: str 1106 """ 1107 return self._caption 1108 1109 @caption.setter 1110 def caption(self, caption): 1111 """Sets the caption of this Zip. 1112 1113 # noqa: E501 1114 1115 :param caption: The caption of this Zip. # noqa: E501 1116 :type: str 1117 """ 1118 1119 self._caption = caption 1120 1121 @property 1122 def caption_metadata(self): 1123 """Gets the caption_metadata of this Zip. # noqa: E501 1124 1125 # noqa: E501 1126 1127 :return: The caption_metadata of this Zip. # noqa: E501 1128 :rtype: PropertyMetadata 1129 """ 1130 return self._caption_metadata 1131 1132 @caption_metadata.setter 1133 def caption_metadata(self, caption_metadata): 1134 """Sets the caption_metadata of this Zip. 1135 1136 # noqa: E501 1137 1138 :param caption_metadata: The caption_metadata of this Zip. # noqa: E501 1139 :type: PropertyMetadata 1140 """ 1141 1142 self._caption_metadata = caption_metadata 1143 1144 @property 1145 def conceal_value_on_document(self): 1146 """Gets the conceal_value_on_document of this Zip. # noqa: E501 1147 1148 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1149 1150 :return: The conceal_value_on_document of this Zip. # noqa: E501 1151 :rtype: str 1152 """ 1153 return self._conceal_value_on_document 1154 1155 @conceal_value_on_document.setter 1156 def conceal_value_on_document(self, conceal_value_on_document): 1157 """Sets the conceal_value_on_document of this Zip. 1158 1159 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1160 1161 :param conceal_value_on_document: The conceal_value_on_document of this Zip. # noqa: E501 1162 :type: str 1163 """ 1164 1165 self._conceal_value_on_document = conceal_value_on_document 1166 1167 @property 1168 def conceal_value_on_document_metadata(self): 1169 """Gets the conceal_value_on_document_metadata of this Zip. # noqa: E501 1170 1171 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1172 1173 :return: The conceal_value_on_document_metadata of this Zip. # noqa: E501 1174 :rtype: PropertyMetadata 1175 """ 1176 return self._conceal_value_on_document_metadata 1177 1178 @conceal_value_on_document_metadata.setter 1179 def conceal_value_on_document_metadata(self, conceal_value_on_document_metadata): 1180 """Sets the conceal_value_on_document_metadata of this Zip. 1181 1182 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1183 1184 :param conceal_value_on_document_metadata: The conceal_value_on_document_metadata of this Zip. # noqa: E501 1185 :type: PropertyMetadata 1186 """ 1187 1188 self._conceal_value_on_document_metadata = conceal_value_on_document_metadata 1189 1190 @property 1191 def conditional_parent_label(self): 1192 """Gets the conditional_parent_label of this Zip. # noqa: E501 1193 1194 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1195 1196 :return: The conditional_parent_label of this Zip. # noqa: E501 1197 :rtype: str 1198 """ 1199 return self._conditional_parent_label 1200 1201 @conditional_parent_label.setter 1202 def conditional_parent_label(self, conditional_parent_label): 1203 """Sets the conditional_parent_label of this Zip. 1204 1205 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1206 1207 :param conditional_parent_label: The conditional_parent_label of this Zip. # noqa: E501 1208 :type: str 1209 """ 1210 1211 self._conditional_parent_label = conditional_parent_label 1212 1213 @property 1214 def conditional_parent_label_metadata(self): 1215 """Gets the conditional_parent_label_metadata of this Zip. # noqa: E501 1216 1217 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1218 1219 :return: The conditional_parent_label_metadata of this Zip. # noqa: E501 1220 :rtype: PropertyMetadata 1221 """ 1222 return self._conditional_parent_label_metadata 1223 1224 @conditional_parent_label_metadata.setter 1225 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 1226 """Sets the conditional_parent_label_metadata of this Zip. 1227 1228 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1229 1230 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this Zip. # noqa: E501 1231 :type: PropertyMetadata 1232 """ 1233 1234 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1235 1236 @property 1237 def conditional_parent_value(self): 1238 """Gets the conditional_parent_value of this Zip. # noqa: E501 1239 1240 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 1241 1242 :return: The conditional_parent_value of this Zip. # noqa: E501 1243 :rtype: str 1244 """ 1245 return self._conditional_parent_value 1246 1247 @conditional_parent_value.setter 1248 def conditional_parent_value(self, conditional_parent_value): 1249 """Sets the conditional_parent_value of this Zip. 1250 1251 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 1252 1253 :param conditional_parent_value: The conditional_parent_value of this Zip. # noqa: E501 1254 :type: str 1255 """ 1256 1257 self._conditional_parent_value = conditional_parent_value 1258 1259 @property 1260 def conditional_parent_value_metadata(self): 1261 """Gets the conditional_parent_value_metadata of this Zip. # noqa: E501 1262 1263 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1264 1265 :return: The conditional_parent_value_metadata of this Zip. # noqa: E501 1266 :rtype: PropertyMetadata 1267 """ 1268 return self._conditional_parent_value_metadata 1269 1270 @conditional_parent_value_metadata.setter 1271 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1272 """Sets the conditional_parent_value_metadata of this Zip. 1273 1274 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1275 1276 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this Zip. # noqa: E501 1277 :type: PropertyMetadata 1278 """ 1279 1280 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1281 1282 @property 1283 def connected_object_details(self): 1284 """Gets the connected_object_details of this Zip. # noqa: E501 1285 1286 # noqa: E501 1287 1288 :return: The connected_object_details of this Zip. # noqa: E501 1289 :rtype: ConnectedObjectDetails 1290 """ 1291 return self._connected_object_details 1292 1293 @connected_object_details.setter 1294 def connected_object_details(self, connected_object_details): 1295 """Sets the connected_object_details of this Zip. 1296 1297 # noqa: E501 1298 1299 :param connected_object_details: The connected_object_details of this Zip. # noqa: E501 1300 :type: ConnectedObjectDetails 1301 """ 1302 1303 self._connected_object_details = connected_object_details 1304 1305 @property 1306 def custom_tab_id(self): 1307 """Gets the custom_tab_id of this Zip. # noqa: E501 1308 1309 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 1310 1311 :return: The custom_tab_id of this Zip. # noqa: E501 1312 :rtype: str 1313 """ 1314 return self._custom_tab_id 1315 1316 @custom_tab_id.setter 1317 def custom_tab_id(self, custom_tab_id): 1318 """Sets the custom_tab_id of this Zip. 1319 1320 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 1321 1322 :param custom_tab_id: The custom_tab_id of this Zip. # noqa: E501 1323 :type: str 1324 """ 1325 1326 self._custom_tab_id = custom_tab_id 1327 1328 @property 1329 def custom_tab_id_metadata(self): 1330 """Gets the custom_tab_id_metadata of this Zip. # noqa: E501 1331 1332 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1333 1334 :return: The custom_tab_id_metadata of this Zip. # noqa: E501 1335 :rtype: PropertyMetadata 1336 """ 1337 return self._custom_tab_id_metadata 1338 1339 @custom_tab_id_metadata.setter 1340 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1341 """Sets the custom_tab_id_metadata of this Zip. 1342 1343 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1344 1345 :param custom_tab_id_metadata: The custom_tab_id_metadata of this Zip. # noqa: E501 1346 :type: PropertyMetadata 1347 """ 1348 1349 self._custom_tab_id_metadata = custom_tab_id_metadata 1350 1351 @property 1352 def disable_auto_size(self): 1353 """Gets the disable_auto_size of this Zip. # noqa: E501 1354 1355 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1356 1357 :return: The disable_auto_size of this Zip. # noqa: E501 1358 :rtype: str 1359 """ 1360 return self._disable_auto_size 1361 1362 @disable_auto_size.setter 1363 def disable_auto_size(self, disable_auto_size): 1364 """Sets the disable_auto_size of this Zip. 1365 1366 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1367 1368 :param disable_auto_size: The disable_auto_size of this Zip. # noqa: E501 1369 :type: str 1370 """ 1371 1372 self._disable_auto_size = disable_auto_size 1373 1374 @property 1375 def disable_auto_size_metadata(self): 1376 """Gets the disable_auto_size_metadata of this Zip. # noqa: E501 1377 1378 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1379 1380 :return: The disable_auto_size_metadata of this Zip. # noqa: E501 1381 :rtype: PropertyMetadata 1382 """ 1383 return self._disable_auto_size_metadata 1384 1385 @disable_auto_size_metadata.setter 1386 def disable_auto_size_metadata(self, disable_auto_size_metadata): 1387 """Sets the disable_auto_size_metadata of this Zip. 1388 1389 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1390 1391 :param disable_auto_size_metadata: The disable_auto_size_metadata of this Zip. # noqa: E501 1392 :type: PropertyMetadata 1393 """ 1394 1395 self._disable_auto_size_metadata = disable_auto_size_metadata 1396 1397 @property 1398 def document_id(self): 1399 """Gets the document_id of this Zip. # noqa: E501 1400 1401 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1402 1403 :return: The document_id of this Zip. # noqa: E501 1404 :rtype: str 1405 """ 1406 return self._document_id 1407 1408 @document_id.setter 1409 def document_id(self, document_id): 1410 """Sets the document_id of this Zip. 1411 1412 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1413 1414 :param document_id: The document_id of this Zip. # noqa: E501 1415 :type: str 1416 """ 1417 1418 self._document_id = document_id 1419 1420 @property 1421 def document_id_metadata(self): 1422 """Gets the document_id_metadata of this Zip. # noqa: E501 1423 1424 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1425 1426 :return: The document_id_metadata of this Zip. # noqa: E501 1427 :rtype: PropertyMetadata 1428 """ 1429 return self._document_id_metadata 1430 1431 @document_id_metadata.setter 1432 def document_id_metadata(self, document_id_metadata): 1433 """Sets the document_id_metadata of this Zip. 1434 1435 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1436 1437 :param document_id_metadata: The document_id_metadata of this Zip. # noqa: E501 1438 :type: PropertyMetadata 1439 """ 1440 1441 self._document_id_metadata = document_id_metadata 1442 1443 @property 1444 def error_details(self): 1445 """Gets the error_details of this Zip. # noqa: E501 1446 1447 Array or errors. # noqa: E501 1448 1449 :return: The error_details of this Zip. # noqa: E501 1450 :rtype: ErrorDetails 1451 """ 1452 return self._error_details 1453 1454 @error_details.setter 1455 def error_details(self, error_details): 1456 """Sets the error_details of this Zip. 1457 1458 Array or errors. # noqa: E501 1459 1460 :param error_details: The error_details of this Zip. # noqa: E501 1461 :type: ErrorDetails 1462 """ 1463 1464 self._error_details = error_details 1465 1466 @property 1467 def extension_data(self): 1468 """Gets the extension_data of this Zip. # noqa: E501 1469 1470 # noqa: E501 1471 1472 :return: The extension_data of this Zip. # noqa: E501 1473 :rtype: ExtensionData 1474 """ 1475 return self._extension_data 1476 1477 @extension_data.setter 1478 def extension_data(self, extension_data): 1479 """Sets the extension_data of this Zip. 1480 1481 # noqa: E501 1482 1483 :param extension_data: The extension_data of this Zip. # noqa: E501 1484 :type: ExtensionData 1485 """ 1486 1487 self._extension_data = extension_data 1488 1489 @property 1490 def font(self): 1491 """Gets the font of this Zip. # noqa: E501 1492 1493 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 1494 1495 :return: The font of this Zip. # noqa: E501 1496 :rtype: str 1497 """ 1498 return self._font 1499 1500 @font.setter 1501 def font(self, font): 1502 """Sets the font of this Zip. 1503 1504 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 1505 1506 :param font: The font of this Zip. # noqa: E501 1507 :type: str 1508 """ 1509 1510 self._font = font 1511 1512 @property 1513 def font_color(self): 1514 """Gets the font_color of this Zip. # noqa: E501 1515 1516 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 1517 1518 :return: The font_color of this Zip. # noqa: E501 1519 :rtype: str 1520 """ 1521 return self._font_color 1522 1523 @font_color.setter 1524 def font_color(self, font_color): 1525 """Sets the font_color of this Zip. 1526 1527 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 1528 1529 :param font_color: The font_color of this Zip. # noqa: E501 1530 :type: str 1531 """ 1532 1533 self._font_color = font_color 1534 1535 @property 1536 def font_color_metadata(self): 1537 """Gets the font_color_metadata of this Zip. # noqa: E501 1538 1539 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1540 1541 :return: The font_color_metadata of this Zip. # noqa: E501 1542 :rtype: PropertyMetadata 1543 """ 1544 return self._font_color_metadata 1545 1546 @font_color_metadata.setter 1547 def font_color_metadata(self, font_color_metadata): 1548 """Sets the font_color_metadata of this Zip. 1549 1550 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1551 1552 :param font_color_metadata: The font_color_metadata of this Zip. # noqa: E501 1553 :type: PropertyMetadata 1554 """ 1555 1556 self._font_color_metadata = font_color_metadata 1557 1558 @property 1559 def font_metadata(self): 1560 """Gets the font_metadata of this Zip. # noqa: E501 1561 1562 Metadata that indicates whether the `font` property is editable. # noqa: E501 1563 1564 :return: The font_metadata of this Zip. # noqa: E501 1565 :rtype: PropertyMetadata 1566 """ 1567 return self._font_metadata 1568 1569 @font_metadata.setter 1570 def font_metadata(self, font_metadata): 1571 """Sets the font_metadata of this Zip. 1572 1573 Metadata that indicates whether the `font` property is editable. # noqa: E501 1574 1575 :param font_metadata: The font_metadata of this Zip. # noqa: E501 1576 :type: PropertyMetadata 1577 """ 1578 1579 self._font_metadata = font_metadata 1580 1581 @property 1582 def font_size(self): 1583 """Gets the font_size of this Zip. # noqa: E501 1584 1585 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 1586 1587 :return: The font_size of this Zip. # noqa: E501 1588 :rtype: str 1589 """ 1590 return self._font_size 1591 1592 @font_size.setter 1593 def font_size(self, font_size): 1594 """Sets the font_size of this Zip. 1595 1596 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 1597 1598 :param font_size: The font_size of this Zip. # noqa: E501 1599 :type: str 1600 """ 1601 1602 self._font_size = font_size 1603 1604 @property 1605 def font_size_metadata(self): 1606 """Gets the font_size_metadata of this Zip. # noqa: E501 1607 1608 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1609 1610 :return: The font_size_metadata of this Zip. # noqa: E501 1611 :rtype: PropertyMetadata 1612 """ 1613 return self._font_size_metadata 1614 1615 @font_size_metadata.setter 1616 def font_size_metadata(self, font_size_metadata): 1617 """Sets the font_size_metadata of this Zip. 1618 1619 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1620 1621 :param font_size_metadata: The font_size_metadata of this Zip. # noqa: E501 1622 :type: PropertyMetadata 1623 """ 1624 1625 self._font_size_metadata = font_size_metadata 1626 1627 @property 1628 def form_order(self): 1629 """Gets the form_order of this Zip. # noqa: E501 1630 1631 # noqa: E501 1632 1633 :return: The form_order of this Zip. # noqa: E501 1634 :rtype: str 1635 """ 1636 return self._form_order 1637 1638 @form_order.setter 1639 def form_order(self, form_order): 1640 """Sets the form_order of this Zip. 1641 1642 # noqa: E501 1643 1644 :param form_order: The form_order of this Zip. # noqa: E501 1645 :type: str 1646 """ 1647 1648 self._form_order = form_order 1649 1650 @property 1651 def form_order_metadata(self): 1652 """Gets the form_order_metadata of this Zip. # noqa: E501 1653 1654 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1655 1656 :return: The form_order_metadata of this Zip. # noqa: E501 1657 :rtype: PropertyMetadata 1658 """ 1659 return self._form_order_metadata 1660 1661 @form_order_metadata.setter 1662 def form_order_metadata(self, form_order_metadata): 1663 """Sets the form_order_metadata of this Zip. 1664 1665 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1666 1667 :param form_order_metadata: The form_order_metadata of this Zip. # noqa: E501 1668 :type: PropertyMetadata 1669 """ 1670 1671 self._form_order_metadata = form_order_metadata 1672 1673 @property 1674 def form_page_label(self): 1675 """Gets the form_page_label of this Zip. # noqa: E501 1676 1677 # noqa: E501 1678 1679 :return: The form_page_label of this Zip. # noqa: E501 1680 :rtype: str 1681 """ 1682 return self._form_page_label 1683 1684 @form_page_label.setter 1685 def form_page_label(self, form_page_label): 1686 """Sets the form_page_label of this Zip. 1687 1688 # noqa: E501 1689 1690 :param form_page_label: The form_page_label of this Zip. # noqa: E501 1691 :type: str 1692 """ 1693 1694 self._form_page_label = form_page_label 1695 1696 @property 1697 def form_page_label_metadata(self): 1698 """Gets the form_page_label_metadata of this Zip. # noqa: E501 1699 1700 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1701 1702 :return: The form_page_label_metadata of this Zip. # noqa: E501 1703 :rtype: PropertyMetadata 1704 """ 1705 return self._form_page_label_metadata 1706 1707 @form_page_label_metadata.setter 1708 def form_page_label_metadata(self, form_page_label_metadata): 1709 """Sets the form_page_label_metadata of this Zip. 1710 1711 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1712 1713 :param form_page_label_metadata: The form_page_label_metadata of this Zip. # noqa: E501 1714 :type: PropertyMetadata 1715 """ 1716 1717 self._form_page_label_metadata = form_page_label_metadata 1718 1719 @property 1720 def form_page_number(self): 1721 """Gets the form_page_number of this Zip. # noqa: E501 1722 1723 # noqa: E501 1724 1725 :return: The form_page_number of this Zip. # noqa: E501 1726 :rtype: str 1727 """ 1728 return self._form_page_number 1729 1730 @form_page_number.setter 1731 def form_page_number(self, form_page_number): 1732 """Sets the form_page_number of this Zip. 1733 1734 # noqa: E501 1735 1736 :param form_page_number: The form_page_number of this Zip. # noqa: E501 1737 :type: str 1738 """ 1739 1740 self._form_page_number = form_page_number 1741 1742 @property 1743 def form_page_number_metadata(self): 1744 """Gets the form_page_number_metadata of this Zip. # noqa: E501 1745 1746 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1747 1748 :return: The form_page_number_metadata of this Zip. # noqa: E501 1749 :rtype: PropertyMetadata 1750 """ 1751 return self._form_page_number_metadata 1752 1753 @form_page_number_metadata.setter 1754 def form_page_number_metadata(self, form_page_number_metadata): 1755 """Sets the form_page_number_metadata of this Zip. 1756 1757 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1758 1759 :param form_page_number_metadata: The form_page_number_metadata of this Zip. # noqa: E501 1760 :type: PropertyMetadata 1761 """ 1762 1763 self._form_page_number_metadata = form_page_number_metadata 1764 1765 @property 1766 def height(self): 1767 """Gets the height of this Zip. # noqa: E501 1768 1769 Height of the tab in pixels. # noqa: E501 1770 1771 :return: The height of this Zip. # noqa: E501 1772 :rtype: str 1773 """ 1774 return self._height 1775 1776 @height.setter 1777 def height(self, height): 1778 """Sets the height of this Zip. 1779 1780 Height of the tab in pixels. # noqa: E501 1781 1782 :param height: The height of this Zip. # noqa: E501 1783 :type: str 1784 """ 1785 1786 self._height = height 1787 1788 @property 1789 def height_metadata(self): 1790 """Gets the height_metadata of this Zip. # noqa: E501 1791 1792 Metadata that indicates whether the `height` property is editable. # noqa: E501 1793 1794 :return: The height_metadata of this Zip. # noqa: E501 1795 :rtype: PropertyMetadata 1796 """ 1797 return self._height_metadata 1798 1799 @height_metadata.setter 1800 def height_metadata(self, height_metadata): 1801 """Sets the height_metadata of this Zip. 1802 1803 Metadata that indicates whether the `height` property is editable. # noqa: E501 1804 1805 :param height_metadata: The height_metadata of this Zip. # noqa: E501 1806 :type: PropertyMetadata 1807 """ 1808 1809 self._height_metadata = height_metadata 1810 1811 @property 1812 def italic(self): 1813 """Gets the italic of this Zip. # noqa: E501 1814 1815 When set to **true**, the information in the tab is italic. # noqa: E501 1816 1817 :return: The italic of this Zip. # noqa: E501 1818 :rtype: str 1819 """ 1820 return self._italic 1821 1822 @italic.setter 1823 def italic(self, italic): 1824 """Sets the italic of this Zip. 1825 1826 When set to **true**, the information in the tab is italic. # noqa: E501 1827 1828 :param italic: The italic of this Zip. # noqa: E501 1829 :type: str 1830 """ 1831 1832 self._italic = italic 1833 1834 @property 1835 def italic_metadata(self): 1836 """Gets the italic_metadata of this Zip. # noqa: E501 1837 1838 Metadata that indicates whether the `italic` property is editable. # noqa: E501 1839 1840 :return: The italic_metadata of this Zip. # noqa: E501 1841 :rtype: PropertyMetadata 1842 """ 1843 return self._italic_metadata 1844 1845 @italic_metadata.setter 1846 def italic_metadata(self, italic_metadata): 1847 """Sets the italic_metadata of this Zip. 1848 1849 Metadata that indicates whether the `italic` property is editable. # noqa: E501 1850 1851 :param italic_metadata: The italic_metadata of this Zip. # noqa: E501 1852 :type: PropertyMetadata 1853 """ 1854 1855 self._italic_metadata = italic_metadata 1856 1857 @property 1858 def locale_policy(self): 1859 """Gets the locale_policy of this Zip. # noqa: E501 1860 1861 Reserved for DocuSign. # noqa: E501 1862 1863 :return: The locale_policy of this Zip. # noqa: E501 1864 :rtype: LocalePolicyTab 1865 """ 1866 return self._locale_policy 1867 1868 @locale_policy.setter 1869 def locale_policy(self, locale_policy): 1870 """Sets the locale_policy of this Zip. 1871 1872 Reserved for DocuSign. # noqa: E501 1873 1874 :param locale_policy: The locale_policy of this Zip. # noqa: E501 1875 :type: LocalePolicyTab 1876 """ 1877 1878 self._locale_policy = locale_policy 1879 1880 @property 1881 def locked(self): 1882 """Gets the locked of this Zip. # noqa: E501 1883 1884 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 1885 1886 :return: The locked of this Zip. # noqa: E501 1887 :rtype: str 1888 """ 1889 return self._locked 1890 1891 @locked.setter 1892 def locked(self, locked): 1893 """Sets the locked of this Zip. 1894 1895 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 1896 1897 :param locked: The locked of this Zip. # noqa: E501 1898 :type: str 1899 """ 1900 1901 self._locked = locked 1902 1903 @property 1904 def locked_metadata(self): 1905 """Gets the locked_metadata of this Zip. # noqa: E501 1906 1907 Metadata that indicates whether the `locked` property is editable. # noqa: E501 1908 1909 :return: The locked_metadata of this Zip. # noqa: E501 1910 :rtype: PropertyMetadata 1911 """ 1912 return self._locked_metadata 1913 1914 @locked_metadata.setter 1915 def locked_metadata(self, locked_metadata): 1916 """Sets the locked_metadata of this Zip. 1917 1918 Metadata that indicates whether the `locked` property is editable. # noqa: E501 1919 1920 :param locked_metadata: The locked_metadata of this Zip. # noqa: E501 1921 :type: PropertyMetadata 1922 """ 1923 1924 self._locked_metadata = locked_metadata 1925 1926 @property 1927 def max_length(self): 1928 """Gets the max_length of this Zip. # noqa: E501 1929 1930 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 1931 1932 :return: The max_length of this Zip. # noqa: E501 1933 :rtype: str 1934 """ 1935 return self._max_length 1936 1937 @max_length.setter 1938 def max_length(self, max_length): 1939 """Sets the max_length of this Zip. 1940 1941 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 1942 1943 :param max_length: The max_length of this Zip. # noqa: E501 1944 :type: str 1945 """ 1946 1947 self._max_length = max_length 1948 1949 @property 1950 def max_length_metadata(self): 1951 """Gets the max_length_metadata of this Zip. # noqa: E501 1952 1953 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 1954 1955 :return: The max_length_metadata of this Zip. # noqa: E501 1956 :rtype: PropertyMetadata 1957 """ 1958 return self._max_length_metadata 1959 1960 @max_length_metadata.setter 1961 def max_length_metadata(self, max_length_metadata): 1962 """Sets the max_length_metadata of this Zip. 1963 1964 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 1965 1966 :param max_length_metadata: The max_length_metadata of this Zip. # noqa: E501 1967 :type: PropertyMetadata 1968 """ 1969 1970 self._max_length_metadata = max_length_metadata 1971 1972 @property 1973 def merge_field(self): 1974 """Gets the merge_field of this Zip. # noqa: E501 1975 1976 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1977 1978 :return: The merge_field of this Zip. # noqa: E501 1979 :rtype: MergeField 1980 """ 1981 return self._merge_field 1982 1983 @merge_field.setter 1984 def merge_field(self, merge_field): 1985 """Sets the merge_field of this Zip. 1986 1987 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1988 1989 :param merge_field: The merge_field of this Zip. # noqa: E501 1990 :type: MergeField 1991 """ 1992 1993 self._merge_field = merge_field 1994 1995 @property 1996 def merge_field_xml(self): 1997 """Gets the merge_field_xml of this Zip. # noqa: E501 1998 1999 # noqa: E501 2000 2001 :return: The merge_field_xml of this Zip. # noqa: E501 2002 :rtype: str 2003 """ 2004 return self._merge_field_xml 2005 2006 @merge_field_xml.setter 2007 def merge_field_xml(self, merge_field_xml): 2008 """Sets the merge_field_xml of this Zip. 2009 2010 # noqa: E501 2011 2012 :param merge_field_xml: The merge_field_xml of this Zip. # noqa: E501 2013 :type: str 2014 """ 2015 2016 self._merge_field_xml = merge_field_xml 2017 2018 @property 2019 def name(self): 2020 """Gets the name of this Zip. # noqa: E501 2021 2022 # noqa: E501 2023 2024 :return: The name of this Zip. # noqa: E501 2025 :rtype: str 2026 """ 2027 return self._name 2028 2029 @name.setter 2030 def name(self, name): 2031 """Sets the name of this Zip. 2032 2033 # noqa: E501 2034 2035 :param name: The name of this Zip. # noqa: E501 2036 :type: str 2037 """ 2038 2039 self._name = name 2040 2041 @property 2042 def name_metadata(self): 2043 """Gets the name_metadata of this Zip. # noqa: E501 2044 2045 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2046 2047 :return: The name_metadata of this Zip. # noqa: E501 2048 :rtype: PropertyMetadata 2049 """ 2050 return self._name_metadata 2051 2052 @name_metadata.setter 2053 def name_metadata(self, name_metadata): 2054 """Sets the name_metadata of this Zip. 2055 2056 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2057 2058 :param name_metadata: The name_metadata of this Zip. # noqa: E501 2059 :type: PropertyMetadata 2060 """ 2061 2062 self._name_metadata = name_metadata 2063 2064 @property 2065 def original_value(self): 2066 """Gets the original_value of this Zip. # noqa: E501 2067 2068 The initial value of the tab when it was sent to the recipient. # noqa: E501 2069 2070 :return: The original_value of this Zip. # noqa: E501 2071 :rtype: str 2072 """ 2073 return self._original_value 2074 2075 @original_value.setter 2076 def original_value(self, original_value): 2077 """Sets the original_value of this Zip. 2078 2079 The initial value of the tab when it was sent to the recipient. # noqa: E501 2080 2081 :param original_value: The original_value of this Zip. # noqa: E501 2082 :type: str 2083 """ 2084 2085 self._original_value = original_value 2086 2087 @property 2088 def original_value_metadata(self): 2089 """Gets the original_value_metadata of this Zip. # noqa: E501 2090 2091 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2092 2093 :return: The original_value_metadata of this Zip. # noqa: E501 2094 :rtype: PropertyMetadata 2095 """ 2096 return self._original_value_metadata 2097 2098 @original_value_metadata.setter 2099 def original_value_metadata(self, original_value_metadata): 2100 """Sets the original_value_metadata of this Zip. 2101 2102 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2103 2104 :param original_value_metadata: The original_value_metadata of this Zip. # noqa: E501 2105 :type: PropertyMetadata 2106 """ 2107 2108 self._original_value_metadata = original_value_metadata 2109 2110 @property 2111 def page_number(self): 2112 """Gets the page_number of this Zip. # noqa: E501 2113 2114 Specifies the page number on which the tab is located. # noqa: E501 2115 2116 :return: The page_number of this Zip. # noqa: E501 2117 :rtype: str 2118 """ 2119 return self._page_number 2120 2121 @page_number.setter 2122 def page_number(self, page_number): 2123 """Sets the page_number of this Zip. 2124 2125 Specifies the page number on which the tab is located. # noqa: E501 2126 2127 :param page_number: The page_number of this Zip. # noqa: E501 2128 :type: str 2129 """ 2130 2131 self._page_number = page_number 2132 2133 @property 2134 def page_number_metadata(self): 2135 """Gets the page_number_metadata of this Zip. # noqa: E501 2136 2137 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2138 2139 :return: The page_number_metadata of this Zip. # noqa: E501 2140 :rtype: PropertyMetadata 2141 """ 2142 return self._page_number_metadata 2143 2144 @page_number_metadata.setter 2145 def page_number_metadata(self, page_number_metadata): 2146 """Sets the page_number_metadata of this Zip. 2147 2148 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2149 2150 :param page_number_metadata: The page_number_metadata of this Zip. # noqa: E501 2151 :type: PropertyMetadata 2152 """ 2153 2154 self._page_number_metadata = page_number_metadata 2155 2156 @property 2157 def recipient_id(self): 2158 """Gets the recipient_id of this Zip. # noqa: E501 2159 2160 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2161 2162 :return: The recipient_id of this Zip. # noqa: E501 2163 :rtype: str 2164 """ 2165 return self._recipient_id 2166 2167 @recipient_id.setter 2168 def recipient_id(self, recipient_id): 2169 """Sets the recipient_id of this Zip. 2170 2171 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2172 2173 :param recipient_id: The recipient_id of this Zip. # noqa: E501 2174 :type: str 2175 """ 2176 2177 self._recipient_id = recipient_id 2178 2179 @property 2180 def recipient_id_guid(self): 2181 """Gets the recipient_id_guid of this Zip. # noqa: E501 2182 2183 # noqa: E501 2184 2185 :return: The recipient_id_guid of this Zip. # noqa: E501 2186 :rtype: str 2187 """ 2188 return self._recipient_id_guid 2189 2190 @recipient_id_guid.setter 2191 def recipient_id_guid(self, recipient_id_guid): 2192 """Sets the recipient_id_guid of this Zip. 2193 2194 # noqa: E501 2195 2196 :param recipient_id_guid: The recipient_id_guid of this Zip. # noqa: E501 2197 :type: str 2198 """ 2199 2200 self._recipient_id_guid = recipient_id_guid 2201 2202 @property 2203 def recipient_id_guid_metadata(self): 2204 """Gets the recipient_id_guid_metadata of this Zip. # noqa: E501 2205 2206 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2207 2208 :return: The recipient_id_guid_metadata of this Zip. # noqa: E501 2209 :rtype: PropertyMetadata 2210 """ 2211 return self._recipient_id_guid_metadata 2212 2213 @recipient_id_guid_metadata.setter 2214 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 2215 """Sets the recipient_id_guid_metadata of this Zip. 2216 2217 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2218 2219 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this Zip. # noqa: E501 2220 :type: PropertyMetadata 2221 """ 2222 2223 self._recipient_id_guid_metadata = recipient_id_guid_metadata 2224 2225 @property 2226 def recipient_id_metadata(self): 2227 """Gets the recipient_id_metadata of this Zip. # noqa: E501 2228 2229 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2230 2231 :return: The recipient_id_metadata of this Zip. # noqa: E501 2232 :rtype: PropertyMetadata 2233 """ 2234 return self._recipient_id_metadata 2235 2236 @recipient_id_metadata.setter 2237 def recipient_id_metadata(self, recipient_id_metadata): 2238 """Sets the recipient_id_metadata of this Zip. 2239 2240 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2241 2242 :param recipient_id_metadata: The recipient_id_metadata of this Zip. # noqa: E501 2243 :type: PropertyMetadata 2244 """ 2245 2246 self._recipient_id_metadata = recipient_id_metadata 2247 2248 @property 2249 def require_all(self): 2250 """Gets the require_all of this Zip. # noqa: E501 2251 2252 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2253 2254 :return: The require_all of this Zip. # noqa: E501 2255 :rtype: str 2256 """ 2257 return self._require_all 2258 2259 @require_all.setter 2260 def require_all(self, require_all): 2261 """Sets the require_all of this Zip. 2262 2263 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2264 2265 :param require_all: The require_all of this Zip. # noqa: E501 2266 :type: str 2267 """ 2268 2269 self._require_all = require_all 2270 2271 @property 2272 def require_all_metadata(self): 2273 """Gets the require_all_metadata of this Zip. # noqa: E501 2274 2275 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2276 2277 :return: The require_all_metadata of this Zip. # noqa: E501 2278 :rtype: PropertyMetadata 2279 """ 2280 return self._require_all_metadata 2281 2282 @require_all_metadata.setter 2283 def require_all_metadata(self, require_all_metadata): 2284 """Sets the require_all_metadata of this Zip. 2285 2286 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2287 2288 :param require_all_metadata: The require_all_metadata of this Zip. # noqa: E501 2289 :type: PropertyMetadata 2290 """ 2291 2292 self._require_all_metadata = require_all_metadata 2293 2294 @property 2295 def required(self): 2296 """Gets the required of this Zip. # noqa: E501 2297 2298 When set to **true**, the signer is required to fill out this tab # noqa: E501 2299 2300 :return: The required of this Zip. # noqa: E501 2301 :rtype: str 2302 """ 2303 return self._required 2304 2305 @required.setter 2306 def required(self, required): 2307 """Sets the required of this Zip. 2308 2309 When set to **true**, the signer is required to fill out this tab # noqa: E501 2310 2311 :param required: The required of this Zip. # noqa: E501 2312 :type: str 2313 """ 2314 2315 self._required = required 2316 2317 @property 2318 def required_metadata(self): 2319 """Gets the required_metadata of this Zip. # noqa: E501 2320 2321 Metadata that indicates whether the `required` property is editable. # noqa: E501 2322 2323 :return: The required_metadata of this Zip. # noqa: E501 2324 :rtype: PropertyMetadata 2325 """ 2326 return self._required_metadata 2327 2328 @required_metadata.setter 2329 def required_metadata(self, required_metadata): 2330 """Sets the required_metadata of this Zip. 2331 2332 Metadata that indicates whether the `required` property is editable. # noqa: E501 2333 2334 :param required_metadata: The required_metadata of this Zip. # noqa: E501 2335 :type: PropertyMetadata 2336 """ 2337 2338 self._required_metadata = required_metadata 2339 2340 @property 2341 def require_initial_on_shared_change(self): 2342 """Gets the require_initial_on_shared_change of this Zip. # noqa: E501 2343 2344 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2345 2346 :return: The require_initial_on_shared_change of this Zip. # noqa: E501 2347 :rtype: str 2348 """ 2349 return self._require_initial_on_shared_change 2350 2351 @require_initial_on_shared_change.setter 2352 def require_initial_on_shared_change(self, require_initial_on_shared_change): 2353 """Sets the require_initial_on_shared_change of this Zip. 2354 2355 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2356 2357 :param require_initial_on_shared_change: The require_initial_on_shared_change of this Zip. # noqa: E501 2358 :type: str 2359 """ 2360 2361 self._require_initial_on_shared_change = require_initial_on_shared_change 2362 2363 @property 2364 def require_initial_on_shared_change_metadata(self): 2365 """Gets the require_initial_on_shared_change_metadata of this Zip. # noqa: E501 2366 2367 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2368 2369 :return: The require_initial_on_shared_change_metadata of this Zip. # noqa: E501 2370 :rtype: PropertyMetadata 2371 """ 2372 return self._require_initial_on_shared_change_metadata 2373 2374 @require_initial_on_shared_change_metadata.setter 2375 def require_initial_on_shared_change_metadata(self, require_initial_on_shared_change_metadata): 2376 """Sets the require_initial_on_shared_change_metadata of this Zip. 2377 2378 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2379 2380 :param require_initial_on_shared_change_metadata: The require_initial_on_shared_change_metadata of this Zip. # noqa: E501 2381 :type: PropertyMetadata 2382 """ 2383 2384 self._require_initial_on_shared_change_metadata = require_initial_on_shared_change_metadata 2385 2386 @property 2387 def sender_required(self): 2388 """Gets the sender_required of this Zip. # noqa: E501 2389 2390 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2391 2392 :return: The sender_required of this Zip. # noqa: E501 2393 :rtype: str 2394 """ 2395 return self._sender_required 2396 2397 @sender_required.setter 2398 def sender_required(self, sender_required): 2399 """Sets the sender_required of this Zip. 2400 2401 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2402 2403 :param sender_required: The sender_required of this Zip. # noqa: E501 2404 :type: str 2405 """ 2406 2407 self._sender_required = sender_required 2408 2409 @property 2410 def sender_required_metadata(self): 2411 """Gets the sender_required_metadata of this Zip. # noqa: E501 2412 2413 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2414 2415 :return: The sender_required_metadata of this Zip. # noqa: E501 2416 :rtype: PropertyMetadata 2417 """ 2418 return self._sender_required_metadata 2419 2420 @sender_required_metadata.setter 2421 def sender_required_metadata(self, sender_required_metadata): 2422 """Sets the sender_required_metadata of this Zip. 2423 2424 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2425 2426 :param sender_required_metadata: The sender_required_metadata of this Zip. # noqa: E501 2427 :type: PropertyMetadata 2428 """ 2429 2430 self._sender_required_metadata = sender_required_metadata 2431 2432 @property 2433 def shared(self): 2434 """Gets the shared of this Zip. # noqa: E501 2435 2436 When set to **true**, this custom tab is shared. # noqa: E501 2437 2438 :return: The shared of this Zip. # noqa: E501 2439 :rtype: str 2440 """ 2441 return self._shared 2442 2443 @shared.setter 2444 def shared(self, shared): 2445 """Sets the shared of this Zip. 2446 2447 When set to **true**, this custom tab is shared. # noqa: E501 2448 2449 :param shared: The shared of this Zip. # noqa: E501 2450 :type: str 2451 """ 2452 2453 self._shared = shared 2454 2455 @property 2456 def shared_metadata(self): 2457 """Gets the shared_metadata of this Zip. # noqa: E501 2458 2459 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2460 2461 :return: The shared_metadata of this Zip. # noqa: E501 2462 :rtype: PropertyMetadata 2463 """ 2464 return self._shared_metadata 2465 2466 @shared_metadata.setter 2467 def shared_metadata(self, shared_metadata): 2468 """Sets the shared_metadata of this Zip. 2469 2470 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2471 2472 :param shared_metadata: The shared_metadata of this Zip. # noqa: E501 2473 :type: PropertyMetadata 2474 """ 2475 2476 self._shared_metadata = shared_metadata 2477 2478 @property 2479 def share_to_recipients(self): 2480 """Gets the share_to_recipients of this Zip. # noqa: E501 2481 2482 # noqa: E501 2483 2484 :return: The share_to_recipients of this Zip. # noqa: E501 2485 :rtype: str 2486 """ 2487 return self._share_to_recipients 2488 2489 @share_to_recipients.setter 2490 def share_to_recipients(self, share_to_recipients): 2491 """Sets the share_to_recipients of this Zip. 2492 2493 # noqa: E501 2494 2495 :param share_to_recipients: The share_to_recipients of this Zip. # noqa: E501 2496 :type: str 2497 """ 2498 2499 self._share_to_recipients = share_to_recipients 2500 2501 @property 2502 def share_to_recipients_metadata(self): 2503 """Gets the share_to_recipients_metadata of this Zip. # noqa: E501 2504 2505 Reserved for DocuSign. # noqa: E501 2506 2507 :return: The share_to_recipients_metadata of this Zip. # noqa: E501 2508 :rtype: PropertyMetadata 2509 """ 2510 return self._share_to_recipients_metadata 2511 2512 @share_to_recipients_metadata.setter 2513 def share_to_recipients_metadata(self, share_to_recipients_metadata): 2514 """Sets the share_to_recipients_metadata of this Zip. 2515 2516 Reserved for DocuSign. # noqa: E501 2517 2518 :param share_to_recipients_metadata: The share_to_recipients_metadata of this Zip. # noqa: E501 2519 :type: PropertyMetadata 2520 """ 2521 2522 self._share_to_recipients_metadata = share_to_recipients_metadata 2523 2524 @property 2525 def smart_contract_information(self): 2526 """Gets the smart_contract_information of this Zip. # noqa: E501 2527 2528 Reserved for DocuSign. # noqa: E501 2529 2530 :return: The smart_contract_information of this Zip. # noqa: E501 2531 :rtype: SmartContractInformation 2532 """ 2533 return self._smart_contract_information 2534 2535 @smart_contract_information.setter 2536 def smart_contract_information(self, smart_contract_information): 2537 """Sets the smart_contract_information of this Zip. 2538 2539 Reserved for DocuSign. # noqa: E501 2540 2541 :param smart_contract_information: The smart_contract_information of this Zip. # noqa: E501 2542 :type: SmartContractInformation 2543 """ 2544 2545 self._smart_contract_information = smart_contract_information 2546 2547 @property 2548 def source(self): 2549 """Gets the source of this Zip. # noqa: E501 2550 2551 # noqa: E501 2552 2553 :return: The source of this Zip. # noqa: E501 2554 :rtype: str 2555 """ 2556 return self._source 2557 2558 @source.setter 2559 def source(self, source): 2560 """Sets the source of this Zip. 2561 2562 # noqa: E501 2563 2564 :param source: The source of this Zip. # noqa: E501 2565 :type: str 2566 """ 2567 2568 self._source = source 2569 2570 @property 2571 def status(self): 2572 """Gets the status of this Zip. # noqa: E501 2573 2574 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 2575 2576 :return: The status of this Zip. # noqa: E501 2577 :rtype: str 2578 """ 2579 return self._status 2580 2581 @status.setter 2582 def status(self, status): 2583 """Sets the status of this Zip. 2584 2585 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 2586 2587 :param status: The status of this Zip. # noqa: E501 2588 :type: str 2589 """ 2590 2591 self._status = status 2592 2593 @property 2594 def status_metadata(self): 2595 """Gets the status_metadata of this Zip. # noqa: E501 2596 2597 Metadata that indicates whether the `status` property is editable. # noqa: E501 2598 2599 :return: The status_metadata of this Zip. # noqa: E501 2600 :rtype: PropertyMetadata 2601 """ 2602 return self._status_metadata 2603 2604 @status_metadata.setter 2605 def status_metadata(self, status_metadata): 2606 """Sets the status_metadata of this Zip. 2607 2608 Metadata that indicates whether the `status` property is editable. # noqa: E501 2609 2610 :param status_metadata: The status_metadata of this Zip. # noqa: E501 2611 :type: PropertyMetadata 2612 """ 2613 2614 self._status_metadata = status_metadata 2615 2616 @property 2617 def tab_fully_qualified_path(self): 2618 """Gets the tab_fully_qualified_path of this Zip. # noqa: E501 2619 2620 # noqa: E501 2621 2622 :return: The tab_fully_qualified_path of this Zip. # noqa: E501 2623 :rtype: str 2624 """ 2625 return self._tab_fully_qualified_path 2626 2627 @tab_fully_qualified_path.setter 2628 def tab_fully_qualified_path(self, tab_fully_qualified_path): 2629 """Sets the tab_fully_qualified_path of this Zip. 2630 2631 # noqa: E501 2632 2633 :param tab_fully_qualified_path: The tab_fully_qualified_path of this Zip. # noqa: E501 2634 :type: str 2635 """ 2636 2637 self._tab_fully_qualified_path = tab_fully_qualified_path 2638 2639 @property 2640 def tab_group_labels(self): 2641 """Gets the tab_group_labels of this Zip. # noqa: E501 2642 2643 # noqa: E501 2644 2645 :return: The tab_group_labels of this Zip. # noqa: E501 2646 :rtype: list[str] 2647 """ 2648 return self._tab_group_labels 2649 2650 @tab_group_labels.setter 2651 def tab_group_labels(self, tab_group_labels): 2652 """Sets the tab_group_labels of this Zip. 2653 2654 # noqa: E501 2655 2656 :param tab_group_labels: The tab_group_labels of this Zip. # noqa: E501 2657 :type: list[str] 2658 """ 2659 2660 self._tab_group_labels = tab_group_labels 2661 2662 @property 2663 def tab_group_labels_metadata(self): 2664 """Gets the tab_group_labels_metadata of this Zip. # noqa: E501 2665 2666 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2667 2668 :return: The tab_group_labels_metadata of this Zip. # noqa: E501 2669 :rtype: PropertyMetadata 2670 """ 2671 return self._tab_group_labels_metadata 2672 2673 @tab_group_labels_metadata.setter 2674 def tab_group_labels_metadata(self, tab_group_labels_metadata): 2675 """Sets the tab_group_labels_metadata of this Zip. 2676 2677 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2678 2679 :param tab_group_labels_metadata: The tab_group_labels_metadata of this Zip. # noqa: E501 2680 :type: PropertyMetadata 2681 """ 2682 2683 self._tab_group_labels_metadata = tab_group_labels_metadata 2684 2685 @property 2686 def tab_id(self): 2687 """Gets the tab_id of this Zip. # noqa: E501 2688 2689 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2690 2691 :return: The tab_id of this Zip. # noqa: E501 2692 :rtype: str 2693 """ 2694 return self._tab_id 2695 2696 @tab_id.setter 2697 def tab_id(self, tab_id): 2698 """Sets the tab_id of this Zip. 2699 2700 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2701 2702 :param tab_id: The tab_id of this Zip. # noqa: E501 2703 :type: str 2704 """ 2705 2706 self._tab_id = tab_id 2707 2708 @property 2709 def tab_id_metadata(self): 2710 """Gets the tab_id_metadata of this Zip. # noqa: E501 2711 2712 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2713 2714 :return: The tab_id_metadata of this Zip. # noqa: E501 2715 :rtype: PropertyMetadata 2716 """ 2717 return self._tab_id_metadata 2718 2719 @tab_id_metadata.setter 2720 def tab_id_metadata(self, tab_id_metadata): 2721 """Sets the tab_id_metadata of this Zip. 2722 2723 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2724 2725 :param tab_id_metadata: The tab_id_metadata of this Zip. # noqa: E501 2726 :type: PropertyMetadata 2727 """ 2728 2729 self._tab_id_metadata = tab_id_metadata 2730 2731 @property 2732 def tab_label(self): 2733 """Gets the tab_label of this Zip. # noqa: E501 2734 2735 The label string associated with the tab. # noqa: E501 2736 2737 :return: The tab_label of this Zip. # noqa: E501 2738 :rtype: str 2739 """ 2740 return self._tab_label 2741 2742 @tab_label.setter 2743 def tab_label(self, tab_label): 2744 """Sets the tab_label of this Zip. 2745 2746 The label string associated with the tab. # noqa: E501 2747 2748 :param tab_label: The tab_label of this Zip. # noqa: E501 2749 :type: str 2750 """ 2751 2752 self._tab_label = tab_label 2753 2754 @property 2755 def tab_label_metadata(self): 2756 """Gets the tab_label_metadata of this Zip. # noqa: E501 2757 2758 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 2759 2760 :return: The tab_label_metadata of this Zip. # noqa: E501 2761 :rtype: PropertyMetadata 2762 """ 2763 return self._tab_label_metadata 2764 2765 @tab_label_metadata.setter 2766 def tab_label_metadata(self, tab_label_metadata): 2767 """Sets the tab_label_metadata of this Zip. 2768 2769 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 2770 2771 :param tab_label_metadata: The tab_label_metadata of this Zip. # noqa: E501 2772 :type: PropertyMetadata 2773 """ 2774 2775 self._tab_label_metadata = tab_label_metadata 2776 2777 @property 2778 def tab_order(self): 2779 """Gets the tab_order of this Zip. # noqa: E501 2780 2781 # noqa: E501 2782 2783 :return: The tab_order of this Zip. # noqa: E501 2784 :rtype: str 2785 """ 2786 return self._tab_order 2787 2788 @tab_order.setter 2789 def tab_order(self, tab_order): 2790 """Sets the tab_order of this Zip. 2791 2792 # noqa: E501 2793 2794 :param tab_order: The tab_order of this Zip. # noqa: E501 2795 :type: str 2796 """ 2797 2798 self._tab_order = tab_order 2799 2800 @property 2801 def tab_order_metadata(self): 2802 """Gets the tab_order_metadata of this Zip. # noqa: E501 2803 2804 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 2805 2806 :return: The tab_order_metadata of this Zip. # noqa: E501 2807 :rtype: PropertyMetadata 2808 """ 2809 return self._tab_order_metadata 2810 2811 @tab_order_metadata.setter 2812 def tab_order_metadata(self, tab_order_metadata): 2813 """Sets the tab_order_metadata of this Zip. 2814 2815 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 2816 2817 :param tab_order_metadata: The tab_order_metadata of this Zip. # noqa: E501 2818 :type: PropertyMetadata 2819 """ 2820 2821 self._tab_order_metadata = tab_order_metadata 2822 2823 @property 2824 def tab_type(self): 2825 """Gets the tab_type of this Zip. # noqa: E501 2826 2827 # noqa: E501 2828 2829 :return: The tab_type of this Zip. # noqa: E501 2830 :rtype: str 2831 """ 2832 return self._tab_type 2833 2834 @tab_type.setter 2835 def tab_type(self, tab_type): 2836 """Sets the tab_type of this Zip. 2837 2838 # noqa: E501 2839 2840 :param tab_type: The tab_type of this Zip. # noqa: E501 2841 :type: str 2842 """ 2843 2844 self._tab_type = tab_type 2845 2846 @property 2847 def tab_type_metadata(self): 2848 """Gets the tab_type_metadata of this Zip. # noqa: E501 2849 2850 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2851 2852 :return: The tab_type_metadata of this Zip. # noqa: E501 2853 :rtype: PropertyMetadata 2854 """ 2855 return self._tab_type_metadata 2856 2857 @tab_type_metadata.setter 2858 def tab_type_metadata(self, tab_type_metadata): 2859 """Sets the tab_type_metadata of this Zip. 2860 2861 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2862 2863 :param tab_type_metadata: The tab_type_metadata of this Zip. # noqa: E501 2864 :type: PropertyMetadata 2865 """ 2866 2867 self._tab_type_metadata = tab_type_metadata 2868 2869 @property 2870 def template_locked(self): 2871 """Gets the template_locked of this Zip. # noqa: E501 2872 2873 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2874 2875 :return: The template_locked of this Zip. # noqa: E501 2876 :rtype: str 2877 """ 2878 return self._template_locked 2879 2880 @template_locked.setter 2881 def template_locked(self, template_locked): 2882 """Sets the template_locked of this Zip. 2883 2884 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2885 2886 :param template_locked: The template_locked of this Zip. # noqa: E501 2887 :type: str 2888 """ 2889 2890 self._template_locked = template_locked 2891 2892 @property 2893 def template_locked_metadata(self): 2894 """Gets the template_locked_metadata of this Zip. # noqa: E501 2895 2896 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2897 2898 :return: The template_locked_metadata of this Zip. # noqa: E501 2899 :rtype: PropertyMetadata 2900 """ 2901 return self._template_locked_metadata 2902 2903 @template_locked_metadata.setter 2904 def template_locked_metadata(self, template_locked_metadata): 2905 """Sets the template_locked_metadata of this Zip. 2906 2907 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2908 2909 :param template_locked_metadata: The template_locked_metadata of this Zip. # noqa: E501 2910 :type: PropertyMetadata 2911 """ 2912 2913 self._template_locked_metadata = template_locked_metadata 2914 2915 @property 2916 def template_required(self): 2917 """Gets the template_required of this Zip. # noqa: E501 2918 2919 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2920 2921 :return: The template_required of this Zip. # noqa: E501 2922 :rtype: str 2923 """ 2924 return self._template_required 2925 2926 @template_required.setter 2927 def template_required(self, template_required): 2928 """Sets the template_required of this Zip. 2929 2930 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2931 2932 :param template_required: The template_required of this Zip. # noqa: E501 2933 :type: str 2934 """ 2935 2936 self._template_required = template_required 2937 2938 @property 2939 def template_required_metadata(self): 2940 """Gets the template_required_metadata of this Zip. # noqa: E501 2941 2942 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2943 2944 :return: The template_required_metadata of this Zip. # noqa: E501 2945 :rtype: PropertyMetadata 2946 """ 2947 return self._template_required_metadata 2948 2949 @template_required_metadata.setter 2950 def template_required_metadata(self, template_required_metadata): 2951 """Sets the template_required_metadata of this Zip. 2952 2953 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2954 2955 :param template_required_metadata: The template_required_metadata of this Zip. # noqa: E501 2956 :type: PropertyMetadata 2957 """ 2958 2959 self._template_required_metadata = template_required_metadata 2960 2961 @property 2962 def tooltip(self): 2963 """Gets the tooltip of this Zip. # noqa: E501 2964 2965 # noqa: E501 2966 2967 :return: The tooltip of this Zip. # noqa: E501 2968 :rtype: str 2969 """ 2970 return self._tooltip 2971 2972 @tooltip.setter 2973 def tooltip(self, tooltip): 2974 """Sets the tooltip of this Zip. 2975 2976 # noqa: E501 2977 2978 :param tooltip: The tooltip of this Zip. # noqa: E501 2979 :type: str 2980 """ 2981 2982 self._tooltip = tooltip 2983 2984 @property 2985 def tool_tip_metadata(self): 2986 """Gets the tool_tip_metadata of this Zip. # noqa: E501 2987 2988 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2989 2990 :return: The tool_tip_metadata of this Zip. # noqa: E501 2991 :rtype: PropertyMetadata 2992 """ 2993 return self._tool_tip_metadata 2994 2995 @tool_tip_metadata.setter 2996 def tool_tip_metadata(self, tool_tip_metadata): 2997 """Sets the tool_tip_metadata of this Zip. 2998 2999 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3000 3001 :param tool_tip_metadata: The tool_tip_metadata of this Zip. # noqa: E501 3002 :type: PropertyMetadata 3003 """ 3004 3005 self._tool_tip_metadata = tool_tip_metadata 3006 3007 @property 3008 def underline(self): 3009 """Gets the underline of this Zip. # noqa: E501 3010 3011 When set to **true**, the information in the tab is underlined. # noqa: E501 3012 3013 :return: The underline of this Zip. # noqa: E501 3014 :rtype: str 3015 """ 3016 return self._underline 3017 3018 @underline.setter 3019 def underline(self, underline): 3020 """Sets the underline of this Zip. 3021 3022 When set to **true**, the information in the tab is underlined. # noqa: E501 3023 3024 :param underline: The underline of this Zip. # noqa: E501 3025 :type: str 3026 """ 3027 3028 self._underline = underline 3029 3030 @property 3031 def underline_metadata(self): 3032 """Gets the underline_metadata of this Zip. # noqa: E501 3033 3034 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3035 3036 :return: The underline_metadata of this Zip. # noqa: E501 3037 :rtype: PropertyMetadata 3038 """ 3039 return self._underline_metadata 3040 3041 @underline_metadata.setter 3042 def underline_metadata(self, underline_metadata): 3043 """Sets the underline_metadata of this Zip. 3044 3045 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3046 3047 :param underline_metadata: The underline_metadata of this Zip. # noqa: E501 3048 :type: PropertyMetadata 3049 """ 3050 3051 self._underline_metadata = underline_metadata 3052 3053 @property 3054 def use_dash4(self): 3055 """Gets the use_dash4 of this Zip. # noqa: E501 3056 3057 # noqa: E501 3058 3059 :return: The use_dash4 of this Zip. # noqa: E501 3060 :rtype: str 3061 """ 3062 return self._use_dash4 3063 3064 @use_dash4.setter 3065 def use_dash4(self, use_dash4): 3066 """Sets the use_dash4 of this Zip. 3067 3068 # noqa: E501 3069 3070 :param use_dash4: The use_dash4 of this Zip. # noqa: E501 3071 :type: str 3072 """ 3073 3074 self._use_dash4 = use_dash4 3075 3076 @property 3077 def use_dash4_metadata(self): 3078 """Gets the use_dash4_metadata of this Zip. # noqa: E501 3079 3080 Metadata that indicates whether the `useDash4` property is editable. # noqa: E501 3081 3082 :return: The use_dash4_metadata of this Zip. # noqa: E501 3083 :rtype: PropertyMetadata 3084 """ 3085 return self._use_dash4_metadata 3086 3087 @use_dash4_metadata.setter 3088 def use_dash4_metadata(self, use_dash4_metadata): 3089 """Sets the use_dash4_metadata of this Zip. 3090 3091 Metadata that indicates whether the `useDash4` property is editable. # noqa: E501 3092 3093 :param use_dash4_metadata: The use_dash4_metadata of this Zip. # noqa: E501 3094 :type: PropertyMetadata 3095 """ 3096 3097 self._use_dash4_metadata = use_dash4_metadata 3098 3099 @property 3100 def validation_message(self): 3101 """Gets the validation_message of this Zip. # noqa: E501 3102 3103 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3104 3105 :return: The validation_message of this Zip. # noqa: E501 3106 :rtype: str 3107 """ 3108 return self._validation_message 3109 3110 @validation_message.setter 3111 def validation_message(self, validation_message): 3112 """Sets the validation_message of this Zip. 3113 3114 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3115 3116 :param validation_message: The validation_message of this Zip. # noqa: E501 3117 :type: str 3118 """ 3119 3120 self._validation_message = validation_message 3121 3122 @property 3123 def validation_message_metadata(self): 3124 """Gets the validation_message_metadata of this Zip. # noqa: E501 3125 3126 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3127 3128 :return: The validation_message_metadata of this Zip. # noqa: E501 3129 :rtype: PropertyMetadata 3130 """ 3131 return self._validation_message_metadata 3132 3133 @validation_message_metadata.setter 3134 def validation_message_metadata(self, validation_message_metadata): 3135 """Sets the validation_message_metadata of this Zip. 3136 3137 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3138 3139 :param validation_message_metadata: The validation_message_metadata of this Zip. # noqa: E501 3140 :type: PropertyMetadata 3141 """ 3142 3143 self._validation_message_metadata = validation_message_metadata 3144 3145 @property 3146 def validation_pattern(self): 3147 """Gets the validation_pattern of this Zip. # noqa: E501 3148 3149 A regular expression used to validate input for the tab. # noqa: E501 3150 3151 :return: The validation_pattern of this Zip. # noqa: E501 3152 :rtype: str 3153 """ 3154 return self._validation_pattern 3155 3156 @validation_pattern.setter 3157 def validation_pattern(self, validation_pattern): 3158 """Sets the validation_pattern of this Zip. 3159 3160 A regular expression used to validate input for the tab. # noqa: E501 3161 3162 :param validation_pattern: The validation_pattern of this Zip. # noqa: E501 3163 :type: str 3164 """ 3165 3166 self._validation_pattern = validation_pattern 3167 3168 @property 3169 def validation_pattern_metadata(self): 3170 """Gets the validation_pattern_metadata of this Zip. # noqa: E501 3171 3172 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3173 3174 :return: The validation_pattern_metadata of this Zip. # noqa: E501 3175 :rtype: PropertyMetadata 3176 """ 3177 return self._validation_pattern_metadata 3178 3179 @validation_pattern_metadata.setter 3180 def validation_pattern_metadata(self, validation_pattern_metadata): 3181 """Sets the validation_pattern_metadata of this Zip. 3182 3183 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3184 3185 :param validation_pattern_metadata: The validation_pattern_metadata of this Zip. # noqa: E501 3186 :type: PropertyMetadata 3187 """ 3188 3189 self._validation_pattern_metadata = validation_pattern_metadata 3190 3191 @property 3192 def value(self): 3193 """Gets the value of this Zip. # noqa: E501 3194 3195 Specifies the value of the tab. # noqa: E501 3196 3197 :return: The value of this Zip. # noqa: E501 3198 :rtype: str 3199 """ 3200 return self._value 3201 3202 @value.setter 3203 def value(self, value): 3204 """Sets the value of this Zip. 3205 3206 Specifies the value of the tab. # noqa: E501 3207 3208 :param value: The value of this Zip. # noqa: E501 3209 :type: str 3210 """ 3211 3212 self._value = value 3213 3214 @property 3215 def value_metadata(self): 3216 """Gets the value_metadata of this Zip. # noqa: E501 3217 3218 Metadata that indicates whether the `value` property is editable. # noqa: E501 3219 3220 :return: The value_metadata of this Zip. # noqa: E501 3221 :rtype: PropertyMetadata 3222 """ 3223 return self._value_metadata 3224 3225 @value_metadata.setter 3226 def value_metadata(self, value_metadata): 3227 """Sets the value_metadata of this Zip. 3228 3229 Metadata that indicates whether the `value` property is editable. # noqa: E501 3230 3231 :param value_metadata: The value_metadata of this Zip. # noqa: E501 3232 :type: PropertyMetadata 3233 """ 3234 3235 self._value_metadata = value_metadata 3236 3237 @property 3238 def warning_details(self): 3239 """Gets the warning_details of this Zip. # noqa: E501 3240 3241 # noqa: E501 3242 3243 :return: The warning_details of this Zip. # noqa: E501 3244 :rtype: ErrorDetails 3245 """ 3246 return self._warning_details 3247 3248 @warning_details.setter 3249 def warning_details(self, warning_details): 3250 """Sets the warning_details of this Zip. 3251 3252 # noqa: E501 3253 3254 :param warning_details: The warning_details of this Zip. # noqa: E501 3255 :type: ErrorDetails 3256 """ 3257 3258 self._warning_details = warning_details 3259 3260 @property 3261 def width(self): 3262 """Gets the width of this Zip. # noqa: E501 3263 3264 Width of the tab in pixels. # noqa: E501 3265 3266 :return: The width of this Zip. # noqa: E501 3267 :rtype: str 3268 """ 3269 return self._width 3270 3271 @width.setter 3272 def width(self, width): 3273 """Sets the width of this Zip. 3274 3275 Width of the tab in pixels. # noqa: E501 3276 3277 :param width: The width of this Zip. # noqa: E501 3278 :type: str 3279 """ 3280 3281 self._width = width 3282 3283 @property 3284 def width_metadata(self): 3285 """Gets the width_metadata of this Zip. # noqa: E501 3286 3287 Metadata that indicates whether the `width` property is editable. # noqa: E501 3288 3289 :return: The width_metadata of this Zip. # noqa: E501 3290 :rtype: PropertyMetadata 3291 """ 3292 return self._width_metadata 3293 3294 @width_metadata.setter 3295 def width_metadata(self, width_metadata): 3296 """Sets the width_metadata of this Zip. 3297 3298 Metadata that indicates whether the `width` property is editable. # noqa: E501 3299 3300 :param width_metadata: The width_metadata of this Zip. # noqa: E501 3301 :type: PropertyMetadata 3302 """ 3303 3304 self._width_metadata = width_metadata 3305 3306 @property 3307 def x_position(self): 3308 """Gets the x_position of this Zip. # noqa: E501 3309 3310 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3311 3312 :return: The x_position of this Zip. # noqa: E501 3313 :rtype: str 3314 """ 3315 return self._x_position 3316 3317 @x_position.setter 3318 def x_position(self, x_position): 3319 """Sets the x_position of this Zip. 3320 3321 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3322 3323 :param x_position: The x_position of this Zip. # noqa: E501 3324 :type: str 3325 """ 3326 3327 self._x_position = x_position 3328 3329 @property 3330 def x_position_metadata(self): 3331 """Gets the x_position_metadata of this Zip. # noqa: E501 3332 3333 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3334 3335 :return: The x_position_metadata of this Zip. # noqa: E501 3336 :rtype: PropertyMetadata 3337 """ 3338 return self._x_position_metadata 3339 3340 @x_position_metadata.setter 3341 def x_position_metadata(self, x_position_metadata): 3342 """Sets the x_position_metadata of this Zip. 3343 3344 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3345 3346 :param x_position_metadata: The x_position_metadata of this Zip. # noqa: E501 3347 :type: PropertyMetadata 3348 """ 3349 3350 self._x_position_metadata = x_position_metadata 3351 3352 @property 3353 def y_position(self): 3354 """Gets the y_position of this Zip. # noqa: E501 3355 3356 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3357 3358 :return: The y_position of this Zip. # noqa: E501 3359 :rtype: str 3360 """ 3361 return self._y_position 3362 3363 @y_position.setter 3364 def y_position(self, y_position): 3365 """Sets the y_position of this Zip. 3366 3367 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3368 3369 :param y_position: The y_position of this Zip. # noqa: E501 3370 :type: str 3371 """ 3372 3373 self._y_position = y_position 3374 3375 @property 3376 def y_position_metadata(self): 3377 """Gets the y_position_metadata of this Zip. # noqa: E501 3378 3379 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3380 3381 :return: The y_position_metadata of this Zip. # noqa: E501 3382 :rtype: PropertyMetadata 3383 """ 3384 return self._y_position_metadata 3385 3386 @y_position_metadata.setter 3387 def y_position_metadata(self, y_position_metadata): 3388 """Sets the y_position_metadata of this Zip. 3389 3390 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3391 3392 :param y_position_metadata: The y_position_metadata of this Zip. # noqa: E501 3393 :type: PropertyMetadata 3394 """ 3395 3396 self._y_position_metadata = y_position_metadata 3397 3398 def to_dict(self): 3399 """Returns the model properties as a dict""" 3400 result = {} 3401 3402 for attr, _ in six.iteritems(self.swagger_types): 3403 value = getattr(self, attr) 3404 if isinstance(value, list): 3405 result[attr] = list(map( 3406 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3407 value 3408 )) 3409 elif hasattr(value, "to_dict"): 3410 result[attr] = value.to_dict() 3411 elif isinstance(value, dict): 3412 result[attr] = dict(map( 3413 lambda item: (item[0], item[1].to_dict()) 3414 if hasattr(item[1], "to_dict") else item, 3415 value.items() 3416 )) 3417 else: 3418 result[attr] = value 3419 if issubclass(Zip, dict): 3420 for key, value in self.items(): 3421 result[key] = value 3422 3423 return result 3424 3425 def to_str(self): 3426 """Returns the string representation of the model""" 3427 return pprint.pformat(self.to_dict()) 3428 3429 def __repr__(self): 3430 """For `print` and `pprint`""" 3431 return self.to_str() 3432 3433 def __eq__(self, other): 3434 """Returns true if both objects are equal""" 3435 if not isinstance(other, Zip): 3436 return False 3437 3438 return self.to_dict() == other.to_dict() 3439 3440 def __ne__(self, other): 3441 """Returns true if both objects are not equal""" 3442 if not isinstance(other, Zip): 3443 return True 3444 3445 return self.to_dict() != other.to_dict()
class
Zip:
23class Zip(object): 24 """NOTE: This class is auto generated by the swagger code generator program. 25 26 Do not edit the class manually. 27 """ 28 29 """ 30 Attributes: 31 swagger_types (dict): The key is attribute name 32 and the value is attribute type. 33 attribute_map (dict): The key is attribute name 34 and the value is json key in definition. 35 """ 36 swagger_types = { 37 'agreement_attribute': 'str', 38 'agreement_attribute_locked': 'str', 39 'anchor_allow_white_space_in_characters': 'str', 40 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 41 'anchor_case_sensitive': 'str', 42 'anchor_case_sensitive_metadata': 'PropertyMetadata', 43 'anchor_horizontal_alignment': 'str', 44 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 45 'anchor_ignore_if_not_present': 'str', 46 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 47 'anchor_match_whole_word': 'str', 48 'anchor_match_whole_word_metadata': 'PropertyMetadata', 49 'anchor_string': 'str', 50 'anchor_string_metadata': 'PropertyMetadata', 51 'anchor_tab_processor_version': 'str', 52 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 53 'anchor_units': 'str', 54 'anchor_units_metadata': 'PropertyMetadata', 55 'anchor_x_offset': 'str', 56 'anchor_x_offset_metadata': 'PropertyMetadata', 57 'anchor_y_offset': 'str', 58 'anchor_y_offset_metadata': 'PropertyMetadata', 59 'bold': 'str', 60 'bold_metadata': 'PropertyMetadata', 61 'caption': 'str', 62 'caption_metadata': 'PropertyMetadata', 63 'conceal_value_on_document': 'str', 64 'conceal_value_on_document_metadata': 'PropertyMetadata', 65 'conditional_parent_label': 'str', 66 'conditional_parent_label_metadata': 'PropertyMetadata', 67 'conditional_parent_value': 'str', 68 'conditional_parent_value_metadata': 'PropertyMetadata', 69 'connected_object_details': 'ConnectedObjectDetails', 70 'custom_tab_id': 'str', 71 'custom_tab_id_metadata': 'PropertyMetadata', 72 'disable_auto_size': 'str', 73 'disable_auto_size_metadata': 'PropertyMetadata', 74 'document_id': 'str', 75 'document_id_metadata': 'PropertyMetadata', 76 'error_details': 'ErrorDetails', 77 'extension_data': 'ExtensionData', 78 'font': 'str', 79 'font_color': 'str', 80 'font_color_metadata': 'PropertyMetadata', 81 'font_metadata': 'PropertyMetadata', 82 'font_size': 'str', 83 'font_size_metadata': 'PropertyMetadata', 84 'form_order': 'str', 85 'form_order_metadata': 'PropertyMetadata', 86 'form_page_label': 'str', 87 'form_page_label_metadata': 'PropertyMetadata', 88 'form_page_number': 'str', 89 'form_page_number_metadata': 'PropertyMetadata', 90 'height': 'str', 91 'height_metadata': 'PropertyMetadata', 92 'italic': 'str', 93 'italic_metadata': 'PropertyMetadata', 94 'locale_policy': 'LocalePolicyTab', 95 'locked': 'str', 96 'locked_metadata': 'PropertyMetadata', 97 'max_length': 'str', 98 'max_length_metadata': 'PropertyMetadata', 99 'merge_field': 'MergeField', 100 'merge_field_xml': 'str', 101 'name': 'str', 102 'name_metadata': 'PropertyMetadata', 103 'original_value': 'str', 104 'original_value_metadata': 'PropertyMetadata', 105 'page_number': 'str', 106 'page_number_metadata': 'PropertyMetadata', 107 'recipient_id': 'str', 108 'recipient_id_guid': 'str', 109 'recipient_id_guid_metadata': 'PropertyMetadata', 110 'recipient_id_metadata': 'PropertyMetadata', 111 'require_all': 'str', 112 'require_all_metadata': 'PropertyMetadata', 113 'required': 'str', 114 'required_metadata': 'PropertyMetadata', 115 'require_initial_on_shared_change': 'str', 116 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 117 'sender_required': 'str', 118 'sender_required_metadata': 'PropertyMetadata', 119 'shared': 'str', 120 'shared_metadata': 'PropertyMetadata', 121 'share_to_recipients': 'str', 122 'share_to_recipients_metadata': 'PropertyMetadata', 123 'smart_contract_information': 'SmartContractInformation', 124 'source': 'str', 125 'status': 'str', 126 'status_metadata': 'PropertyMetadata', 127 'tab_fully_qualified_path': 'str', 128 'tab_group_labels': 'list[str]', 129 'tab_group_labels_metadata': 'PropertyMetadata', 130 'tab_id': 'str', 131 'tab_id_metadata': 'PropertyMetadata', 132 'tab_label': 'str', 133 'tab_label_metadata': 'PropertyMetadata', 134 'tab_order': 'str', 135 'tab_order_metadata': 'PropertyMetadata', 136 'tab_type': 'str', 137 'tab_type_metadata': 'PropertyMetadata', 138 'template_locked': 'str', 139 'template_locked_metadata': 'PropertyMetadata', 140 'template_required': 'str', 141 'template_required_metadata': 'PropertyMetadata', 142 'tooltip': 'str', 143 'tool_tip_metadata': 'PropertyMetadata', 144 'underline': 'str', 145 'underline_metadata': 'PropertyMetadata', 146 'use_dash4': 'str', 147 'use_dash4_metadata': 'PropertyMetadata', 148 'validation_message': 'str', 149 'validation_message_metadata': 'PropertyMetadata', 150 'validation_pattern': 'str', 151 'validation_pattern_metadata': 'PropertyMetadata', 152 'value': 'str', 153 'value_metadata': 'PropertyMetadata', 154 'warning_details': 'ErrorDetails', 155 'width': 'str', 156 'width_metadata': 'PropertyMetadata', 157 'x_position': 'str', 158 'x_position_metadata': 'PropertyMetadata', 159 'y_position': 'str', 160 'y_position_metadata': 'PropertyMetadata' 161 } 162 163 attribute_map = { 164 'agreement_attribute': 'agreementAttribute', 165 'agreement_attribute_locked': 'agreementAttributeLocked', 166 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 167 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 168 'anchor_case_sensitive': 'anchorCaseSensitive', 169 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 170 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 171 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 172 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 173 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 174 'anchor_match_whole_word': 'anchorMatchWholeWord', 175 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 176 'anchor_string': 'anchorString', 177 'anchor_string_metadata': 'anchorStringMetadata', 178 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 179 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 180 'anchor_units': 'anchorUnits', 181 'anchor_units_metadata': 'anchorUnitsMetadata', 182 'anchor_x_offset': 'anchorXOffset', 183 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 184 'anchor_y_offset': 'anchorYOffset', 185 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 186 'bold': 'bold', 187 'bold_metadata': 'boldMetadata', 188 'caption': 'caption', 189 'caption_metadata': 'captionMetadata', 190 'conceal_value_on_document': 'concealValueOnDocument', 191 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 192 'conditional_parent_label': 'conditionalParentLabel', 193 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 194 'conditional_parent_value': 'conditionalParentValue', 195 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 196 'connected_object_details': 'connectedObjectDetails', 197 'custom_tab_id': 'customTabId', 198 'custom_tab_id_metadata': 'customTabIdMetadata', 199 'disable_auto_size': 'disableAutoSize', 200 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 201 'document_id': 'documentId', 202 'document_id_metadata': 'documentIdMetadata', 203 'error_details': 'errorDetails', 204 'extension_data': 'extensionData', 205 'font': 'font', 206 'font_color': 'fontColor', 207 'font_color_metadata': 'fontColorMetadata', 208 'font_metadata': 'fontMetadata', 209 'font_size': 'fontSize', 210 'font_size_metadata': 'fontSizeMetadata', 211 'form_order': 'formOrder', 212 'form_order_metadata': 'formOrderMetadata', 213 'form_page_label': 'formPageLabel', 214 'form_page_label_metadata': 'formPageLabelMetadata', 215 'form_page_number': 'formPageNumber', 216 'form_page_number_metadata': 'formPageNumberMetadata', 217 'height': 'height', 218 'height_metadata': 'heightMetadata', 219 'italic': 'italic', 220 'italic_metadata': 'italicMetadata', 221 'locale_policy': 'localePolicy', 222 'locked': 'locked', 223 'locked_metadata': 'lockedMetadata', 224 'max_length': 'maxLength', 225 'max_length_metadata': 'maxLengthMetadata', 226 'merge_field': 'mergeField', 227 'merge_field_xml': 'mergeFieldXml', 228 'name': 'name', 229 'name_metadata': 'nameMetadata', 230 'original_value': 'originalValue', 231 'original_value_metadata': 'originalValueMetadata', 232 'page_number': 'pageNumber', 233 'page_number_metadata': 'pageNumberMetadata', 234 'recipient_id': 'recipientId', 235 'recipient_id_guid': 'recipientIdGuid', 236 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 237 'recipient_id_metadata': 'recipientIdMetadata', 238 'require_all': 'requireAll', 239 'require_all_metadata': 'requireAllMetadata', 240 'required': 'required', 241 'required_metadata': 'requiredMetadata', 242 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 243 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 244 'sender_required': 'senderRequired', 245 'sender_required_metadata': 'senderRequiredMetadata', 246 'shared': 'shared', 247 'shared_metadata': 'sharedMetadata', 248 'share_to_recipients': 'shareToRecipients', 249 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 250 'smart_contract_information': 'smartContractInformation', 251 'source': 'source', 252 'status': 'status', 253 'status_metadata': 'statusMetadata', 254 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 255 'tab_group_labels': 'tabGroupLabels', 256 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 257 'tab_id': 'tabId', 258 'tab_id_metadata': 'tabIdMetadata', 259 'tab_label': 'tabLabel', 260 'tab_label_metadata': 'tabLabelMetadata', 261 'tab_order': 'tabOrder', 262 'tab_order_metadata': 'tabOrderMetadata', 263 'tab_type': 'tabType', 264 'tab_type_metadata': 'tabTypeMetadata', 265 'template_locked': 'templateLocked', 266 'template_locked_metadata': 'templateLockedMetadata', 267 'template_required': 'templateRequired', 268 'template_required_metadata': 'templateRequiredMetadata', 269 'tooltip': 'tooltip', 270 'tool_tip_metadata': 'toolTipMetadata', 271 'underline': 'underline', 272 'underline_metadata': 'underlineMetadata', 273 'use_dash4': 'useDash4', 274 'use_dash4_metadata': 'useDash4Metadata', 275 'validation_message': 'validationMessage', 276 'validation_message_metadata': 'validationMessageMetadata', 277 'validation_pattern': 'validationPattern', 278 'validation_pattern_metadata': 'validationPatternMetadata', 279 'value': 'value', 280 'value_metadata': 'valueMetadata', 281 'warning_details': 'warningDetails', 282 'width': 'width', 283 'width_metadata': 'widthMetadata', 284 'x_position': 'xPosition', 285 'x_position_metadata': 'xPositionMetadata', 286 'y_position': 'yPosition', 287 'y_position_metadata': 'yPositionMetadata' 288 } 289 290 def __init__(self, _configuration=None, **kwargs): # noqa: E501 291 """Zip - a model defined in Swagger""" # noqa: E501 292 if _configuration is None: 293 _configuration = Configuration() 294 self._configuration = _configuration 295 296 self._agreement_attribute = None 297 self._agreement_attribute_locked = None 298 self._anchor_allow_white_space_in_characters = None 299 self._anchor_allow_white_space_in_characters_metadata = None 300 self._anchor_case_sensitive = None 301 self._anchor_case_sensitive_metadata = None 302 self._anchor_horizontal_alignment = None 303 self._anchor_horizontal_alignment_metadata = None 304 self._anchor_ignore_if_not_present = None 305 self._anchor_ignore_if_not_present_metadata = None 306 self._anchor_match_whole_word = None 307 self._anchor_match_whole_word_metadata = None 308 self._anchor_string = None 309 self._anchor_string_metadata = None 310 self._anchor_tab_processor_version = None 311 self._anchor_tab_processor_version_metadata = None 312 self._anchor_units = None 313 self._anchor_units_metadata = None 314 self._anchor_x_offset = None 315 self._anchor_x_offset_metadata = None 316 self._anchor_y_offset = None 317 self._anchor_y_offset_metadata = None 318 self._bold = None 319 self._bold_metadata = None 320 self._caption = None 321 self._caption_metadata = None 322 self._conceal_value_on_document = None 323 self._conceal_value_on_document_metadata = None 324 self._conditional_parent_label = None 325 self._conditional_parent_label_metadata = None 326 self._conditional_parent_value = None 327 self._conditional_parent_value_metadata = None 328 self._connected_object_details = None 329 self._custom_tab_id = None 330 self._custom_tab_id_metadata = None 331 self._disable_auto_size = None 332 self._disable_auto_size_metadata = None 333 self._document_id = None 334 self._document_id_metadata = None 335 self._error_details = None 336 self._extension_data = None 337 self._font = None 338 self._font_color = None 339 self._font_color_metadata = None 340 self._font_metadata = None 341 self._font_size = None 342 self._font_size_metadata = None 343 self._form_order = None 344 self._form_order_metadata = None 345 self._form_page_label = None 346 self._form_page_label_metadata = None 347 self._form_page_number = None 348 self._form_page_number_metadata = None 349 self._height = None 350 self._height_metadata = None 351 self._italic = None 352 self._italic_metadata = None 353 self._locale_policy = None 354 self._locked = None 355 self._locked_metadata = None 356 self._max_length = None 357 self._max_length_metadata = None 358 self._merge_field = None 359 self._merge_field_xml = None 360 self._name = None 361 self._name_metadata = None 362 self._original_value = None 363 self._original_value_metadata = None 364 self._page_number = None 365 self._page_number_metadata = None 366 self._recipient_id = None 367 self._recipient_id_guid = None 368 self._recipient_id_guid_metadata = None 369 self._recipient_id_metadata = None 370 self._require_all = None 371 self._require_all_metadata = None 372 self._required = None 373 self._required_metadata = None 374 self._require_initial_on_shared_change = None 375 self._require_initial_on_shared_change_metadata = None 376 self._sender_required = None 377 self._sender_required_metadata = None 378 self._shared = None 379 self._shared_metadata = None 380 self._share_to_recipients = None 381 self._share_to_recipients_metadata = None 382 self._smart_contract_information = None 383 self._source = None 384 self._status = None 385 self._status_metadata = None 386 self._tab_fully_qualified_path = None 387 self._tab_group_labels = None 388 self._tab_group_labels_metadata = None 389 self._tab_id = None 390 self._tab_id_metadata = None 391 self._tab_label = None 392 self._tab_label_metadata = None 393 self._tab_order = None 394 self._tab_order_metadata = None 395 self._tab_type = None 396 self._tab_type_metadata = None 397 self._template_locked = None 398 self._template_locked_metadata = None 399 self._template_required = None 400 self._template_required_metadata = None 401 self._tooltip = None 402 self._tool_tip_metadata = None 403 self._underline = None 404 self._underline_metadata = None 405 self._use_dash4 = None 406 self._use_dash4_metadata = None 407 self._validation_message = None 408 self._validation_message_metadata = None 409 self._validation_pattern = None 410 self._validation_pattern_metadata = None 411 self._value = None 412 self._value_metadata = None 413 self._warning_details = None 414 self._width = None 415 self._width_metadata = None 416 self._x_position = None 417 self._x_position_metadata = None 418 self._y_position = None 419 self._y_position_metadata = None 420 self.discriminator = None 421 422 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 423 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 424 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 425 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 426 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 427 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 428 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 429 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 430 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 431 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 432 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 433 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 434 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 435 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 436 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 437 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 438 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 439 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 440 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 441 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 442 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 443 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 444 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 445 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 446 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 447 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 448 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 449 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 450 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 451 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 452 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 453 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 454 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 455 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 456 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 457 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 458 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 459 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 460 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 461 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 462 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 463 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 464 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 465 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 466 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 467 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 468 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 469 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 470 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 471 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 472 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 473 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 474 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 475 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 476 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 477 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 478 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 479 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 480 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 481 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 482 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 483 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 484 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 485 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 486 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 487 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 488 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 489 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 490 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 491 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 492 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 493 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 494 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 495 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 496 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 497 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 498 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 499 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 500 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 501 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 502 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 503 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 504 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 505 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 506 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 507 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 508 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 509 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 510 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 511 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 512 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 513 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 514 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 515 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 516 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 517 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 518 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 519 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 520 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 521 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 522 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 523 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 524 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 525 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 526 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 527 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 528 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 529 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 530 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 531 setattr(self, "_{}".format('use_dash4'), kwargs.get('use_dash4', None)) 532 setattr(self, "_{}".format('use_dash4_metadata'), kwargs.get('use_dash4_metadata', None)) 533 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 534 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 535 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 536 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 537 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 538 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 539 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 540 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 541 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 542 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 543 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 544 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 545 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None)) 546 547 @property 548 def agreement_attribute(self): 549 """Gets the agreement_attribute of this Zip. # noqa: E501 550 551 # noqa: E501 552 553 :return: The agreement_attribute of this Zip. # noqa: E501 554 :rtype: str 555 """ 556 return self._agreement_attribute 557 558 @agreement_attribute.setter 559 def agreement_attribute(self, agreement_attribute): 560 """Sets the agreement_attribute of this Zip. 561 562 # noqa: E501 563 564 :param agreement_attribute: The agreement_attribute of this Zip. # noqa: E501 565 :type: str 566 """ 567 568 self._agreement_attribute = agreement_attribute 569 570 @property 571 def agreement_attribute_locked(self): 572 """Gets the agreement_attribute_locked of this Zip. # noqa: E501 573 574 # noqa: E501 575 576 :return: The agreement_attribute_locked of this Zip. # noqa: E501 577 :rtype: str 578 """ 579 return self._agreement_attribute_locked 580 581 @agreement_attribute_locked.setter 582 def agreement_attribute_locked(self, agreement_attribute_locked): 583 """Sets the agreement_attribute_locked of this Zip. 584 585 # noqa: E501 586 587 :param agreement_attribute_locked: The agreement_attribute_locked of this Zip. # noqa: E501 588 :type: str 589 """ 590 591 self._agreement_attribute_locked = agreement_attribute_locked 592 593 @property 594 def anchor_allow_white_space_in_characters(self): 595 """Gets the anchor_allow_white_space_in_characters of this Zip. # noqa: E501 596 597 # noqa: E501 598 599 :return: The anchor_allow_white_space_in_characters of this Zip. # noqa: E501 600 :rtype: str 601 """ 602 return self._anchor_allow_white_space_in_characters 603 604 @anchor_allow_white_space_in_characters.setter 605 def anchor_allow_white_space_in_characters(self, anchor_allow_white_space_in_characters): 606 """Sets the anchor_allow_white_space_in_characters of this Zip. 607 608 # noqa: E501 609 610 :param anchor_allow_white_space_in_characters: The anchor_allow_white_space_in_characters of this Zip. # noqa: E501 611 :type: str 612 """ 613 614 self._anchor_allow_white_space_in_characters = anchor_allow_white_space_in_characters 615 616 @property 617 def anchor_allow_white_space_in_characters_metadata(self): 618 """Gets the anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501 619 620 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 621 622 :return: The anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501 623 :rtype: PropertyMetadata 624 """ 625 return self._anchor_allow_white_space_in_characters_metadata 626 627 @anchor_allow_white_space_in_characters_metadata.setter 628 def anchor_allow_white_space_in_characters_metadata(self, anchor_allow_white_space_in_characters_metadata): 629 """Sets the anchor_allow_white_space_in_characters_metadata of this Zip. 630 631 Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. # noqa: E501 632 633 :param anchor_allow_white_space_in_characters_metadata: The anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501 634 :type: PropertyMetadata 635 """ 636 637 self._anchor_allow_white_space_in_characters_metadata = anchor_allow_white_space_in_characters_metadata 638 639 @property 640 def anchor_case_sensitive(self): 641 """Gets the anchor_case_sensitive of this Zip. # noqa: E501 642 643 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 644 645 :return: The anchor_case_sensitive of this Zip. # noqa: E501 646 :rtype: str 647 """ 648 return self._anchor_case_sensitive 649 650 @anchor_case_sensitive.setter 651 def anchor_case_sensitive(self, anchor_case_sensitive): 652 """Sets the anchor_case_sensitive of this Zip. 653 654 When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**. # noqa: E501 655 656 :param anchor_case_sensitive: The anchor_case_sensitive of this Zip. # noqa: E501 657 :type: str 658 """ 659 660 self._anchor_case_sensitive = anchor_case_sensitive 661 662 @property 663 def anchor_case_sensitive_metadata(self): 664 """Gets the anchor_case_sensitive_metadata of this Zip. # noqa: E501 665 666 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 667 668 :return: The anchor_case_sensitive_metadata of this Zip. # noqa: E501 669 :rtype: PropertyMetadata 670 """ 671 return self._anchor_case_sensitive_metadata 672 673 @anchor_case_sensitive_metadata.setter 674 def anchor_case_sensitive_metadata(self, anchor_case_sensitive_metadata): 675 """Sets the anchor_case_sensitive_metadata of this Zip. 676 677 Metadata that indicates whether the `anchorCaseSensitive` property is editable. # noqa: E501 678 679 :param anchor_case_sensitive_metadata: The anchor_case_sensitive_metadata of this Zip. # noqa: E501 680 :type: PropertyMetadata 681 """ 682 683 self._anchor_case_sensitive_metadata = anchor_case_sensitive_metadata 684 685 @property 686 def anchor_horizontal_alignment(self): 687 """Gets the anchor_horizontal_alignment of this Zip. # noqa: E501 688 689 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 690 691 :return: The anchor_horizontal_alignment of this Zip. # noqa: E501 692 :rtype: str 693 """ 694 return self._anchor_horizontal_alignment 695 696 @anchor_horizontal_alignment.setter 697 def anchor_horizontal_alignment(self, anchor_horizontal_alignment): 698 """Sets the anchor_horizontal_alignment of this Zip. 699 700 Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**. # noqa: E501 701 702 :param anchor_horizontal_alignment: The anchor_horizontal_alignment of this Zip. # noqa: E501 703 :type: str 704 """ 705 706 self._anchor_horizontal_alignment = anchor_horizontal_alignment 707 708 @property 709 def anchor_horizontal_alignment_metadata(self): 710 """Gets the anchor_horizontal_alignment_metadata of this Zip. # noqa: E501 711 712 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 713 714 :return: The anchor_horizontal_alignment_metadata of this Zip. # noqa: E501 715 :rtype: PropertyMetadata 716 """ 717 return self._anchor_horizontal_alignment_metadata 718 719 @anchor_horizontal_alignment_metadata.setter 720 def anchor_horizontal_alignment_metadata(self, anchor_horizontal_alignment_metadata): 721 """Sets the anchor_horizontal_alignment_metadata of this Zip. 722 723 Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. # noqa: E501 724 725 :param anchor_horizontal_alignment_metadata: The anchor_horizontal_alignment_metadata of this Zip. # noqa: E501 726 :type: PropertyMetadata 727 """ 728 729 self._anchor_horizontal_alignment_metadata = anchor_horizontal_alignment_metadata 730 731 @property 732 def anchor_ignore_if_not_present(self): 733 """Gets the anchor_ignore_if_not_present of this Zip. # noqa: E501 734 735 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 736 737 :return: The anchor_ignore_if_not_present of this Zip. # noqa: E501 738 :rtype: str 739 """ 740 return self._anchor_ignore_if_not_present 741 742 @anchor_ignore_if_not_present.setter 743 def anchor_ignore_if_not_present(self, anchor_ignore_if_not_present): 744 """Sets the anchor_ignore_if_not_present of this Zip. 745 746 When set to **true**, this tab is ignored if anchorString is not found in the document. # noqa: E501 747 748 :param anchor_ignore_if_not_present: The anchor_ignore_if_not_present of this Zip. # noqa: E501 749 :type: str 750 """ 751 752 self._anchor_ignore_if_not_present = anchor_ignore_if_not_present 753 754 @property 755 def anchor_ignore_if_not_present_metadata(self): 756 """Gets the anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501 757 758 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 759 760 :return: The anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501 761 :rtype: PropertyMetadata 762 """ 763 return self._anchor_ignore_if_not_present_metadata 764 765 @anchor_ignore_if_not_present_metadata.setter 766 def anchor_ignore_if_not_present_metadata(self, anchor_ignore_if_not_present_metadata): 767 """Sets the anchor_ignore_if_not_present_metadata of this Zip. 768 769 Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. # noqa: E501 770 771 :param anchor_ignore_if_not_present_metadata: The anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501 772 :type: PropertyMetadata 773 """ 774 775 self._anchor_ignore_if_not_present_metadata = anchor_ignore_if_not_present_metadata 776 777 @property 778 def anchor_match_whole_word(self): 779 """Gets the anchor_match_whole_word of this Zip. # noqa: E501 780 781 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 782 783 :return: The anchor_match_whole_word of this Zip. # noqa: E501 784 :rtype: str 785 """ 786 return self._anchor_match_whole_word 787 788 @anchor_match_whole_word.setter 789 def anchor_match_whole_word(self, anchor_match_whole_word): 790 """Sets the anchor_match_whole_word of this Zip. 791 792 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 793 794 :param anchor_match_whole_word: The anchor_match_whole_word of this Zip. # noqa: E501 795 :type: str 796 """ 797 798 self._anchor_match_whole_word = anchor_match_whole_word 799 800 @property 801 def anchor_match_whole_word_metadata(self): 802 """Gets the anchor_match_whole_word_metadata of this Zip. # noqa: E501 803 804 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 805 806 :return: The anchor_match_whole_word_metadata of this Zip. # noqa: E501 807 :rtype: PropertyMetadata 808 """ 809 return self._anchor_match_whole_word_metadata 810 811 @anchor_match_whole_word_metadata.setter 812 def anchor_match_whole_word_metadata(self, anchor_match_whole_word_metadata): 813 """Sets the anchor_match_whole_word_metadata of this Zip. 814 815 Metadata that indicates whether the `anchorMatchWholeWord` property is editable. # noqa: E501 816 817 :param anchor_match_whole_word_metadata: The anchor_match_whole_word_metadata of this Zip. # noqa: E501 818 :type: PropertyMetadata 819 """ 820 821 self._anchor_match_whole_word_metadata = anchor_match_whole_word_metadata 822 823 @property 824 def anchor_string(self): 825 """Gets the anchor_string of this Zip. # noqa: E501 826 827 Anchor text information for a radio button. # noqa: E501 828 829 :return: The anchor_string of this Zip. # noqa: E501 830 :rtype: str 831 """ 832 return self._anchor_string 833 834 @anchor_string.setter 835 def anchor_string(self, anchor_string): 836 """Sets the anchor_string of this Zip. 837 838 Anchor text information for a radio button. # noqa: E501 839 840 :param anchor_string: The anchor_string of this Zip. # noqa: E501 841 :type: str 842 """ 843 844 self._anchor_string = anchor_string 845 846 @property 847 def anchor_string_metadata(self): 848 """Gets the anchor_string_metadata of this Zip. # noqa: E501 849 850 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 851 852 :return: The anchor_string_metadata of this Zip. # noqa: E501 853 :rtype: PropertyMetadata 854 """ 855 return self._anchor_string_metadata 856 857 @anchor_string_metadata.setter 858 def anchor_string_metadata(self, anchor_string_metadata): 859 """Sets the anchor_string_metadata of this Zip. 860 861 Metadata that indicates whether the `anchorString` property is editable. # noqa: E501 862 863 :param anchor_string_metadata: The anchor_string_metadata of this Zip. # noqa: E501 864 :type: PropertyMetadata 865 """ 866 867 self._anchor_string_metadata = anchor_string_metadata 868 869 @property 870 def anchor_tab_processor_version(self): 871 """Gets the anchor_tab_processor_version of this Zip. # noqa: E501 872 873 # noqa: E501 874 875 :return: The anchor_tab_processor_version of this Zip. # noqa: E501 876 :rtype: str 877 """ 878 return self._anchor_tab_processor_version 879 880 @anchor_tab_processor_version.setter 881 def anchor_tab_processor_version(self, anchor_tab_processor_version): 882 """Sets the anchor_tab_processor_version of this Zip. 883 884 # noqa: E501 885 886 :param anchor_tab_processor_version: The anchor_tab_processor_version of this Zip. # noqa: E501 887 :type: str 888 """ 889 890 self._anchor_tab_processor_version = anchor_tab_processor_version 891 892 @property 893 def anchor_tab_processor_version_metadata(self): 894 """Gets the anchor_tab_processor_version_metadata of this Zip. # noqa: E501 895 896 Reserved for DocuSign. # noqa: E501 897 898 :return: The anchor_tab_processor_version_metadata of this Zip. # noqa: E501 899 :rtype: PropertyMetadata 900 """ 901 return self._anchor_tab_processor_version_metadata 902 903 @anchor_tab_processor_version_metadata.setter 904 def anchor_tab_processor_version_metadata(self, anchor_tab_processor_version_metadata): 905 """Sets the anchor_tab_processor_version_metadata of this Zip. 906 907 Reserved for DocuSign. # noqa: E501 908 909 :param anchor_tab_processor_version_metadata: The anchor_tab_processor_version_metadata of this Zip. # noqa: E501 910 :type: PropertyMetadata 911 """ 912 913 self._anchor_tab_processor_version_metadata = anchor_tab_processor_version_metadata 914 915 @property 916 def anchor_units(self): 917 """Gets the anchor_units of this Zip. # noqa: E501 918 919 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 920 921 :return: The anchor_units of this Zip. # noqa: E501 922 :rtype: str 923 """ 924 return self._anchor_units 925 926 @anchor_units.setter 927 def anchor_units(self, anchor_units): 928 """Sets the anchor_units of this Zip. 929 930 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. # noqa: E501 931 932 :param anchor_units: The anchor_units of this Zip. # noqa: E501 933 :type: str 934 """ 935 936 self._anchor_units = anchor_units 937 938 @property 939 def anchor_units_metadata(self): 940 """Gets the anchor_units_metadata of this Zip. # noqa: E501 941 942 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 943 944 :return: The anchor_units_metadata of this Zip. # noqa: E501 945 :rtype: PropertyMetadata 946 """ 947 return self._anchor_units_metadata 948 949 @anchor_units_metadata.setter 950 def anchor_units_metadata(self, anchor_units_metadata): 951 """Sets the anchor_units_metadata of this Zip. 952 953 Metadata that indicates whether the `anchorUnits` property is editable. # noqa: E501 954 955 :param anchor_units_metadata: The anchor_units_metadata of this Zip. # noqa: E501 956 :type: PropertyMetadata 957 """ 958 959 self._anchor_units_metadata = anchor_units_metadata 960 961 @property 962 def anchor_x_offset(self): 963 """Gets the anchor_x_offset of this Zip. # noqa: E501 964 965 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 966 967 :return: The anchor_x_offset of this Zip. # noqa: E501 968 :rtype: str 969 """ 970 return self._anchor_x_offset 971 972 @anchor_x_offset.setter 973 def anchor_x_offset(self, anchor_x_offset): 974 """Sets the anchor_x_offset of this Zip. 975 976 Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 977 978 :param anchor_x_offset: The anchor_x_offset of this Zip. # noqa: E501 979 :type: str 980 """ 981 982 self._anchor_x_offset = anchor_x_offset 983 984 @property 985 def anchor_x_offset_metadata(self): 986 """Gets the anchor_x_offset_metadata of this Zip. # noqa: E501 987 988 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 989 990 :return: The anchor_x_offset_metadata of this Zip. # noqa: E501 991 :rtype: PropertyMetadata 992 """ 993 return self._anchor_x_offset_metadata 994 995 @anchor_x_offset_metadata.setter 996 def anchor_x_offset_metadata(self, anchor_x_offset_metadata): 997 """Sets the anchor_x_offset_metadata of this Zip. 998 999 Metadata that indicates whether the `anchorXOffset` property is editable. # noqa: E501 1000 1001 :param anchor_x_offset_metadata: The anchor_x_offset_metadata of this Zip. # noqa: E501 1002 :type: PropertyMetadata 1003 """ 1004 1005 self._anchor_x_offset_metadata = anchor_x_offset_metadata 1006 1007 @property 1008 def anchor_y_offset(self): 1009 """Gets the anchor_y_offset of this Zip. # noqa: E501 1010 1011 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1012 1013 :return: The anchor_y_offset of this Zip. # noqa: E501 1014 :rtype: str 1015 """ 1016 return self._anchor_y_offset 1017 1018 @anchor_y_offset.setter 1019 def anchor_y_offset(self, anchor_y_offset): 1020 """Sets the anchor_y_offset of this Zip. 1021 1022 Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. # noqa: E501 1023 1024 :param anchor_y_offset: The anchor_y_offset of this Zip. # noqa: E501 1025 :type: str 1026 """ 1027 1028 self._anchor_y_offset = anchor_y_offset 1029 1030 @property 1031 def anchor_y_offset_metadata(self): 1032 """Gets the anchor_y_offset_metadata of this Zip. # noqa: E501 1033 1034 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1035 1036 :return: The anchor_y_offset_metadata of this Zip. # noqa: E501 1037 :rtype: PropertyMetadata 1038 """ 1039 return self._anchor_y_offset_metadata 1040 1041 @anchor_y_offset_metadata.setter 1042 def anchor_y_offset_metadata(self, anchor_y_offset_metadata): 1043 """Sets the anchor_y_offset_metadata of this Zip. 1044 1045 Metadata that indicates whether the `anchorYOffset` property is editable. # noqa: E501 1046 1047 :param anchor_y_offset_metadata: The anchor_y_offset_metadata of this Zip. # noqa: E501 1048 :type: PropertyMetadata 1049 """ 1050 1051 self._anchor_y_offset_metadata = anchor_y_offset_metadata 1052 1053 @property 1054 def bold(self): 1055 """Gets the bold of this Zip. # noqa: E501 1056 1057 When set to **true**, the information in the tab is bold. # noqa: E501 1058 1059 :return: The bold of this Zip. # noqa: E501 1060 :rtype: str 1061 """ 1062 return self._bold 1063 1064 @bold.setter 1065 def bold(self, bold): 1066 """Sets the bold of this Zip. 1067 1068 When set to **true**, the information in the tab is bold. # noqa: E501 1069 1070 :param bold: The bold of this Zip. # noqa: E501 1071 :type: str 1072 """ 1073 1074 self._bold = bold 1075 1076 @property 1077 def bold_metadata(self): 1078 """Gets the bold_metadata of this Zip. # noqa: E501 1079 1080 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1081 1082 :return: The bold_metadata of this Zip. # noqa: E501 1083 :rtype: PropertyMetadata 1084 """ 1085 return self._bold_metadata 1086 1087 @bold_metadata.setter 1088 def bold_metadata(self, bold_metadata): 1089 """Sets the bold_metadata of this Zip. 1090 1091 Metadata that indicates whether the `bold` property is editable. # noqa: E501 1092 1093 :param bold_metadata: The bold_metadata of this Zip. # noqa: E501 1094 :type: PropertyMetadata 1095 """ 1096 1097 self._bold_metadata = bold_metadata 1098 1099 @property 1100 def caption(self): 1101 """Gets the caption of this Zip. # noqa: E501 1102 1103 # noqa: E501 1104 1105 :return: The caption of this Zip. # noqa: E501 1106 :rtype: str 1107 """ 1108 return self._caption 1109 1110 @caption.setter 1111 def caption(self, caption): 1112 """Sets the caption of this Zip. 1113 1114 # noqa: E501 1115 1116 :param caption: The caption of this Zip. # noqa: E501 1117 :type: str 1118 """ 1119 1120 self._caption = caption 1121 1122 @property 1123 def caption_metadata(self): 1124 """Gets the caption_metadata of this Zip. # noqa: E501 1125 1126 # noqa: E501 1127 1128 :return: The caption_metadata of this Zip. # noqa: E501 1129 :rtype: PropertyMetadata 1130 """ 1131 return self._caption_metadata 1132 1133 @caption_metadata.setter 1134 def caption_metadata(self, caption_metadata): 1135 """Sets the caption_metadata of this Zip. 1136 1137 # noqa: E501 1138 1139 :param caption_metadata: The caption_metadata of this Zip. # noqa: E501 1140 :type: PropertyMetadata 1141 """ 1142 1143 self._caption_metadata = caption_metadata 1144 1145 @property 1146 def conceal_value_on_document(self): 1147 """Gets the conceal_value_on_document of this Zip. # noqa: E501 1148 1149 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1150 1151 :return: The conceal_value_on_document of this Zip. # noqa: E501 1152 :rtype: str 1153 """ 1154 return self._conceal_value_on_document 1155 1156 @conceal_value_on_document.setter 1157 def conceal_value_on_document(self, conceal_value_on_document): 1158 """Sets the conceal_value_on_document of this Zip. 1159 1160 When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501 1161 1162 :param conceal_value_on_document: The conceal_value_on_document of this Zip. # noqa: E501 1163 :type: str 1164 """ 1165 1166 self._conceal_value_on_document = conceal_value_on_document 1167 1168 @property 1169 def conceal_value_on_document_metadata(self): 1170 """Gets the conceal_value_on_document_metadata of this Zip. # noqa: E501 1171 1172 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1173 1174 :return: The conceal_value_on_document_metadata of this Zip. # noqa: E501 1175 :rtype: PropertyMetadata 1176 """ 1177 return self._conceal_value_on_document_metadata 1178 1179 @conceal_value_on_document_metadata.setter 1180 def conceal_value_on_document_metadata(self, conceal_value_on_document_metadata): 1181 """Sets the conceal_value_on_document_metadata of this Zip. 1182 1183 Metadata that indicates whether the `concealValueOnDocument` property is editable. # noqa: E501 1184 1185 :param conceal_value_on_document_metadata: The conceal_value_on_document_metadata of this Zip. # noqa: E501 1186 :type: PropertyMetadata 1187 """ 1188 1189 self._conceal_value_on_document_metadata = conceal_value_on_document_metadata 1190 1191 @property 1192 def conditional_parent_label(self): 1193 """Gets the conditional_parent_label of this Zip. # noqa: E501 1194 1195 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1196 1197 :return: The conditional_parent_label of this Zip. # noqa: E501 1198 :rtype: str 1199 """ 1200 return self._conditional_parent_label 1201 1202 @conditional_parent_label.setter 1203 def conditional_parent_label(self, conditional_parent_label): 1204 """Sets the conditional_parent_label of this Zip. 1205 1206 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. # noqa: E501 1207 1208 :param conditional_parent_label: The conditional_parent_label of this Zip. # noqa: E501 1209 :type: str 1210 """ 1211 1212 self._conditional_parent_label = conditional_parent_label 1213 1214 @property 1215 def conditional_parent_label_metadata(self): 1216 """Gets the conditional_parent_label_metadata of this Zip. # noqa: E501 1217 1218 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1219 1220 :return: The conditional_parent_label_metadata of this Zip. # noqa: E501 1221 :rtype: PropertyMetadata 1222 """ 1223 return self._conditional_parent_label_metadata 1224 1225 @conditional_parent_label_metadata.setter 1226 def conditional_parent_label_metadata(self, conditional_parent_label_metadata): 1227 """Sets the conditional_parent_label_metadata of this Zip. 1228 1229 Metadata that indicates whether the `conditionalParentLabel` property is editable. # noqa: E501 1230 1231 :param conditional_parent_label_metadata: The conditional_parent_label_metadata of this Zip. # noqa: E501 1232 :type: PropertyMetadata 1233 """ 1234 1235 self._conditional_parent_label_metadata = conditional_parent_label_metadata 1236 1237 @property 1238 def conditional_parent_value(self): 1239 """Gets the conditional_parent_value of this Zip. # noqa: E501 1240 1241 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 1242 1243 :return: The conditional_parent_value of this Zip. # noqa: E501 1244 :rtype: str 1245 """ 1246 return self._conditional_parent_value 1247 1248 @conditional_parent_value.setter 1249 def conditional_parent_value(self, conditional_parent_value): 1250 """Sets the conditional_parent_value of this Zip. 1251 1252 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 1253 1254 :param conditional_parent_value: The conditional_parent_value of this Zip. # noqa: E501 1255 :type: str 1256 """ 1257 1258 self._conditional_parent_value = conditional_parent_value 1259 1260 @property 1261 def conditional_parent_value_metadata(self): 1262 """Gets the conditional_parent_value_metadata of this Zip. # noqa: E501 1263 1264 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1265 1266 :return: The conditional_parent_value_metadata of this Zip. # noqa: E501 1267 :rtype: PropertyMetadata 1268 """ 1269 return self._conditional_parent_value_metadata 1270 1271 @conditional_parent_value_metadata.setter 1272 def conditional_parent_value_metadata(self, conditional_parent_value_metadata): 1273 """Sets the conditional_parent_value_metadata of this Zip. 1274 1275 Metadata that indicates whether the `conditionalParentValue` property is editable. # noqa: E501 1276 1277 :param conditional_parent_value_metadata: The conditional_parent_value_metadata of this Zip. # noqa: E501 1278 :type: PropertyMetadata 1279 """ 1280 1281 self._conditional_parent_value_metadata = conditional_parent_value_metadata 1282 1283 @property 1284 def connected_object_details(self): 1285 """Gets the connected_object_details of this Zip. # noqa: E501 1286 1287 # noqa: E501 1288 1289 :return: The connected_object_details of this Zip. # noqa: E501 1290 :rtype: ConnectedObjectDetails 1291 """ 1292 return self._connected_object_details 1293 1294 @connected_object_details.setter 1295 def connected_object_details(self, connected_object_details): 1296 """Sets the connected_object_details of this Zip. 1297 1298 # noqa: E501 1299 1300 :param connected_object_details: The connected_object_details of this Zip. # noqa: E501 1301 :type: ConnectedObjectDetails 1302 """ 1303 1304 self._connected_object_details = connected_object_details 1305 1306 @property 1307 def custom_tab_id(self): 1308 """Gets the custom_tab_id of this Zip. # noqa: E501 1309 1310 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 1311 1312 :return: The custom_tab_id of this Zip. # noqa: E501 1313 :rtype: str 1314 """ 1315 return self._custom_tab_id 1316 1317 @custom_tab_id.setter 1318 def custom_tab_id(self, custom_tab_id): 1319 """Sets the custom_tab_id of this Zip. 1320 1321 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 1322 1323 :param custom_tab_id: The custom_tab_id of this Zip. # noqa: E501 1324 :type: str 1325 """ 1326 1327 self._custom_tab_id = custom_tab_id 1328 1329 @property 1330 def custom_tab_id_metadata(self): 1331 """Gets the custom_tab_id_metadata of this Zip. # noqa: E501 1332 1333 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1334 1335 :return: The custom_tab_id_metadata of this Zip. # noqa: E501 1336 :rtype: PropertyMetadata 1337 """ 1338 return self._custom_tab_id_metadata 1339 1340 @custom_tab_id_metadata.setter 1341 def custom_tab_id_metadata(self, custom_tab_id_metadata): 1342 """Sets the custom_tab_id_metadata of this Zip. 1343 1344 Metadata that indicates whether the `customTabId` property is editable. # noqa: E501 1345 1346 :param custom_tab_id_metadata: The custom_tab_id_metadata of this Zip. # noqa: E501 1347 :type: PropertyMetadata 1348 """ 1349 1350 self._custom_tab_id_metadata = custom_tab_id_metadata 1351 1352 @property 1353 def disable_auto_size(self): 1354 """Gets the disable_auto_size of this Zip. # noqa: E501 1355 1356 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1357 1358 :return: The disable_auto_size of this Zip. # noqa: E501 1359 :rtype: str 1360 """ 1361 return self._disable_auto_size 1362 1363 @disable_auto_size.setter 1364 def disable_auto_size(self, disable_auto_size): 1365 """Sets the disable_auto_size of this Zip. 1366 1367 When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501 1368 1369 :param disable_auto_size: The disable_auto_size of this Zip. # noqa: E501 1370 :type: str 1371 """ 1372 1373 self._disable_auto_size = disable_auto_size 1374 1375 @property 1376 def disable_auto_size_metadata(self): 1377 """Gets the disable_auto_size_metadata of this Zip. # noqa: E501 1378 1379 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1380 1381 :return: The disable_auto_size_metadata of this Zip. # noqa: E501 1382 :rtype: PropertyMetadata 1383 """ 1384 return self._disable_auto_size_metadata 1385 1386 @disable_auto_size_metadata.setter 1387 def disable_auto_size_metadata(self, disable_auto_size_metadata): 1388 """Sets the disable_auto_size_metadata of this Zip. 1389 1390 Metadata that indicates whether the `disableAutoSize` property is editable. # noqa: E501 1391 1392 :param disable_auto_size_metadata: The disable_auto_size_metadata of this Zip. # noqa: E501 1393 :type: PropertyMetadata 1394 """ 1395 1396 self._disable_auto_size_metadata = disable_auto_size_metadata 1397 1398 @property 1399 def document_id(self): 1400 """Gets the document_id of this Zip. # noqa: E501 1401 1402 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1403 1404 :return: The document_id of this Zip. # noqa: E501 1405 :rtype: str 1406 """ 1407 return self._document_id 1408 1409 @document_id.setter 1410 def document_id(self, document_id): 1411 """Sets the document_id of this Zip. 1412 1413 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. # noqa: E501 1414 1415 :param document_id: The document_id of this Zip. # noqa: E501 1416 :type: str 1417 """ 1418 1419 self._document_id = document_id 1420 1421 @property 1422 def document_id_metadata(self): 1423 """Gets the document_id_metadata of this Zip. # noqa: E501 1424 1425 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1426 1427 :return: The document_id_metadata of this Zip. # noqa: E501 1428 :rtype: PropertyMetadata 1429 """ 1430 return self._document_id_metadata 1431 1432 @document_id_metadata.setter 1433 def document_id_metadata(self, document_id_metadata): 1434 """Sets the document_id_metadata of this Zip. 1435 1436 Metadata that indicates whether the `documentId` property is editable. # noqa: E501 1437 1438 :param document_id_metadata: The document_id_metadata of this Zip. # noqa: E501 1439 :type: PropertyMetadata 1440 """ 1441 1442 self._document_id_metadata = document_id_metadata 1443 1444 @property 1445 def error_details(self): 1446 """Gets the error_details of this Zip. # noqa: E501 1447 1448 Array or errors. # noqa: E501 1449 1450 :return: The error_details of this Zip. # noqa: E501 1451 :rtype: ErrorDetails 1452 """ 1453 return self._error_details 1454 1455 @error_details.setter 1456 def error_details(self, error_details): 1457 """Sets the error_details of this Zip. 1458 1459 Array or errors. # noqa: E501 1460 1461 :param error_details: The error_details of this Zip. # noqa: E501 1462 :type: ErrorDetails 1463 """ 1464 1465 self._error_details = error_details 1466 1467 @property 1468 def extension_data(self): 1469 """Gets the extension_data of this Zip. # noqa: E501 1470 1471 # noqa: E501 1472 1473 :return: The extension_data of this Zip. # noqa: E501 1474 :rtype: ExtensionData 1475 """ 1476 return self._extension_data 1477 1478 @extension_data.setter 1479 def extension_data(self, extension_data): 1480 """Sets the extension_data of this Zip. 1481 1482 # noqa: E501 1483 1484 :param extension_data: The extension_data of this Zip. # noqa: E501 1485 :type: ExtensionData 1486 """ 1487 1488 self._extension_data = extension_data 1489 1490 @property 1491 def font(self): 1492 """Gets the font of this Zip. # noqa: E501 1493 1494 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 1495 1496 :return: The font of this Zip. # noqa: E501 1497 :rtype: str 1498 """ 1499 return self._font 1500 1501 @font.setter 1502 def font(self, font): 1503 """Sets the font of this Zip. 1504 1505 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 1506 1507 :param font: The font of this Zip. # noqa: E501 1508 :type: str 1509 """ 1510 1511 self._font = font 1512 1513 @property 1514 def font_color(self): 1515 """Gets the font_color of this Zip. # noqa: E501 1516 1517 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 1518 1519 :return: The font_color of this Zip. # noqa: E501 1520 :rtype: str 1521 """ 1522 return self._font_color 1523 1524 @font_color.setter 1525 def font_color(self, font_color): 1526 """Sets the font_color of this Zip. 1527 1528 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 1529 1530 :param font_color: The font_color of this Zip. # noqa: E501 1531 :type: str 1532 """ 1533 1534 self._font_color = font_color 1535 1536 @property 1537 def font_color_metadata(self): 1538 """Gets the font_color_metadata of this Zip. # noqa: E501 1539 1540 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1541 1542 :return: The font_color_metadata of this Zip. # noqa: E501 1543 :rtype: PropertyMetadata 1544 """ 1545 return self._font_color_metadata 1546 1547 @font_color_metadata.setter 1548 def font_color_metadata(self, font_color_metadata): 1549 """Sets the font_color_metadata of this Zip. 1550 1551 Metadata that indicates whether the `fontColor` property is editable. # noqa: E501 1552 1553 :param font_color_metadata: The font_color_metadata of this Zip. # noqa: E501 1554 :type: PropertyMetadata 1555 """ 1556 1557 self._font_color_metadata = font_color_metadata 1558 1559 @property 1560 def font_metadata(self): 1561 """Gets the font_metadata of this Zip. # noqa: E501 1562 1563 Metadata that indicates whether the `font` property is editable. # noqa: E501 1564 1565 :return: The font_metadata of this Zip. # noqa: E501 1566 :rtype: PropertyMetadata 1567 """ 1568 return self._font_metadata 1569 1570 @font_metadata.setter 1571 def font_metadata(self, font_metadata): 1572 """Sets the font_metadata of this Zip. 1573 1574 Metadata that indicates whether the `font` property is editable. # noqa: E501 1575 1576 :param font_metadata: The font_metadata of this Zip. # noqa: E501 1577 :type: PropertyMetadata 1578 """ 1579 1580 self._font_metadata = font_metadata 1581 1582 @property 1583 def font_size(self): 1584 """Gets the font_size of this Zip. # noqa: E501 1585 1586 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 1587 1588 :return: The font_size of this Zip. # noqa: E501 1589 :rtype: str 1590 """ 1591 return self._font_size 1592 1593 @font_size.setter 1594 def font_size(self, font_size): 1595 """Sets the font_size of this Zip. 1596 1597 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 1598 1599 :param font_size: The font_size of this Zip. # noqa: E501 1600 :type: str 1601 """ 1602 1603 self._font_size = font_size 1604 1605 @property 1606 def font_size_metadata(self): 1607 """Gets the font_size_metadata of this Zip. # noqa: E501 1608 1609 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1610 1611 :return: The font_size_metadata of this Zip. # noqa: E501 1612 :rtype: PropertyMetadata 1613 """ 1614 return self._font_size_metadata 1615 1616 @font_size_metadata.setter 1617 def font_size_metadata(self, font_size_metadata): 1618 """Sets the font_size_metadata of this Zip. 1619 1620 Metadata that indicates whether the `fontSize` property is editable. # noqa: E501 1621 1622 :param font_size_metadata: The font_size_metadata of this Zip. # noqa: E501 1623 :type: PropertyMetadata 1624 """ 1625 1626 self._font_size_metadata = font_size_metadata 1627 1628 @property 1629 def form_order(self): 1630 """Gets the form_order of this Zip. # noqa: E501 1631 1632 # noqa: E501 1633 1634 :return: The form_order of this Zip. # noqa: E501 1635 :rtype: str 1636 """ 1637 return self._form_order 1638 1639 @form_order.setter 1640 def form_order(self, form_order): 1641 """Sets the form_order of this Zip. 1642 1643 # noqa: E501 1644 1645 :param form_order: The form_order of this Zip. # noqa: E501 1646 :type: str 1647 """ 1648 1649 self._form_order = form_order 1650 1651 @property 1652 def form_order_metadata(self): 1653 """Gets the form_order_metadata of this Zip. # noqa: E501 1654 1655 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1656 1657 :return: The form_order_metadata of this Zip. # noqa: E501 1658 :rtype: PropertyMetadata 1659 """ 1660 return self._form_order_metadata 1661 1662 @form_order_metadata.setter 1663 def form_order_metadata(self, form_order_metadata): 1664 """Sets the form_order_metadata of this Zip. 1665 1666 Metadata that indicates whether the `formOrder` property is editable. # noqa: E501 1667 1668 :param form_order_metadata: The form_order_metadata of this Zip. # noqa: E501 1669 :type: PropertyMetadata 1670 """ 1671 1672 self._form_order_metadata = form_order_metadata 1673 1674 @property 1675 def form_page_label(self): 1676 """Gets the form_page_label of this Zip. # noqa: E501 1677 1678 # noqa: E501 1679 1680 :return: The form_page_label of this Zip. # noqa: E501 1681 :rtype: str 1682 """ 1683 return self._form_page_label 1684 1685 @form_page_label.setter 1686 def form_page_label(self, form_page_label): 1687 """Sets the form_page_label of this Zip. 1688 1689 # noqa: E501 1690 1691 :param form_page_label: The form_page_label of this Zip. # noqa: E501 1692 :type: str 1693 """ 1694 1695 self._form_page_label = form_page_label 1696 1697 @property 1698 def form_page_label_metadata(self): 1699 """Gets the form_page_label_metadata of this Zip. # noqa: E501 1700 1701 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1702 1703 :return: The form_page_label_metadata of this Zip. # noqa: E501 1704 :rtype: PropertyMetadata 1705 """ 1706 return self._form_page_label_metadata 1707 1708 @form_page_label_metadata.setter 1709 def form_page_label_metadata(self, form_page_label_metadata): 1710 """Sets the form_page_label_metadata of this Zip. 1711 1712 Metadata that indicates whether the `formPageLabel` property is editable. # noqa: E501 1713 1714 :param form_page_label_metadata: The form_page_label_metadata of this Zip. # noqa: E501 1715 :type: PropertyMetadata 1716 """ 1717 1718 self._form_page_label_metadata = form_page_label_metadata 1719 1720 @property 1721 def form_page_number(self): 1722 """Gets the form_page_number of this Zip. # noqa: E501 1723 1724 # noqa: E501 1725 1726 :return: The form_page_number of this Zip. # noqa: E501 1727 :rtype: str 1728 """ 1729 return self._form_page_number 1730 1731 @form_page_number.setter 1732 def form_page_number(self, form_page_number): 1733 """Sets the form_page_number of this Zip. 1734 1735 # noqa: E501 1736 1737 :param form_page_number: The form_page_number of this Zip. # noqa: E501 1738 :type: str 1739 """ 1740 1741 self._form_page_number = form_page_number 1742 1743 @property 1744 def form_page_number_metadata(self): 1745 """Gets the form_page_number_metadata of this Zip. # noqa: E501 1746 1747 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1748 1749 :return: The form_page_number_metadata of this Zip. # noqa: E501 1750 :rtype: PropertyMetadata 1751 """ 1752 return self._form_page_number_metadata 1753 1754 @form_page_number_metadata.setter 1755 def form_page_number_metadata(self, form_page_number_metadata): 1756 """Sets the form_page_number_metadata of this Zip. 1757 1758 Metadata that indicates whether the `fromPageNumber` property is editable. # noqa: E501 1759 1760 :param form_page_number_metadata: The form_page_number_metadata of this Zip. # noqa: E501 1761 :type: PropertyMetadata 1762 """ 1763 1764 self._form_page_number_metadata = form_page_number_metadata 1765 1766 @property 1767 def height(self): 1768 """Gets the height of this Zip. # noqa: E501 1769 1770 Height of the tab in pixels. # noqa: E501 1771 1772 :return: The height of this Zip. # noqa: E501 1773 :rtype: str 1774 """ 1775 return self._height 1776 1777 @height.setter 1778 def height(self, height): 1779 """Sets the height of this Zip. 1780 1781 Height of the tab in pixels. # noqa: E501 1782 1783 :param height: The height of this Zip. # noqa: E501 1784 :type: str 1785 """ 1786 1787 self._height = height 1788 1789 @property 1790 def height_metadata(self): 1791 """Gets the height_metadata of this Zip. # noqa: E501 1792 1793 Metadata that indicates whether the `height` property is editable. # noqa: E501 1794 1795 :return: The height_metadata of this Zip. # noqa: E501 1796 :rtype: PropertyMetadata 1797 """ 1798 return self._height_metadata 1799 1800 @height_metadata.setter 1801 def height_metadata(self, height_metadata): 1802 """Sets the height_metadata of this Zip. 1803 1804 Metadata that indicates whether the `height` property is editable. # noqa: E501 1805 1806 :param height_metadata: The height_metadata of this Zip. # noqa: E501 1807 :type: PropertyMetadata 1808 """ 1809 1810 self._height_metadata = height_metadata 1811 1812 @property 1813 def italic(self): 1814 """Gets the italic of this Zip. # noqa: E501 1815 1816 When set to **true**, the information in the tab is italic. # noqa: E501 1817 1818 :return: The italic of this Zip. # noqa: E501 1819 :rtype: str 1820 """ 1821 return self._italic 1822 1823 @italic.setter 1824 def italic(self, italic): 1825 """Sets the italic of this Zip. 1826 1827 When set to **true**, the information in the tab is italic. # noqa: E501 1828 1829 :param italic: The italic of this Zip. # noqa: E501 1830 :type: str 1831 """ 1832 1833 self._italic = italic 1834 1835 @property 1836 def italic_metadata(self): 1837 """Gets the italic_metadata of this Zip. # noqa: E501 1838 1839 Metadata that indicates whether the `italic` property is editable. # noqa: E501 1840 1841 :return: The italic_metadata of this Zip. # noqa: E501 1842 :rtype: PropertyMetadata 1843 """ 1844 return self._italic_metadata 1845 1846 @italic_metadata.setter 1847 def italic_metadata(self, italic_metadata): 1848 """Sets the italic_metadata of this Zip. 1849 1850 Metadata that indicates whether the `italic` property is editable. # noqa: E501 1851 1852 :param italic_metadata: The italic_metadata of this Zip. # noqa: E501 1853 :type: PropertyMetadata 1854 """ 1855 1856 self._italic_metadata = italic_metadata 1857 1858 @property 1859 def locale_policy(self): 1860 """Gets the locale_policy of this Zip. # noqa: E501 1861 1862 Reserved for DocuSign. # noqa: E501 1863 1864 :return: The locale_policy of this Zip. # noqa: E501 1865 :rtype: LocalePolicyTab 1866 """ 1867 return self._locale_policy 1868 1869 @locale_policy.setter 1870 def locale_policy(self, locale_policy): 1871 """Sets the locale_policy of this Zip. 1872 1873 Reserved for DocuSign. # noqa: E501 1874 1875 :param locale_policy: The locale_policy of this Zip. # noqa: E501 1876 :type: LocalePolicyTab 1877 """ 1878 1879 self._locale_policy = locale_policy 1880 1881 @property 1882 def locked(self): 1883 """Gets the locked of this Zip. # noqa: E501 1884 1885 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 1886 1887 :return: The locked of this Zip. # noqa: E501 1888 :rtype: str 1889 """ 1890 return self._locked 1891 1892 @locked.setter 1893 def locked(self, locked): 1894 """Sets the locked of this Zip. 1895 1896 When set to **true**, the signer cannot change the data of the custom tab. # noqa: E501 1897 1898 :param locked: The locked of this Zip. # noqa: E501 1899 :type: str 1900 """ 1901 1902 self._locked = locked 1903 1904 @property 1905 def locked_metadata(self): 1906 """Gets the locked_metadata of this Zip. # noqa: E501 1907 1908 Metadata that indicates whether the `locked` property is editable. # noqa: E501 1909 1910 :return: The locked_metadata of this Zip. # noqa: E501 1911 :rtype: PropertyMetadata 1912 """ 1913 return self._locked_metadata 1914 1915 @locked_metadata.setter 1916 def locked_metadata(self, locked_metadata): 1917 """Sets the locked_metadata of this Zip. 1918 1919 Metadata that indicates whether the `locked` property is editable. # noqa: E501 1920 1921 :param locked_metadata: The locked_metadata of this Zip. # noqa: E501 1922 :type: PropertyMetadata 1923 """ 1924 1925 self._locked_metadata = locked_metadata 1926 1927 @property 1928 def max_length(self): 1929 """Gets the max_length of this Zip. # noqa: E501 1930 1931 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 1932 1933 :return: The max_length of this Zip. # noqa: E501 1934 :rtype: str 1935 """ 1936 return self._max_length 1937 1938 @max_length.setter 1939 def max_length(self, max_length): 1940 """Sets the max_length of this Zip. 1941 1942 An optional value that describes the maximum length of the property when the property is a string. # noqa: E501 1943 1944 :param max_length: The max_length of this Zip. # noqa: E501 1945 :type: str 1946 """ 1947 1948 self._max_length = max_length 1949 1950 @property 1951 def max_length_metadata(self): 1952 """Gets the max_length_metadata of this Zip. # noqa: E501 1953 1954 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 1955 1956 :return: The max_length_metadata of this Zip. # noqa: E501 1957 :rtype: PropertyMetadata 1958 """ 1959 return self._max_length_metadata 1960 1961 @max_length_metadata.setter 1962 def max_length_metadata(self, max_length_metadata): 1963 """Sets the max_length_metadata of this Zip. 1964 1965 Metadata that indicates whether the `maxLength` property is editable. # noqa: E501 1966 1967 :param max_length_metadata: The max_length_metadata of this Zip. # noqa: E501 1968 :type: PropertyMetadata 1969 """ 1970 1971 self._max_length_metadata = max_length_metadata 1972 1973 @property 1974 def merge_field(self): 1975 """Gets the merge_field of this Zip. # noqa: E501 1976 1977 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1978 1979 :return: The merge_field of this Zip. # noqa: E501 1980 :rtype: MergeField 1981 """ 1982 return self._merge_field 1983 1984 @merge_field.setter 1985 def merge_field(self, merge_field): 1986 """Sets the merge_field of this Zip. 1987 1988 Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501 1989 1990 :param merge_field: The merge_field of this Zip. # noqa: E501 1991 :type: MergeField 1992 """ 1993 1994 self._merge_field = merge_field 1995 1996 @property 1997 def merge_field_xml(self): 1998 """Gets the merge_field_xml of this Zip. # noqa: E501 1999 2000 # noqa: E501 2001 2002 :return: The merge_field_xml of this Zip. # noqa: E501 2003 :rtype: str 2004 """ 2005 return self._merge_field_xml 2006 2007 @merge_field_xml.setter 2008 def merge_field_xml(self, merge_field_xml): 2009 """Sets the merge_field_xml of this Zip. 2010 2011 # noqa: E501 2012 2013 :param merge_field_xml: The merge_field_xml of this Zip. # noqa: E501 2014 :type: str 2015 """ 2016 2017 self._merge_field_xml = merge_field_xml 2018 2019 @property 2020 def name(self): 2021 """Gets the name of this Zip. # noqa: E501 2022 2023 # noqa: E501 2024 2025 :return: The name of this Zip. # noqa: E501 2026 :rtype: str 2027 """ 2028 return self._name 2029 2030 @name.setter 2031 def name(self, name): 2032 """Sets the name of this Zip. 2033 2034 # noqa: E501 2035 2036 :param name: The name of this Zip. # noqa: E501 2037 :type: str 2038 """ 2039 2040 self._name = name 2041 2042 @property 2043 def name_metadata(self): 2044 """Gets the name_metadata of this Zip. # noqa: E501 2045 2046 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2047 2048 :return: The name_metadata of this Zip. # noqa: E501 2049 :rtype: PropertyMetadata 2050 """ 2051 return self._name_metadata 2052 2053 @name_metadata.setter 2054 def name_metadata(self, name_metadata): 2055 """Sets the name_metadata of this Zip. 2056 2057 Metadata that indicates whether the `name` property is editable. This property is read-only. # noqa: E501 2058 2059 :param name_metadata: The name_metadata of this Zip. # noqa: E501 2060 :type: PropertyMetadata 2061 """ 2062 2063 self._name_metadata = name_metadata 2064 2065 @property 2066 def original_value(self): 2067 """Gets the original_value of this Zip. # noqa: E501 2068 2069 The initial value of the tab when it was sent to the recipient. # noqa: E501 2070 2071 :return: The original_value of this Zip. # noqa: E501 2072 :rtype: str 2073 """ 2074 return self._original_value 2075 2076 @original_value.setter 2077 def original_value(self, original_value): 2078 """Sets the original_value of this Zip. 2079 2080 The initial value of the tab when it was sent to the recipient. # noqa: E501 2081 2082 :param original_value: The original_value of this Zip. # noqa: E501 2083 :type: str 2084 """ 2085 2086 self._original_value = original_value 2087 2088 @property 2089 def original_value_metadata(self): 2090 """Gets the original_value_metadata of this Zip. # noqa: E501 2091 2092 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2093 2094 :return: The original_value_metadata of this Zip. # noqa: E501 2095 :rtype: PropertyMetadata 2096 """ 2097 return self._original_value_metadata 2098 2099 @original_value_metadata.setter 2100 def original_value_metadata(self, original_value_metadata): 2101 """Sets the original_value_metadata of this Zip. 2102 2103 Metadata that indicates whether the `originalValue` property is editable. # noqa: E501 2104 2105 :param original_value_metadata: The original_value_metadata of this Zip. # noqa: E501 2106 :type: PropertyMetadata 2107 """ 2108 2109 self._original_value_metadata = original_value_metadata 2110 2111 @property 2112 def page_number(self): 2113 """Gets the page_number of this Zip. # noqa: E501 2114 2115 Specifies the page number on which the tab is located. # noqa: E501 2116 2117 :return: The page_number of this Zip. # noqa: E501 2118 :rtype: str 2119 """ 2120 return self._page_number 2121 2122 @page_number.setter 2123 def page_number(self, page_number): 2124 """Sets the page_number of this Zip. 2125 2126 Specifies the page number on which the tab is located. # noqa: E501 2127 2128 :param page_number: The page_number of this Zip. # noqa: E501 2129 :type: str 2130 """ 2131 2132 self._page_number = page_number 2133 2134 @property 2135 def page_number_metadata(self): 2136 """Gets the page_number_metadata of this Zip. # noqa: E501 2137 2138 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2139 2140 :return: The page_number_metadata of this Zip. # noqa: E501 2141 :rtype: PropertyMetadata 2142 """ 2143 return self._page_number_metadata 2144 2145 @page_number_metadata.setter 2146 def page_number_metadata(self, page_number_metadata): 2147 """Sets the page_number_metadata of this Zip. 2148 2149 Metadata that indicates whether the `pageNumber` property is editable. # noqa: E501 2150 2151 :param page_number_metadata: The page_number_metadata of this Zip. # noqa: E501 2152 :type: PropertyMetadata 2153 """ 2154 2155 self._page_number_metadata = page_number_metadata 2156 2157 @property 2158 def recipient_id(self): 2159 """Gets the recipient_id of this Zip. # noqa: E501 2160 2161 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2162 2163 :return: The recipient_id of this Zip. # noqa: E501 2164 :rtype: str 2165 """ 2166 return self._recipient_id 2167 2168 @recipient_id.setter 2169 def recipient_id(self, recipient_id): 2170 """Sets the recipient_id of this Zip. 2171 2172 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. # noqa: E501 2173 2174 :param recipient_id: The recipient_id of this Zip. # noqa: E501 2175 :type: str 2176 """ 2177 2178 self._recipient_id = recipient_id 2179 2180 @property 2181 def recipient_id_guid(self): 2182 """Gets the recipient_id_guid of this Zip. # noqa: E501 2183 2184 # noqa: E501 2185 2186 :return: The recipient_id_guid of this Zip. # noqa: E501 2187 :rtype: str 2188 """ 2189 return self._recipient_id_guid 2190 2191 @recipient_id_guid.setter 2192 def recipient_id_guid(self, recipient_id_guid): 2193 """Sets the recipient_id_guid of this Zip. 2194 2195 # noqa: E501 2196 2197 :param recipient_id_guid: The recipient_id_guid of this Zip. # noqa: E501 2198 :type: str 2199 """ 2200 2201 self._recipient_id_guid = recipient_id_guid 2202 2203 @property 2204 def recipient_id_guid_metadata(self): 2205 """Gets the recipient_id_guid_metadata of this Zip. # noqa: E501 2206 2207 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2208 2209 :return: The recipient_id_guid_metadata of this Zip. # noqa: E501 2210 :rtype: PropertyMetadata 2211 """ 2212 return self._recipient_id_guid_metadata 2213 2214 @recipient_id_guid_metadata.setter 2215 def recipient_id_guid_metadata(self, recipient_id_guid_metadata): 2216 """Sets the recipient_id_guid_metadata of this Zip. 2217 2218 Metadata that indicates whether the `recipientIdGuid` property is editable. # noqa: E501 2219 2220 :param recipient_id_guid_metadata: The recipient_id_guid_metadata of this Zip. # noqa: E501 2221 :type: PropertyMetadata 2222 """ 2223 2224 self._recipient_id_guid_metadata = recipient_id_guid_metadata 2225 2226 @property 2227 def recipient_id_metadata(self): 2228 """Gets the recipient_id_metadata of this Zip. # noqa: E501 2229 2230 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2231 2232 :return: The recipient_id_metadata of this Zip. # noqa: E501 2233 :rtype: PropertyMetadata 2234 """ 2235 return self._recipient_id_metadata 2236 2237 @recipient_id_metadata.setter 2238 def recipient_id_metadata(self, recipient_id_metadata): 2239 """Sets the recipient_id_metadata of this Zip. 2240 2241 Metadata that indicates whether the `recipientId` property is editable. # noqa: E501 2242 2243 :param recipient_id_metadata: The recipient_id_metadata of this Zip. # noqa: E501 2244 :type: PropertyMetadata 2245 """ 2246 2247 self._recipient_id_metadata = recipient_id_metadata 2248 2249 @property 2250 def require_all(self): 2251 """Gets the require_all of this Zip. # noqa: E501 2252 2253 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2254 2255 :return: The require_all of this Zip. # noqa: E501 2256 :rtype: str 2257 """ 2258 return self._require_all 2259 2260 @require_all.setter 2261 def require_all(self, require_all): 2262 """Sets the require_all of this Zip. 2263 2264 When set to **true** and shared is true, information must be entered in this field to complete the envelope. # noqa: E501 2265 2266 :param require_all: The require_all of this Zip. # noqa: E501 2267 :type: str 2268 """ 2269 2270 self._require_all = require_all 2271 2272 @property 2273 def require_all_metadata(self): 2274 """Gets the require_all_metadata of this Zip. # noqa: E501 2275 2276 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2277 2278 :return: The require_all_metadata of this Zip. # noqa: E501 2279 :rtype: PropertyMetadata 2280 """ 2281 return self._require_all_metadata 2282 2283 @require_all_metadata.setter 2284 def require_all_metadata(self, require_all_metadata): 2285 """Sets the require_all_metadata of this Zip. 2286 2287 Metadata that indicates whether the `requireAll` property is editable. # noqa: E501 2288 2289 :param require_all_metadata: The require_all_metadata of this Zip. # noqa: E501 2290 :type: PropertyMetadata 2291 """ 2292 2293 self._require_all_metadata = require_all_metadata 2294 2295 @property 2296 def required(self): 2297 """Gets the required of this Zip. # noqa: E501 2298 2299 When set to **true**, the signer is required to fill out this tab # noqa: E501 2300 2301 :return: The required of this Zip. # noqa: E501 2302 :rtype: str 2303 """ 2304 return self._required 2305 2306 @required.setter 2307 def required(self, required): 2308 """Sets the required of this Zip. 2309 2310 When set to **true**, the signer is required to fill out this tab # noqa: E501 2311 2312 :param required: The required of this Zip. # noqa: E501 2313 :type: str 2314 """ 2315 2316 self._required = required 2317 2318 @property 2319 def required_metadata(self): 2320 """Gets the required_metadata of this Zip. # noqa: E501 2321 2322 Metadata that indicates whether the `required` property is editable. # noqa: E501 2323 2324 :return: The required_metadata of this Zip. # noqa: E501 2325 :rtype: PropertyMetadata 2326 """ 2327 return self._required_metadata 2328 2329 @required_metadata.setter 2330 def required_metadata(self, required_metadata): 2331 """Sets the required_metadata of this Zip. 2332 2333 Metadata that indicates whether the `required` property is editable. # noqa: E501 2334 2335 :param required_metadata: The required_metadata of this Zip. # noqa: E501 2336 :type: PropertyMetadata 2337 """ 2338 2339 self._required_metadata = required_metadata 2340 2341 @property 2342 def require_initial_on_shared_change(self): 2343 """Gets the require_initial_on_shared_change of this Zip. # noqa: E501 2344 2345 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2346 2347 :return: The require_initial_on_shared_change of this Zip. # noqa: E501 2348 :rtype: str 2349 """ 2350 return self._require_initial_on_shared_change 2351 2352 @require_initial_on_shared_change.setter 2353 def require_initial_on_shared_change(self, require_initial_on_shared_change): 2354 """Sets the require_initial_on_shared_change of this Zip. 2355 2356 Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. # noqa: E501 2357 2358 :param require_initial_on_shared_change: The require_initial_on_shared_change of this Zip. # noqa: E501 2359 :type: str 2360 """ 2361 2362 self._require_initial_on_shared_change = require_initial_on_shared_change 2363 2364 @property 2365 def require_initial_on_shared_change_metadata(self): 2366 """Gets the require_initial_on_shared_change_metadata of this Zip. # noqa: E501 2367 2368 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2369 2370 :return: The require_initial_on_shared_change_metadata of this Zip. # noqa: E501 2371 :rtype: PropertyMetadata 2372 """ 2373 return self._require_initial_on_shared_change_metadata 2374 2375 @require_initial_on_shared_change_metadata.setter 2376 def require_initial_on_shared_change_metadata(self, require_initial_on_shared_change_metadata): 2377 """Sets the require_initial_on_shared_change_metadata of this Zip. 2378 2379 Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. # noqa: E501 2380 2381 :param require_initial_on_shared_change_metadata: The require_initial_on_shared_change_metadata of this Zip. # noqa: E501 2382 :type: PropertyMetadata 2383 """ 2384 2385 self._require_initial_on_shared_change_metadata = require_initial_on_shared_change_metadata 2386 2387 @property 2388 def sender_required(self): 2389 """Gets the sender_required of this Zip. # noqa: E501 2390 2391 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2392 2393 :return: The sender_required of this Zip. # noqa: E501 2394 :rtype: str 2395 """ 2396 return self._sender_required 2397 2398 @sender_required.setter 2399 def sender_required(self, sender_required): 2400 """Sets the sender_required of this Zip. 2401 2402 When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. # noqa: E501 2403 2404 :param sender_required: The sender_required of this Zip. # noqa: E501 2405 :type: str 2406 """ 2407 2408 self._sender_required = sender_required 2409 2410 @property 2411 def sender_required_metadata(self): 2412 """Gets the sender_required_metadata of this Zip. # noqa: E501 2413 2414 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2415 2416 :return: The sender_required_metadata of this Zip. # noqa: E501 2417 :rtype: PropertyMetadata 2418 """ 2419 return self._sender_required_metadata 2420 2421 @sender_required_metadata.setter 2422 def sender_required_metadata(self, sender_required_metadata): 2423 """Sets the sender_required_metadata of this Zip. 2424 2425 Metadata that indicates whether the `senderRequired` property is editable. # noqa: E501 2426 2427 :param sender_required_metadata: The sender_required_metadata of this Zip. # noqa: E501 2428 :type: PropertyMetadata 2429 """ 2430 2431 self._sender_required_metadata = sender_required_metadata 2432 2433 @property 2434 def shared(self): 2435 """Gets the shared of this Zip. # noqa: E501 2436 2437 When set to **true**, this custom tab is shared. # noqa: E501 2438 2439 :return: The shared of this Zip. # noqa: E501 2440 :rtype: str 2441 """ 2442 return self._shared 2443 2444 @shared.setter 2445 def shared(self, shared): 2446 """Sets the shared of this Zip. 2447 2448 When set to **true**, this custom tab is shared. # noqa: E501 2449 2450 :param shared: The shared of this Zip. # noqa: E501 2451 :type: str 2452 """ 2453 2454 self._shared = shared 2455 2456 @property 2457 def shared_metadata(self): 2458 """Gets the shared_metadata of this Zip. # noqa: E501 2459 2460 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2461 2462 :return: The shared_metadata of this Zip. # noqa: E501 2463 :rtype: PropertyMetadata 2464 """ 2465 return self._shared_metadata 2466 2467 @shared_metadata.setter 2468 def shared_metadata(self, shared_metadata): 2469 """Sets the shared_metadata of this Zip. 2470 2471 Metadata that indicates whether the `shared` property is editable. # noqa: E501 2472 2473 :param shared_metadata: The shared_metadata of this Zip. # noqa: E501 2474 :type: PropertyMetadata 2475 """ 2476 2477 self._shared_metadata = shared_metadata 2478 2479 @property 2480 def share_to_recipients(self): 2481 """Gets the share_to_recipients of this Zip. # noqa: E501 2482 2483 # noqa: E501 2484 2485 :return: The share_to_recipients of this Zip. # noqa: E501 2486 :rtype: str 2487 """ 2488 return self._share_to_recipients 2489 2490 @share_to_recipients.setter 2491 def share_to_recipients(self, share_to_recipients): 2492 """Sets the share_to_recipients of this Zip. 2493 2494 # noqa: E501 2495 2496 :param share_to_recipients: The share_to_recipients of this Zip. # noqa: E501 2497 :type: str 2498 """ 2499 2500 self._share_to_recipients = share_to_recipients 2501 2502 @property 2503 def share_to_recipients_metadata(self): 2504 """Gets the share_to_recipients_metadata of this Zip. # noqa: E501 2505 2506 Reserved for DocuSign. # noqa: E501 2507 2508 :return: The share_to_recipients_metadata of this Zip. # noqa: E501 2509 :rtype: PropertyMetadata 2510 """ 2511 return self._share_to_recipients_metadata 2512 2513 @share_to_recipients_metadata.setter 2514 def share_to_recipients_metadata(self, share_to_recipients_metadata): 2515 """Sets the share_to_recipients_metadata of this Zip. 2516 2517 Reserved for DocuSign. # noqa: E501 2518 2519 :param share_to_recipients_metadata: The share_to_recipients_metadata of this Zip. # noqa: E501 2520 :type: PropertyMetadata 2521 """ 2522 2523 self._share_to_recipients_metadata = share_to_recipients_metadata 2524 2525 @property 2526 def smart_contract_information(self): 2527 """Gets the smart_contract_information of this Zip. # noqa: E501 2528 2529 Reserved for DocuSign. # noqa: E501 2530 2531 :return: The smart_contract_information of this Zip. # noqa: E501 2532 :rtype: SmartContractInformation 2533 """ 2534 return self._smart_contract_information 2535 2536 @smart_contract_information.setter 2537 def smart_contract_information(self, smart_contract_information): 2538 """Sets the smart_contract_information of this Zip. 2539 2540 Reserved for DocuSign. # noqa: E501 2541 2542 :param smart_contract_information: The smart_contract_information of this Zip. # noqa: E501 2543 :type: SmartContractInformation 2544 """ 2545 2546 self._smart_contract_information = smart_contract_information 2547 2548 @property 2549 def source(self): 2550 """Gets the source of this Zip. # noqa: E501 2551 2552 # noqa: E501 2553 2554 :return: The source of this Zip. # noqa: E501 2555 :rtype: str 2556 """ 2557 return self._source 2558 2559 @source.setter 2560 def source(self, source): 2561 """Sets the source of this Zip. 2562 2563 # noqa: E501 2564 2565 :param source: The source of this Zip. # noqa: E501 2566 :type: str 2567 """ 2568 2569 self._source = source 2570 2571 @property 2572 def status(self): 2573 """Gets the status of this Zip. # noqa: E501 2574 2575 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 2576 2577 :return: The status of this Zip. # noqa: E501 2578 :rtype: str 2579 """ 2580 return self._status 2581 2582 @status.setter 2583 def status(self, status): 2584 """Sets the status of this Zip. 2585 2586 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 2587 2588 :param status: The status of this Zip. # noqa: E501 2589 :type: str 2590 """ 2591 2592 self._status = status 2593 2594 @property 2595 def status_metadata(self): 2596 """Gets the status_metadata of this Zip. # noqa: E501 2597 2598 Metadata that indicates whether the `status` property is editable. # noqa: E501 2599 2600 :return: The status_metadata of this Zip. # noqa: E501 2601 :rtype: PropertyMetadata 2602 """ 2603 return self._status_metadata 2604 2605 @status_metadata.setter 2606 def status_metadata(self, status_metadata): 2607 """Sets the status_metadata of this Zip. 2608 2609 Metadata that indicates whether the `status` property is editable. # noqa: E501 2610 2611 :param status_metadata: The status_metadata of this Zip. # noqa: E501 2612 :type: PropertyMetadata 2613 """ 2614 2615 self._status_metadata = status_metadata 2616 2617 @property 2618 def tab_fully_qualified_path(self): 2619 """Gets the tab_fully_qualified_path of this Zip. # noqa: E501 2620 2621 # noqa: E501 2622 2623 :return: The tab_fully_qualified_path of this Zip. # noqa: E501 2624 :rtype: str 2625 """ 2626 return self._tab_fully_qualified_path 2627 2628 @tab_fully_qualified_path.setter 2629 def tab_fully_qualified_path(self, tab_fully_qualified_path): 2630 """Sets the tab_fully_qualified_path of this Zip. 2631 2632 # noqa: E501 2633 2634 :param tab_fully_qualified_path: The tab_fully_qualified_path of this Zip. # noqa: E501 2635 :type: str 2636 """ 2637 2638 self._tab_fully_qualified_path = tab_fully_qualified_path 2639 2640 @property 2641 def tab_group_labels(self): 2642 """Gets the tab_group_labels of this Zip. # noqa: E501 2643 2644 # noqa: E501 2645 2646 :return: The tab_group_labels of this Zip. # noqa: E501 2647 :rtype: list[str] 2648 """ 2649 return self._tab_group_labels 2650 2651 @tab_group_labels.setter 2652 def tab_group_labels(self, tab_group_labels): 2653 """Sets the tab_group_labels of this Zip. 2654 2655 # noqa: E501 2656 2657 :param tab_group_labels: The tab_group_labels of this Zip. # noqa: E501 2658 :type: list[str] 2659 """ 2660 2661 self._tab_group_labels = tab_group_labels 2662 2663 @property 2664 def tab_group_labels_metadata(self): 2665 """Gets the tab_group_labels_metadata of this Zip. # noqa: E501 2666 2667 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2668 2669 :return: The tab_group_labels_metadata of this Zip. # noqa: E501 2670 :rtype: PropertyMetadata 2671 """ 2672 return self._tab_group_labels_metadata 2673 2674 @tab_group_labels_metadata.setter 2675 def tab_group_labels_metadata(self, tab_group_labels_metadata): 2676 """Sets the tab_group_labels_metadata of this Zip. 2677 2678 Metadata that indicates whether the `tabGroupLabels` property is editable. # noqa: E501 2679 2680 :param tab_group_labels_metadata: The tab_group_labels_metadata of this Zip. # noqa: E501 2681 :type: PropertyMetadata 2682 """ 2683 2684 self._tab_group_labels_metadata = tab_group_labels_metadata 2685 2686 @property 2687 def tab_id(self): 2688 """Gets the tab_id of this Zip. # noqa: E501 2689 2690 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2691 2692 :return: The tab_id of this Zip. # noqa: E501 2693 :rtype: str 2694 """ 2695 return self._tab_id 2696 2697 @tab_id.setter 2698 def tab_id(self, tab_id): 2699 """Sets the tab_id of this Zip. 2700 2701 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. # noqa: E501 2702 2703 :param tab_id: The tab_id of this Zip. # noqa: E501 2704 :type: str 2705 """ 2706 2707 self._tab_id = tab_id 2708 2709 @property 2710 def tab_id_metadata(self): 2711 """Gets the tab_id_metadata of this Zip. # noqa: E501 2712 2713 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2714 2715 :return: The tab_id_metadata of this Zip. # noqa: E501 2716 :rtype: PropertyMetadata 2717 """ 2718 return self._tab_id_metadata 2719 2720 @tab_id_metadata.setter 2721 def tab_id_metadata(self, tab_id_metadata): 2722 """Sets the tab_id_metadata of this Zip. 2723 2724 Metadata that indicates whether the `tabId` property is editable. # noqa: E501 2725 2726 :param tab_id_metadata: The tab_id_metadata of this Zip. # noqa: E501 2727 :type: PropertyMetadata 2728 """ 2729 2730 self._tab_id_metadata = tab_id_metadata 2731 2732 @property 2733 def tab_label(self): 2734 """Gets the tab_label of this Zip. # noqa: E501 2735 2736 The label string associated with the tab. # noqa: E501 2737 2738 :return: The tab_label of this Zip. # noqa: E501 2739 :rtype: str 2740 """ 2741 return self._tab_label 2742 2743 @tab_label.setter 2744 def tab_label(self, tab_label): 2745 """Sets the tab_label of this Zip. 2746 2747 The label string associated with the tab. # noqa: E501 2748 2749 :param tab_label: The tab_label of this Zip. # noqa: E501 2750 :type: str 2751 """ 2752 2753 self._tab_label = tab_label 2754 2755 @property 2756 def tab_label_metadata(self): 2757 """Gets the tab_label_metadata of this Zip. # noqa: E501 2758 2759 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 2760 2761 :return: The tab_label_metadata of this Zip. # noqa: E501 2762 :rtype: PropertyMetadata 2763 """ 2764 return self._tab_label_metadata 2765 2766 @tab_label_metadata.setter 2767 def tab_label_metadata(self, tab_label_metadata): 2768 """Sets the tab_label_metadata of this Zip. 2769 2770 Metadata that indicates whether the `tabLabel` property is editable. # noqa: E501 2771 2772 :param tab_label_metadata: The tab_label_metadata of this Zip. # noqa: E501 2773 :type: PropertyMetadata 2774 """ 2775 2776 self._tab_label_metadata = tab_label_metadata 2777 2778 @property 2779 def tab_order(self): 2780 """Gets the tab_order of this Zip. # noqa: E501 2781 2782 # noqa: E501 2783 2784 :return: The tab_order of this Zip. # noqa: E501 2785 :rtype: str 2786 """ 2787 return self._tab_order 2788 2789 @tab_order.setter 2790 def tab_order(self, tab_order): 2791 """Sets the tab_order of this Zip. 2792 2793 # noqa: E501 2794 2795 :param tab_order: The tab_order of this Zip. # noqa: E501 2796 :type: str 2797 """ 2798 2799 self._tab_order = tab_order 2800 2801 @property 2802 def tab_order_metadata(self): 2803 """Gets the tab_order_metadata of this Zip. # noqa: E501 2804 2805 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 2806 2807 :return: The tab_order_metadata of this Zip. # noqa: E501 2808 :rtype: PropertyMetadata 2809 """ 2810 return self._tab_order_metadata 2811 2812 @tab_order_metadata.setter 2813 def tab_order_metadata(self, tab_order_metadata): 2814 """Sets the tab_order_metadata of this Zip. 2815 2816 Metadata that indicates whether the `tabOrder` property is editable. # noqa: E501 2817 2818 :param tab_order_metadata: The tab_order_metadata of this Zip. # noqa: E501 2819 :type: PropertyMetadata 2820 """ 2821 2822 self._tab_order_metadata = tab_order_metadata 2823 2824 @property 2825 def tab_type(self): 2826 """Gets the tab_type of this Zip. # noqa: E501 2827 2828 # noqa: E501 2829 2830 :return: The tab_type of this Zip. # noqa: E501 2831 :rtype: str 2832 """ 2833 return self._tab_type 2834 2835 @tab_type.setter 2836 def tab_type(self, tab_type): 2837 """Sets the tab_type of this Zip. 2838 2839 # noqa: E501 2840 2841 :param tab_type: The tab_type of this Zip. # noqa: E501 2842 :type: str 2843 """ 2844 2845 self._tab_type = tab_type 2846 2847 @property 2848 def tab_type_metadata(self): 2849 """Gets the tab_type_metadata of this Zip. # noqa: E501 2850 2851 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2852 2853 :return: The tab_type_metadata of this Zip. # noqa: E501 2854 :rtype: PropertyMetadata 2855 """ 2856 return self._tab_type_metadata 2857 2858 @tab_type_metadata.setter 2859 def tab_type_metadata(self, tab_type_metadata): 2860 """Sets the tab_type_metadata of this Zip. 2861 2862 Metadata that indicates whether the `tabType` property is editable. # noqa: E501 2863 2864 :param tab_type_metadata: The tab_type_metadata of this Zip. # noqa: E501 2865 :type: PropertyMetadata 2866 """ 2867 2868 self._tab_type_metadata = tab_type_metadata 2869 2870 @property 2871 def template_locked(self): 2872 """Gets the template_locked of this Zip. # noqa: E501 2873 2874 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2875 2876 :return: The template_locked of this Zip. # noqa: E501 2877 :rtype: str 2878 """ 2879 return self._template_locked 2880 2881 @template_locked.setter 2882 def template_locked(self, template_locked): 2883 """Sets the template_locked of this Zip. 2884 2885 When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. # noqa: E501 2886 2887 :param template_locked: The template_locked of this Zip. # noqa: E501 2888 :type: str 2889 """ 2890 2891 self._template_locked = template_locked 2892 2893 @property 2894 def template_locked_metadata(self): 2895 """Gets the template_locked_metadata of this Zip. # noqa: E501 2896 2897 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2898 2899 :return: The template_locked_metadata of this Zip. # noqa: E501 2900 :rtype: PropertyMetadata 2901 """ 2902 return self._template_locked_metadata 2903 2904 @template_locked_metadata.setter 2905 def template_locked_metadata(self, template_locked_metadata): 2906 """Sets the template_locked_metadata of this Zip. 2907 2908 Metadata that indicates whether the `templateLocked` property is editable. # noqa: E501 2909 2910 :param template_locked_metadata: The template_locked_metadata of this Zip. # noqa: E501 2911 :type: PropertyMetadata 2912 """ 2913 2914 self._template_locked_metadata = template_locked_metadata 2915 2916 @property 2917 def template_required(self): 2918 """Gets the template_required of this Zip. # noqa: E501 2919 2920 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2921 2922 :return: The template_required of this Zip. # noqa: E501 2923 :rtype: str 2924 """ 2925 return self._template_required 2926 2927 @template_required.setter 2928 def template_required(self, template_required): 2929 """Sets the template_required of this Zip. 2930 2931 When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. # noqa: E501 2932 2933 :param template_required: The template_required of this Zip. # noqa: E501 2934 :type: str 2935 """ 2936 2937 self._template_required = template_required 2938 2939 @property 2940 def template_required_metadata(self): 2941 """Gets the template_required_metadata of this Zip. # noqa: E501 2942 2943 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2944 2945 :return: The template_required_metadata of this Zip. # noqa: E501 2946 :rtype: PropertyMetadata 2947 """ 2948 return self._template_required_metadata 2949 2950 @template_required_metadata.setter 2951 def template_required_metadata(self, template_required_metadata): 2952 """Sets the template_required_metadata of this Zip. 2953 2954 Metadata that indicates whether the `templateRequired` property is editable. # noqa: E501 2955 2956 :param template_required_metadata: The template_required_metadata of this Zip. # noqa: E501 2957 :type: PropertyMetadata 2958 """ 2959 2960 self._template_required_metadata = template_required_metadata 2961 2962 @property 2963 def tooltip(self): 2964 """Gets the tooltip of this Zip. # noqa: E501 2965 2966 # noqa: E501 2967 2968 :return: The tooltip of this Zip. # noqa: E501 2969 :rtype: str 2970 """ 2971 return self._tooltip 2972 2973 @tooltip.setter 2974 def tooltip(self, tooltip): 2975 """Sets the tooltip of this Zip. 2976 2977 # noqa: E501 2978 2979 :param tooltip: The tooltip of this Zip. # noqa: E501 2980 :type: str 2981 """ 2982 2983 self._tooltip = tooltip 2984 2985 @property 2986 def tool_tip_metadata(self): 2987 """Gets the tool_tip_metadata of this Zip. # noqa: E501 2988 2989 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 2990 2991 :return: The tool_tip_metadata of this Zip. # noqa: E501 2992 :rtype: PropertyMetadata 2993 """ 2994 return self._tool_tip_metadata 2995 2996 @tool_tip_metadata.setter 2997 def tool_tip_metadata(self, tool_tip_metadata): 2998 """Sets the tool_tip_metadata of this Zip. 2999 3000 Metadata that indicates whether the `toolTip` property is editable. # noqa: E501 3001 3002 :param tool_tip_metadata: The tool_tip_metadata of this Zip. # noqa: E501 3003 :type: PropertyMetadata 3004 """ 3005 3006 self._tool_tip_metadata = tool_tip_metadata 3007 3008 @property 3009 def underline(self): 3010 """Gets the underline of this Zip. # noqa: E501 3011 3012 When set to **true**, the information in the tab is underlined. # noqa: E501 3013 3014 :return: The underline of this Zip. # noqa: E501 3015 :rtype: str 3016 """ 3017 return self._underline 3018 3019 @underline.setter 3020 def underline(self, underline): 3021 """Sets the underline of this Zip. 3022 3023 When set to **true**, the information in the tab is underlined. # noqa: E501 3024 3025 :param underline: The underline of this Zip. # noqa: E501 3026 :type: str 3027 """ 3028 3029 self._underline = underline 3030 3031 @property 3032 def underline_metadata(self): 3033 """Gets the underline_metadata of this Zip. # noqa: E501 3034 3035 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3036 3037 :return: The underline_metadata of this Zip. # noqa: E501 3038 :rtype: PropertyMetadata 3039 """ 3040 return self._underline_metadata 3041 3042 @underline_metadata.setter 3043 def underline_metadata(self, underline_metadata): 3044 """Sets the underline_metadata of this Zip. 3045 3046 Metadata that indicates whether the `underline` property is editable. # noqa: E501 3047 3048 :param underline_metadata: The underline_metadata of this Zip. # noqa: E501 3049 :type: PropertyMetadata 3050 """ 3051 3052 self._underline_metadata = underline_metadata 3053 3054 @property 3055 def use_dash4(self): 3056 """Gets the use_dash4 of this Zip. # noqa: E501 3057 3058 # noqa: E501 3059 3060 :return: The use_dash4 of this Zip. # noqa: E501 3061 :rtype: str 3062 """ 3063 return self._use_dash4 3064 3065 @use_dash4.setter 3066 def use_dash4(self, use_dash4): 3067 """Sets the use_dash4 of this Zip. 3068 3069 # noqa: E501 3070 3071 :param use_dash4: The use_dash4 of this Zip. # noqa: E501 3072 :type: str 3073 """ 3074 3075 self._use_dash4 = use_dash4 3076 3077 @property 3078 def use_dash4_metadata(self): 3079 """Gets the use_dash4_metadata of this Zip. # noqa: E501 3080 3081 Metadata that indicates whether the `useDash4` property is editable. # noqa: E501 3082 3083 :return: The use_dash4_metadata of this Zip. # noqa: E501 3084 :rtype: PropertyMetadata 3085 """ 3086 return self._use_dash4_metadata 3087 3088 @use_dash4_metadata.setter 3089 def use_dash4_metadata(self, use_dash4_metadata): 3090 """Sets the use_dash4_metadata of this Zip. 3091 3092 Metadata that indicates whether the `useDash4` property is editable. # noqa: E501 3093 3094 :param use_dash4_metadata: The use_dash4_metadata of this Zip. # noqa: E501 3095 :type: PropertyMetadata 3096 """ 3097 3098 self._use_dash4_metadata = use_dash4_metadata 3099 3100 @property 3101 def validation_message(self): 3102 """Gets the validation_message of this Zip. # noqa: E501 3103 3104 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3105 3106 :return: The validation_message of this Zip. # noqa: E501 3107 :rtype: str 3108 """ 3109 return self._validation_message 3110 3111 @validation_message.setter 3112 def validation_message(self, validation_message): 3113 """Sets the validation_message of this Zip. 3114 3115 The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501 3116 3117 :param validation_message: The validation_message of this Zip. # noqa: E501 3118 :type: str 3119 """ 3120 3121 self._validation_message = validation_message 3122 3123 @property 3124 def validation_message_metadata(self): 3125 """Gets the validation_message_metadata of this Zip. # noqa: E501 3126 3127 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3128 3129 :return: The validation_message_metadata of this Zip. # noqa: E501 3130 :rtype: PropertyMetadata 3131 """ 3132 return self._validation_message_metadata 3133 3134 @validation_message_metadata.setter 3135 def validation_message_metadata(self, validation_message_metadata): 3136 """Sets the validation_message_metadata of this Zip. 3137 3138 Metadata that indicates whether the `validationMessage` property is editable. # noqa: E501 3139 3140 :param validation_message_metadata: The validation_message_metadata of this Zip. # noqa: E501 3141 :type: PropertyMetadata 3142 """ 3143 3144 self._validation_message_metadata = validation_message_metadata 3145 3146 @property 3147 def validation_pattern(self): 3148 """Gets the validation_pattern of this Zip. # noqa: E501 3149 3150 A regular expression used to validate input for the tab. # noqa: E501 3151 3152 :return: The validation_pattern of this Zip. # noqa: E501 3153 :rtype: str 3154 """ 3155 return self._validation_pattern 3156 3157 @validation_pattern.setter 3158 def validation_pattern(self, validation_pattern): 3159 """Sets the validation_pattern of this Zip. 3160 3161 A regular expression used to validate input for the tab. # noqa: E501 3162 3163 :param validation_pattern: The validation_pattern of this Zip. # noqa: E501 3164 :type: str 3165 """ 3166 3167 self._validation_pattern = validation_pattern 3168 3169 @property 3170 def validation_pattern_metadata(self): 3171 """Gets the validation_pattern_metadata of this Zip. # noqa: E501 3172 3173 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3174 3175 :return: The validation_pattern_metadata of this Zip. # noqa: E501 3176 :rtype: PropertyMetadata 3177 """ 3178 return self._validation_pattern_metadata 3179 3180 @validation_pattern_metadata.setter 3181 def validation_pattern_metadata(self, validation_pattern_metadata): 3182 """Sets the validation_pattern_metadata of this Zip. 3183 3184 Metadata that indicates whether the `validationPattern` property is editable. # noqa: E501 3185 3186 :param validation_pattern_metadata: The validation_pattern_metadata of this Zip. # noqa: E501 3187 :type: PropertyMetadata 3188 """ 3189 3190 self._validation_pattern_metadata = validation_pattern_metadata 3191 3192 @property 3193 def value(self): 3194 """Gets the value of this Zip. # noqa: E501 3195 3196 Specifies the value of the tab. # noqa: E501 3197 3198 :return: The value of this Zip. # noqa: E501 3199 :rtype: str 3200 """ 3201 return self._value 3202 3203 @value.setter 3204 def value(self, value): 3205 """Sets the value of this Zip. 3206 3207 Specifies the value of the tab. # noqa: E501 3208 3209 :param value: The value of this Zip. # noqa: E501 3210 :type: str 3211 """ 3212 3213 self._value = value 3214 3215 @property 3216 def value_metadata(self): 3217 """Gets the value_metadata of this Zip. # noqa: E501 3218 3219 Metadata that indicates whether the `value` property is editable. # noqa: E501 3220 3221 :return: The value_metadata of this Zip. # noqa: E501 3222 :rtype: PropertyMetadata 3223 """ 3224 return self._value_metadata 3225 3226 @value_metadata.setter 3227 def value_metadata(self, value_metadata): 3228 """Sets the value_metadata of this Zip. 3229 3230 Metadata that indicates whether the `value` property is editable. # noqa: E501 3231 3232 :param value_metadata: The value_metadata of this Zip. # noqa: E501 3233 :type: PropertyMetadata 3234 """ 3235 3236 self._value_metadata = value_metadata 3237 3238 @property 3239 def warning_details(self): 3240 """Gets the warning_details of this Zip. # noqa: E501 3241 3242 # noqa: E501 3243 3244 :return: The warning_details of this Zip. # noqa: E501 3245 :rtype: ErrorDetails 3246 """ 3247 return self._warning_details 3248 3249 @warning_details.setter 3250 def warning_details(self, warning_details): 3251 """Sets the warning_details of this Zip. 3252 3253 # noqa: E501 3254 3255 :param warning_details: The warning_details of this Zip. # noqa: E501 3256 :type: ErrorDetails 3257 """ 3258 3259 self._warning_details = warning_details 3260 3261 @property 3262 def width(self): 3263 """Gets the width of this Zip. # noqa: E501 3264 3265 Width of the tab in pixels. # noqa: E501 3266 3267 :return: The width of this Zip. # noqa: E501 3268 :rtype: str 3269 """ 3270 return self._width 3271 3272 @width.setter 3273 def width(self, width): 3274 """Sets the width of this Zip. 3275 3276 Width of the tab in pixels. # noqa: E501 3277 3278 :param width: The width of this Zip. # noqa: E501 3279 :type: str 3280 """ 3281 3282 self._width = width 3283 3284 @property 3285 def width_metadata(self): 3286 """Gets the width_metadata of this Zip. # noqa: E501 3287 3288 Metadata that indicates whether the `width` property is editable. # noqa: E501 3289 3290 :return: The width_metadata of this Zip. # noqa: E501 3291 :rtype: PropertyMetadata 3292 """ 3293 return self._width_metadata 3294 3295 @width_metadata.setter 3296 def width_metadata(self, width_metadata): 3297 """Sets the width_metadata of this Zip. 3298 3299 Metadata that indicates whether the `width` property is editable. # noqa: E501 3300 3301 :param width_metadata: The width_metadata of this Zip. # noqa: E501 3302 :type: PropertyMetadata 3303 """ 3304 3305 self._width_metadata = width_metadata 3306 3307 @property 3308 def x_position(self): 3309 """Gets the x_position of this Zip. # noqa: E501 3310 3311 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3312 3313 :return: The x_position of this Zip. # noqa: E501 3314 :rtype: str 3315 """ 3316 return self._x_position 3317 3318 @x_position.setter 3319 def x_position(self, x_position): 3320 """Sets the x_position of this Zip. 3321 3322 This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3323 3324 :param x_position: The x_position of this Zip. # noqa: E501 3325 :type: str 3326 """ 3327 3328 self._x_position = x_position 3329 3330 @property 3331 def x_position_metadata(self): 3332 """Gets the x_position_metadata of this Zip. # noqa: E501 3333 3334 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3335 3336 :return: The x_position_metadata of this Zip. # noqa: E501 3337 :rtype: PropertyMetadata 3338 """ 3339 return self._x_position_metadata 3340 3341 @x_position_metadata.setter 3342 def x_position_metadata(self, x_position_metadata): 3343 """Sets the x_position_metadata of this Zip. 3344 3345 Metadata that indicates whether the `xPosition` property is editable. # noqa: E501 3346 3347 :param x_position_metadata: The x_position_metadata of this Zip. # noqa: E501 3348 :type: PropertyMetadata 3349 """ 3350 3351 self._x_position_metadata = x_position_metadata 3352 3353 @property 3354 def y_position(self): 3355 """Gets the y_position of this Zip. # noqa: E501 3356 3357 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3358 3359 :return: The y_position of this Zip. # noqa: E501 3360 :rtype: str 3361 """ 3362 return self._y_position 3363 3364 @y_position.setter 3365 def y_position(self, y_position): 3366 """Sets the y_position of this Zip. 3367 3368 This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. # noqa: E501 3369 3370 :param y_position: The y_position of this Zip. # noqa: E501 3371 :type: str 3372 """ 3373 3374 self._y_position = y_position 3375 3376 @property 3377 def y_position_metadata(self): 3378 """Gets the y_position_metadata of this Zip. # noqa: E501 3379 3380 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3381 3382 :return: The y_position_metadata of this Zip. # noqa: E501 3383 :rtype: PropertyMetadata 3384 """ 3385 return self._y_position_metadata 3386 3387 @y_position_metadata.setter 3388 def y_position_metadata(self, y_position_metadata): 3389 """Sets the y_position_metadata of this Zip. 3390 3391 Metadata that indicates whether the `yPosition` property is editable. # noqa: E501 3392 3393 :param y_position_metadata: The y_position_metadata of this Zip. # noqa: E501 3394 :type: PropertyMetadata 3395 """ 3396 3397 self._y_position_metadata = y_position_metadata 3398 3399 def to_dict(self): 3400 """Returns the model properties as a dict""" 3401 result = {} 3402 3403 for attr, _ in six.iteritems(self.swagger_types): 3404 value = getattr(self, attr) 3405 if isinstance(value, list): 3406 result[attr] = list(map( 3407 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3408 value 3409 )) 3410 elif hasattr(value, "to_dict"): 3411 result[attr] = value.to_dict() 3412 elif isinstance(value, dict): 3413 result[attr] = dict(map( 3414 lambda item: (item[0], item[1].to_dict()) 3415 if hasattr(item[1], "to_dict") else item, 3416 value.items() 3417 )) 3418 else: 3419 result[attr] = value 3420 if issubclass(Zip, dict): 3421 for key, value in self.items(): 3422 result[key] = value 3423 3424 return result 3425 3426 def to_str(self): 3427 """Returns the string representation of the model""" 3428 return pprint.pformat(self.to_dict()) 3429 3430 def __repr__(self): 3431 """For `print` and `pprint`""" 3432 return self.to_str() 3433 3434 def __eq__(self, other): 3435 """Returns true if both objects are equal""" 3436 if not isinstance(other, Zip): 3437 return False 3438 3439 return self.to_dict() == other.to_dict() 3440 3441 def __ne__(self, other): 3442 """Returns true if both objects are not equal""" 3443 if not isinstance(other, Zip): 3444 return True 3445 3446 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.
Zip(_configuration=None, **kwargs)
290 def __init__(self, _configuration=None, **kwargs): # noqa: E501 291 """Zip - a model defined in Swagger""" # noqa: E501 292 if _configuration is None: 293 _configuration = Configuration() 294 self._configuration = _configuration 295 296 self._agreement_attribute = None 297 self._agreement_attribute_locked = None 298 self._anchor_allow_white_space_in_characters = None 299 self._anchor_allow_white_space_in_characters_metadata = None 300 self._anchor_case_sensitive = None 301 self._anchor_case_sensitive_metadata = None 302 self._anchor_horizontal_alignment = None 303 self._anchor_horizontal_alignment_metadata = None 304 self._anchor_ignore_if_not_present = None 305 self._anchor_ignore_if_not_present_metadata = None 306 self._anchor_match_whole_word = None 307 self._anchor_match_whole_word_metadata = None 308 self._anchor_string = None 309 self._anchor_string_metadata = None 310 self._anchor_tab_processor_version = None 311 self._anchor_tab_processor_version_metadata = None 312 self._anchor_units = None 313 self._anchor_units_metadata = None 314 self._anchor_x_offset = None 315 self._anchor_x_offset_metadata = None 316 self._anchor_y_offset = None 317 self._anchor_y_offset_metadata = None 318 self._bold = None 319 self._bold_metadata = None 320 self._caption = None 321 self._caption_metadata = None 322 self._conceal_value_on_document = None 323 self._conceal_value_on_document_metadata = None 324 self._conditional_parent_label = None 325 self._conditional_parent_label_metadata = None 326 self._conditional_parent_value = None 327 self._conditional_parent_value_metadata = None 328 self._connected_object_details = None 329 self._custom_tab_id = None 330 self._custom_tab_id_metadata = None 331 self._disable_auto_size = None 332 self._disable_auto_size_metadata = None 333 self._document_id = None 334 self._document_id_metadata = None 335 self._error_details = None 336 self._extension_data = None 337 self._font = None 338 self._font_color = None 339 self._font_color_metadata = None 340 self._font_metadata = None 341 self._font_size = None 342 self._font_size_metadata = None 343 self._form_order = None 344 self._form_order_metadata = None 345 self._form_page_label = None 346 self._form_page_label_metadata = None 347 self._form_page_number = None 348 self._form_page_number_metadata = None 349 self._height = None 350 self._height_metadata = None 351 self._italic = None 352 self._italic_metadata = None 353 self._locale_policy = None 354 self._locked = None 355 self._locked_metadata = None 356 self._max_length = None 357 self._max_length_metadata = None 358 self._merge_field = None 359 self._merge_field_xml = None 360 self._name = None 361 self._name_metadata = None 362 self._original_value = None 363 self._original_value_metadata = None 364 self._page_number = None 365 self._page_number_metadata = None 366 self._recipient_id = None 367 self._recipient_id_guid = None 368 self._recipient_id_guid_metadata = None 369 self._recipient_id_metadata = None 370 self._require_all = None 371 self._require_all_metadata = None 372 self._required = None 373 self._required_metadata = None 374 self._require_initial_on_shared_change = None 375 self._require_initial_on_shared_change_metadata = None 376 self._sender_required = None 377 self._sender_required_metadata = None 378 self._shared = None 379 self._shared_metadata = None 380 self._share_to_recipients = None 381 self._share_to_recipients_metadata = None 382 self._smart_contract_information = None 383 self._source = None 384 self._status = None 385 self._status_metadata = None 386 self._tab_fully_qualified_path = None 387 self._tab_group_labels = None 388 self._tab_group_labels_metadata = None 389 self._tab_id = None 390 self._tab_id_metadata = None 391 self._tab_label = None 392 self._tab_label_metadata = None 393 self._tab_order = None 394 self._tab_order_metadata = None 395 self._tab_type = None 396 self._tab_type_metadata = None 397 self._template_locked = None 398 self._template_locked_metadata = None 399 self._template_required = None 400 self._template_required_metadata = None 401 self._tooltip = None 402 self._tool_tip_metadata = None 403 self._underline = None 404 self._underline_metadata = None 405 self._use_dash4 = None 406 self._use_dash4_metadata = None 407 self._validation_message = None 408 self._validation_message_metadata = None 409 self._validation_pattern = None 410 self._validation_pattern_metadata = None 411 self._value = None 412 self._value_metadata = None 413 self._warning_details = None 414 self._width = None 415 self._width_metadata = None 416 self._x_position = None 417 self._x_position_metadata = None 418 self._y_position = None 419 self._y_position_metadata = None 420 self.discriminator = None 421 422 setattr(self, "_{}".format('agreement_attribute'), kwargs.get('agreement_attribute', None)) 423 setattr(self, "_{}".format('agreement_attribute_locked'), kwargs.get('agreement_attribute_locked', None)) 424 setattr(self, "_{}".format('anchor_allow_white_space_in_characters'), kwargs.get('anchor_allow_white_space_in_characters', None)) 425 setattr(self, "_{}".format('anchor_allow_white_space_in_characters_metadata'), kwargs.get('anchor_allow_white_space_in_characters_metadata', None)) 426 setattr(self, "_{}".format('anchor_case_sensitive'), kwargs.get('anchor_case_sensitive', None)) 427 setattr(self, "_{}".format('anchor_case_sensitive_metadata'), kwargs.get('anchor_case_sensitive_metadata', None)) 428 setattr(self, "_{}".format('anchor_horizontal_alignment'), kwargs.get('anchor_horizontal_alignment', None)) 429 setattr(self, "_{}".format('anchor_horizontal_alignment_metadata'), kwargs.get('anchor_horizontal_alignment_metadata', None)) 430 setattr(self, "_{}".format('anchor_ignore_if_not_present'), kwargs.get('anchor_ignore_if_not_present', None)) 431 setattr(self, "_{}".format('anchor_ignore_if_not_present_metadata'), kwargs.get('anchor_ignore_if_not_present_metadata', None)) 432 setattr(self, "_{}".format('anchor_match_whole_word'), kwargs.get('anchor_match_whole_word', None)) 433 setattr(self, "_{}".format('anchor_match_whole_word_metadata'), kwargs.get('anchor_match_whole_word_metadata', None)) 434 setattr(self, "_{}".format('anchor_string'), kwargs.get('anchor_string', None)) 435 setattr(self, "_{}".format('anchor_string_metadata'), kwargs.get('anchor_string_metadata', None)) 436 setattr(self, "_{}".format('anchor_tab_processor_version'), kwargs.get('anchor_tab_processor_version', None)) 437 setattr(self, "_{}".format('anchor_tab_processor_version_metadata'), kwargs.get('anchor_tab_processor_version_metadata', None)) 438 setattr(self, "_{}".format('anchor_units'), kwargs.get('anchor_units', None)) 439 setattr(self, "_{}".format('anchor_units_metadata'), kwargs.get('anchor_units_metadata', None)) 440 setattr(self, "_{}".format('anchor_x_offset'), kwargs.get('anchor_x_offset', None)) 441 setattr(self, "_{}".format('anchor_x_offset_metadata'), kwargs.get('anchor_x_offset_metadata', None)) 442 setattr(self, "_{}".format('anchor_y_offset'), kwargs.get('anchor_y_offset', None)) 443 setattr(self, "_{}".format('anchor_y_offset_metadata'), kwargs.get('anchor_y_offset_metadata', None)) 444 setattr(self, "_{}".format('bold'), kwargs.get('bold', None)) 445 setattr(self, "_{}".format('bold_metadata'), kwargs.get('bold_metadata', None)) 446 setattr(self, "_{}".format('caption'), kwargs.get('caption', None)) 447 setattr(self, "_{}".format('caption_metadata'), kwargs.get('caption_metadata', None)) 448 setattr(self, "_{}".format('conceal_value_on_document'), kwargs.get('conceal_value_on_document', None)) 449 setattr(self, "_{}".format('conceal_value_on_document_metadata'), kwargs.get('conceal_value_on_document_metadata', None)) 450 setattr(self, "_{}".format('conditional_parent_label'), kwargs.get('conditional_parent_label', None)) 451 setattr(self, "_{}".format('conditional_parent_label_metadata'), kwargs.get('conditional_parent_label_metadata', None)) 452 setattr(self, "_{}".format('conditional_parent_value'), kwargs.get('conditional_parent_value', None)) 453 setattr(self, "_{}".format('conditional_parent_value_metadata'), kwargs.get('conditional_parent_value_metadata', None)) 454 setattr(self, "_{}".format('connected_object_details'), kwargs.get('connected_object_details', None)) 455 setattr(self, "_{}".format('custom_tab_id'), kwargs.get('custom_tab_id', None)) 456 setattr(self, "_{}".format('custom_tab_id_metadata'), kwargs.get('custom_tab_id_metadata', None)) 457 setattr(self, "_{}".format('disable_auto_size'), kwargs.get('disable_auto_size', None)) 458 setattr(self, "_{}".format('disable_auto_size_metadata'), kwargs.get('disable_auto_size_metadata', None)) 459 setattr(self, "_{}".format('document_id'), kwargs.get('document_id', None)) 460 setattr(self, "_{}".format('document_id_metadata'), kwargs.get('document_id_metadata', None)) 461 setattr(self, "_{}".format('error_details'), kwargs.get('error_details', None)) 462 setattr(self, "_{}".format('extension_data'), kwargs.get('extension_data', None)) 463 setattr(self, "_{}".format('font'), kwargs.get('font', None)) 464 setattr(self, "_{}".format('font_color'), kwargs.get('font_color', None)) 465 setattr(self, "_{}".format('font_color_metadata'), kwargs.get('font_color_metadata', None)) 466 setattr(self, "_{}".format('font_metadata'), kwargs.get('font_metadata', None)) 467 setattr(self, "_{}".format('font_size'), kwargs.get('font_size', None)) 468 setattr(self, "_{}".format('font_size_metadata'), kwargs.get('font_size_metadata', None)) 469 setattr(self, "_{}".format('form_order'), kwargs.get('form_order', None)) 470 setattr(self, "_{}".format('form_order_metadata'), kwargs.get('form_order_metadata', None)) 471 setattr(self, "_{}".format('form_page_label'), kwargs.get('form_page_label', None)) 472 setattr(self, "_{}".format('form_page_label_metadata'), kwargs.get('form_page_label_metadata', None)) 473 setattr(self, "_{}".format('form_page_number'), kwargs.get('form_page_number', None)) 474 setattr(self, "_{}".format('form_page_number_metadata'), kwargs.get('form_page_number_metadata', None)) 475 setattr(self, "_{}".format('height'), kwargs.get('height', None)) 476 setattr(self, "_{}".format('height_metadata'), kwargs.get('height_metadata', None)) 477 setattr(self, "_{}".format('italic'), kwargs.get('italic', None)) 478 setattr(self, "_{}".format('italic_metadata'), kwargs.get('italic_metadata', None)) 479 setattr(self, "_{}".format('locale_policy'), kwargs.get('locale_policy', None)) 480 setattr(self, "_{}".format('locked'), kwargs.get('locked', None)) 481 setattr(self, "_{}".format('locked_metadata'), kwargs.get('locked_metadata', None)) 482 setattr(self, "_{}".format('max_length'), kwargs.get('max_length', None)) 483 setattr(self, "_{}".format('max_length_metadata'), kwargs.get('max_length_metadata', None)) 484 setattr(self, "_{}".format('merge_field'), kwargs.get('merge_field', None)) 485 setattr(self, "_{}".format('merge_field_xml'), kwargs.get('merge_field_xml', None)) 486 setattr(self, "_{}".format('name'), kwargs.get('name', None)) 487 setattr(self, "_{}".format('name_metadata'), kwargs.get('name_metadata', None)) 488 setattr(self, "_{}".format('original_value'), kwargs.get('original_value', None)) 489 setattr(self, "_{}".format('original_value_metadata'), kwargs.get('original_value_metadata', None)) 490 setattr(self, "_{}".format('page_number'), kwargs.get('page_number', None)) 491 setattr(self, "_{}".format('page_number_metadata'), kwargs.get('page_number_metadata', None)) 492 setattr(self, "_{}".format('recipient_id'), kwargs.get('recipient_id', None)) 493 setattr(self, "_{}".format('recipient_id_guid'), kwargs.get('recipient_id_guid', None)) 494 setattr(self, "_{}".format('recipient_id_guid_metadata'), kwargs.get('recipient_id_guid_metadata', None)) 495 setattr(self, "_{}".format('recipient_id_metadata'), kwargs.get('recipient_id_metadata', None)) 496 setattr(self, "_{}".format('require_all'), kwargs.get('require_all', None)) 497 setattr(self, "_{}".format('require_all_metadata'), kwargs.get('require_all_metadata', None)) 498 setattr(self, "_{}".format('required'), kwargs.get('required', None)) 499 setattr(self, "_{}".format('required_metadata'), kwargs.get('required_metadata', None)) 500 setattr(self, "_{}".format('require_initial_on_shared_change'), kwargs.get('require_initial_on_shared_change', None)) 501 setattr(self, "_{}".format('require_initial_on_shared_change_metadata'), kwargs.get('require_initial_on_shared_change_metadata', None)) 502 setattr(self, "_{}".format('sender_required'), kwargs.get('sender_required', None)) 503 setattr(self, "_{}".format('sender_required_metadata'), kwargs.get('sender_required_metadata', None)) 504 setattr(self, "_{}".format('shared'), kwargs.get('shared', None)) 505 setattr(self, "_{}".format('shared_metadata'), kwargs.get('shared_metadata', None)) 506 setattr(self, "_{}".format('share_to_recipients'), kwargs.get('share_to_recipients', None)) 507 setattr(self, "_{}".format('share_to_recipients_metadata'), kwargs.get('share_to_recipients_metadata', None)) 508 setattr(self, "_{}".format('smart_contract_information'), kwargs.get('smart_contract_information', None)) 509 setattr(self, "_{}".format('source'), kwargs.get('source', None)) 510 setattr(self, "_{}".format('status'), kwargs.get('status', None)) 511 setattr(self, "_{}".format('status_metadata'), kwargs.get('status_metadata', None)) 512 setattr(self, "_{}".format('tab_fully_qualified_path'), kwargs.get('tab_fully_qualified_path', None)) 513 setattr(self, "_{}".format('tab_group_labels'), kwargs.get('tab_group_labels', None)) 514 setattr(self, "_{}".format('tab_group_labels_metadata'), kwargs.get('tab_group_labels_metadata', None)) 515 setattr(self, "_{}".format('tab_id'), kwargs.get('tab_id', None)) 516 setattr(self, "_{}".format('tab_id_metadata'), kwargs.get('tab_id_metadata', None)) 517 setattr(self, "_{}".format('tab_label'), kwargs.get('tab_label', None)) 518 setattr(self, "_{}".format('tab_label_metadata'), kwargs.get('tab_label_metadata', None)) 519 setattr(self, "_{}".format('tab_order'), kwargs.get('tab_order', None)) 520 setattr(self, "_{}".format('tab_order_metadata'), kwargs.get('tab_order_metadata', None)) 521 setattr(self, "_{}".format('tab_type'), kwargs.get('tab_type', None)) 522 setattr(self, "_{}".format('tab_type_metadata'), kwargs.get('tab_type_metadata', None)) 523 setattr(self, "_{}".format('template_locked'), kwargs.get('template_locked', None)) 524 setattr(self, "_{}".format('template_locked_metadata'), kwargs.get('template_locked_metadata', None)) 525 setattr(self, "_{}".format('template_required'), kwargs.get('template_required', None)) 526 setattr(self, "_{}".format('template_required_metadata'), kwargs.get('template_required_metadata', None)) 527 setattr(self, "_{}".format('tooltip'), kwargs.get('tooltip', None)) 528 setattr(self, "_{}".format('tool_tip_metadata'), kwargs.get('tool_tip_metadata', None)) 529 setattr(self, "_{}".format('underline'), kwargs.get('underline', None)) 530 setattr(self, "_{}".format('underline_metadata'), kwargs.get('underline_metadata', None)) 531 setattr(self, "_{}".format('use_dash4'), kwargs.get('use_dash4', None)) 532 setattr(self, "_{}".format('use_dash4_metadata'), kwargs.get('use_dash4_metadata', None)) 533 setattr(self, "_{}".format('validation_message'), kwargs.get('validation_message', None)) 534 setattr(self, "_{}".format('validation_message_metadata'), kwargs.get('validation_message_metadata', None)) 535 setattr(self, "_{}".format('validation_pattern'), kwargs.get('validation_pattern', None)) 536 setattr(self, "_{}".format('validation_pattern_metadata'), kwargs.get('validation_pattern_metadata', None)) 537 setattr(self, "_{}".format('value'), kwargs.get('value', None)) 538 setattr(self, "_{}".format('value_metadata'), kwargs.get('value_metadata', None)) 539 setattr(self, "_{}".format('warning_details'), kwargs.get('warning_details', None)) 540 setattr(self, "_{}".format('width'), kwargs.get('width', None)) 541 setattr(self, "_{}".format('width_metadata'), kwargs.get('width_metadata', None)) 542 setattr(self, "_{}".format('x_position'), kwargs.get('x_position', None)) 543 setattr(self, "_{}".format('x_position_metadata'), kwargs.get('x_position_metadata', None)) 544 setattr(self, "_{}".format('y_position'), kwargs.get('y_position', None)) 545 setattr(self, "_{}".format('y_position_metadata'), kwargs.get('y_position_metadata', None))
Zip - a model defined in Swagger
swagger_types = {'agreement_attribute': 'str', 'agreement_attribute_locked': 'str', 'anchor_allow_white_space_in_characters': 'str', 'anchor_allow_white_space_in_characters_metadata': 'PropertyMetadata', 'anchor_case_sensitive': 'str', 'anchor_case_sensitive_metadata': 'PropertyMetadata', 'anchor_horizontal_alignment': 'str', 'anchor_horizontal_alignment_metadata': 'PropertyMetadata', 'anchor_ignore_if_not_present': 'str', 'anchor_ignore_if_not_present_metadata': 'PropertyMetadata', 'anchor_match_whole_word': 'str', 'anchor_match_whole_word_metadata': 'PropertyMetadata', 'anchor_string': 'str', 'anchor_string_metadata': 'PropertyMetadata', 'anchor_tab_processor_version': 'str', 'anchor_tab_processor_version_metadata': 'PropertyMetadata', 'anchor_units': 'str', 'anchor_units_metadata': 'PropertyMetadata', 'anchor_x_offset': 'str', 'anchor_x_offset_metadata': 'PropertyMetadata', 'anchor_y_offset': 'str', 'anchor_y_offset_metadata': 'PropertyMetadata', 'bold': 'str', 'bold_metadata': 'PropertyMetadata', 'caption': 'str', 'caption_metadata': 'PropertyMetadata', 'conceal_value_on_document': 'str', 'conceal_value_on_document_metadata': 'PropertyMetadata', 'conditional_parent_label': 'str', 'conditional_parent_label_metadata': 'PropertyMetadata', 'conditional_parent_value': 'str', 'conditional_parent_value_metadata': 'PropertyMetadata', 'connected_object_details': 'ConnectedObjectDetails', 'custom_tab_id': 'str', 'custom_tab_id_metadata': 'PropertyMetadata', 'disable_auto_size': 'str', 'disable_auto_size_metadata': 'PropertyMetadata', 'document_id': 'str', 'document_id_metadata': 'PropertyMetadata', 'error_details': 'ErrorDetails', 'extension_data': 'ExtensionData', 'font': 'str', 'font_color': 'str', 'font_color_metadata': 'PropertyMetadata', 'font_metadata': 'PropertyMetadata', 'font_size': 'str', 'font_size_metadata': 'PropertyMetadata', 'form_order': 'str', 'form_order_metadata': 'PropertyMetadata', 'form_page_label': 'str', 'form_page_label_metadata': 'PropertyMetadata', 'form_page_number': 'str', 'form_page_number_metadata': 'PropertyMetadata', 'height': 'str', 'height_metadata': 'PropertyMetadata', 'italic': 'str', 'italic_metadata': 'PropertyMetadata', 'locale_policy': 'LocalePolicyTab', 'locked': 'str', 'locked_metadata': 'PropertyMetadata', 'max_length': 'str', 'max_length_metadata': 'PropertyMetadata', 'merge_field': 'MergeField', 'merge_field_xml': 'str', 'name': 'str', 'name_metadata': 'PropertyMetadata', 'original_value': 'str', 'original_value_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', 'require_all': 'str', 'require_all_metadata': 'PropertyMetadata', 'required': 'str', 'required_metadata': 'PropertyMetadata', 'require_initial_on_shared_change': 'str', 'require_initial_on_shared_change_metadata': 'PropertyMetadata', 'sender_required': 'str', 'sender_required_metadata': 'PropertyMetadata', 'shared': 'str', 'shared_metadata': 'PropertyMetadata', 'share_to_recipients': 'str', 'share_to_recipients_metadata': 'PropertyMetadata', 'smart_contract_information': 'SmartContractInformation', 'source': 'str', 'status': 'str', 'status_metadata': 'PropertyMetadata', 'tab_fully_qualified_path': 'str', 'tab_group_labels': 'list[str]', 'tab_group_labels_metadata': 'PropertyMetadata', 'tab_id': 'str', 'tab_id_metadata': 'PropertyMetadata', 'tab_label': 'str', 'tab_label_metadata': 'PropertyMetadata', 'tab_order': 'str', 'tab_order_metadata': 'PropertyMetadata', 'tab_type': 'str', 'tab_type_metadata': 'PropertyMetadata', 'template_locked': 'str', 'template_locked_metadata': 'PropertyMetadata', 'template_required': 'str', 'template_required_metadata': 'PropertyMetadata', 'tooltip': 'str', 'tool_tip_metadata': 'PropertyMetadata', 'underline': 'str', 'underline_metadata': 'PropertyMetadata', 'use_dash4': 'str', 'use_dash4_metadata': 'PropertyMetadata', 'validation_message': 'str', 'validation_message_metadata': 'PropertyMetadata', 'validation_pattern': 'str', 'validation_pattern_metadata': 'PropertyMetadata', 'value': 'str', 'value_metadata': 'PropertyMetadata', 'warning_details': 'ErrorDetails', 'width': 'str', 'width_metadata': 'PropertyMetadata', 'x_position': 'str', 'x_position_metadata': 'PropertyMetadata', 'y_position': 'str', 'y_position_metadata': 'PropertyMetadata'}
attribute_map = {'agreement_attribute': 'agreementAttribute', 'agreement_attribute_locked': 'agreementAttributeLocked', 'anchor_allow_white_space_in_characters': 'anchorAllowWhiteSpaceInCharacters', 'anchor_allow_white_space_in_characters_metadata': 'anchorAllowWhiteSpaceInCharactersMetadata', 'anchor_case_sensitive': 'anchorCaseSensitive', 'anchor_case_sensitive_metadata': 'anchorCaseSensitiveMetadata', 'anchor_horizontal_alignment': 'anchorHorizontalAlignment', 'anchor_horizontal_alignment_metadata': 'anchorHorizontalAlignmentMetadata', 'anchor_ignore_if_not_present': 'anchorIgnoreIfNotPresent', 'anchor_ignore_if_not_present_metadata': 'anchorIgnoreIfNotPresentMetadata', 'anchor_match_whole_word': 'anchorMatchWholeWord', 'anchor_match_whole_word_metadata': 'anchorMatchWholeWordMetadata', 'anchor_string': 'anchorString', 'anchor_string_metadata': 'anchorStringMetadata', 'anchor_tab_processor_version': 'anchorTabProcessorVersion', 'anchor_tab_processor_version_metadata': 'anchorTabProcessorVersionMetadata', 'anchor_units': 'anchorUnits', 'anchor_units_metadata': 'anchorUnitsMetadata', 'anchor_x_offset': 'anchorXOffset', 'anchor_x_offset_metadata': 'anchorXOffsetMetadata', 'anchor_y_offset': 'anchorYOffset', 'anchor_y_offset_metadata': 'anchorYOffsetMetadata', 'bold': 'bold', 'bold_metadata': 'boldMetadata', 'caption': 'caption', 'caption_metadata': 'captionMetadata', 'conceal_value_on_document': 'concealValueOnDocument', 'conceal_value_on_document_metadata': 'concealValueOnDocumentMetadata', 'conditional_parent_label': 'conditionalParentLabel', 'conditional_parent_label_metadata': 'conditionalParentLabelMetadata', 'conditional_parent_value': 'conditionalParentValue', 'conditional_parent_value_metadata': 'conditionalParentValueMetadata', 'connected_object_details': 'connectedObjectDetails', 'custom_tab_id': 'customTabId', 'custom_tab_id_metadata': 'customTabIdMetadata', 'disable_auto_size': 'disableAutoSize', 'disable_auto_size_metadata': 'disableAutoSizeMetadata', 'document_id': 'documentId', 'document_id_metadata': 'documentIdMetadata', 'error_details': 'errorDetails', 'extension_data': 'extensionData', 'font': 'font', 'font_color': 'fontColor', 'font_color_metadata': 'fontColorMetadata', 'font_metadata': 'fontMetadata', 'font_size': 'fontSize', 'font_size_metadata': 'fontSizeMetadata', 'form_order': 'formOrder', 'form_order_metadata': 'formOrderMetadata', 'form_page_label': 'formPageLabel', 'form_page_label_metadata': 'formPageLabelMetadata', 'form_page_number': 'formPageNumber', 'form_page_number_metadata': 'formPageNumberMetadata', 'height': 'height', 'height_metadata': 'heightMetadata', 'italic': 'italic', 'italic_metadata': 'italicMetadata', 'locale_policy': 'localePolicy', 'locked': 'locked', 'locked_metadata': 'lockedMetadata', 'max_length': 'maxLength', 'max_length_metadata': 'maxLengthMetadata', 'merge_field': 'mergeField', 'merge_field_xml': 'mergeFieldXml', 'name': 'name', 'name_metadata': 'nameMetadata', 'original_value': 'originalValue', 'original_value_metadata': 'originalValueMetadata', 'page_number': 'pageNumber', 'page_number_metadata': 'pageNumberMetadata', 'recipient_id': 'recipientId', 'recipient_id_guid': 'recipientIdGuid', 'recipient_id_guid_metadata': 'recipientIdGuidMetadata', 'recipient_id_metadata': 'recipientIdMetadata', 'require_all': 'requireAll', 'require_all_metadata': 'requireAllMetadata', 'required': 'required', 'required_metadata': 'requiredMetadata', 'require_initial_on_shared_change': 'requireInitialOnSharedChange', 'require_initial_on_shared_change_metadata': 'requireInitialOnSharedChangeMetadata', 'sender_required': 'senderRequired', 'sender_required_metadata': 'senderRequiredMetadata', 'shared': 'shared', 'shared_metadata': 'sharedMetadata', 'share_to_recipients': 'shareToRecipients', 'share_to_recipients_metadata': 'shareToRecipientsMetadata', 'smart_contract_information': 'smartContractInformation', 'source': 'source', 'status': 'status', 'status_metadata': 'statusMetadata', 'tab_fully_qualified_path': 'tabFullyQualifiedPath', 'tab_group_labels': 'tabGroupLabels', 'tab_group_labels_metadata': 'tabGroupLabelsMetadata', 'tab_id': 'tabId', 'tab_id_metadata': 'tabIdMetadata', 'tab_label': 'tabLabel', 'tab_label_metadata': 'tabLabelMetadata', 'tab_order': 'tabOrder', 'tab_order_metadata': 'tabOrderMetadata', 'tab_type': 'tabType', 'tab_type_metadata': 'tabTypeMetadata', 'template_locked': 'templateLocked', 'template_locked_metadata': 'templateLockedMetadata', 'template_required': 'templateRequired', 'template_required_metadata': 'templateRequiredMetadata', 'tooltip': 'tooltip', 'tool_tip_metadata': 'toolTipMetadata', 'underline': 'underline', 'underline_metadata': 'underlineMetadata', 'use_dash4': 'useDash4', 'use_dash4_metadata': 'useDash4Metadata', 'validation_message': 'validationMessage', 'validation_message_metadata': 'validationMessageMetadata', 'validation_pattern': 'validationPattern', 'validation_pattern_metadata': 'validationPatternMetadata', 'value': 'value', 'value_metadata': 'valueMetadata', 'warning_details': 'warningDetails', 'width': 'width', 'width_metadata': 'widthMetadata', 'x_position': 'xPosition', 'x_position_metadata': 'xPositionMetadata', 'y_position': 'yPosition', 'y_position_metadata': 'yPositionMetadata'}
agreement_attribute
Gets the agreement_attribute of this Zip. # noqa: E501
# noqa: E501
Returns
The agreement_attribute of this Zip. # noqa: E501
agreement_attribute_locked
Gets the agreement_attribute_locked of this Zip. # noqa: E501
# noqa: E501
Returns
The agreement_attribute_locked of this Zip. # noqa: E501
anchor_allow_white_space_in_characters
Gets the anchor_allow_white_space_in_characters of this Zip. # noqa: E501
# noqa: E501
Returns
The anchor_allow_white_space_in_characters of this Zip. # noqa: E501
anchor_allow_white_space_in_characters_metadata
Gets the anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable. # noqa: E501
Returns
The anchor_allow_white_space_in_characters_metadata of this Zip. # noqa: E501
anchor_case_sensitive
Gets the anchor_case_sensitive of this Zip. # 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 Zip. # noqa: E501
anchor_case_sensitive_metadata
Gets the anchor_case_sensitive_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorCaseSensitive property is editable. # noqa: E501
Returns
The anchor_case_sensitive_metadata of this Zip. # noqa: E501
anchor_horizontal_alignment
Gets the anchor_horizontal_alignment of this Zip. # 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 Zip. # noqa: E501
anchor_horizontal_alignment_metadata
Gets the anchor_horizontal_alignment_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorHorizontalAlignment property is editable. # noqa: E501
Returns
The anchor_horizontal_alignment_metadata of this Zip. # noqa: E501
anchor_ignore_if_not_present
Gets the anchor_ignore_if_not_present of this Zip. # 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 Zip. # noqa: E501
anchor_ignore_if_not_present_metadata
Gets the anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable. # noqa: E501
Returns
The anchor_ignore_if_not_present_metadata of this Zip. # noqa: E501
anchor_match_whole_word
Gets the anchor_match_whole_word of this Zip. # 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 Zip. # noqa: E501
anchor_match_whole_word_metadata
Gets the anchor_match_whole_word_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorMatchWholeWord property is editable. # noqa: E501
Returns
The anchor_match_whole_word_metadata of this Zip. # noqa: E501
anchor_string
Gets the anchor_string of this Zip. # noqa: E501
Anchor text information for a radio button. # noqa: E501
Returns
The anchor_string of this Zip. # noqa: E501
anchor_string_metadata
Gets the anchor_string_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorString property is editable. # noqa: E501
Returns
The anchor_string_metadata of this Zip. # noqa: E501
anchor_tab_processor_version
Gets the anchor_tab_processor_version of this Zip. # noqa: E501
# noqa: E501
Returns
The anchor_tab_processor_version of this Zip. # noqa: E501
anchor_tab_processor_version_metadata
Gets the anchor_tab_processor_version_metadata of this Zip. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The anchor_tab_processor_version_metadata of this Zip. # noqa: E501
anchor_units
Gets the anchor_units of this Zip. # 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 Zip. # noqa: E501
anchor_units_metadata
Gets the anchor_units_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorUnits property is editable. # noqa: E501
Returns
The anchor_units_metadata of this Zip. # noqa: E501
anchor_x_offset
Gets the anchor_x_offset of this Zip. # 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 Zip. # noqa: E501
anchor_x_offset_metadata
Gets the anchor_x_offset_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorXOffset property is editable. # noqa: E501
Returns
The anchor_x_offset_metadata of this Zip. # noqa: E501
anchor_y_offset
Gets the anchor_y_offset of this Zip. # 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 Zip. # noqa: E501
anchor_y_offset_metadata
Gets the anchor_y_offset_metadata of this Zip. # noqa: E501
Metadata that indicates whether the anchorYOffset property is editable. # noqa: E501
Returns
The anchor_y_offset_metadata of this Zip. # noqa: E501
bold
Gets the bold of this Zip. # noqa: E501
When set to true, the information in the tab is bold. # noqa: E501
Returns
The bold of this Zip. # noqa: E501
bold_metadata
Gets the bold_metadata of this Zip. # noqa: E501
Metadata that indicates whether the bold property is editable. # noqa: E501
Returns
The bold_metadata of this Zip. # noqa: E501
caption
Gets the caption of this Zip. # noqa: E501
# noqa: E501
Returns
The caption of this Zip. # noqa: E501
caption_metadata
Gets the caption_metadata of this Zip. # noqa: E501
# noqa: E501
Returns
The caption_metadata of this Zip. # noqa: E501
conceal_value_on_document
Gets the conceal_value_on_document of this Zip. # noqa: E501
When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. # noqa: E501
Returns
The conceal_value_on_document of this Zip. # noqa: E501
conceal_value_on_document_metadata
Gets the conceal_value_on_document_metadata of this Zip. # noqa: E501
Metadata that indicates whether the concealValueOnDocument property is editable. # noqa: E501
Returns
The conceal_value_on_document_metadata of this Zip. # noqa: E501
conditional_parent_label
Gets the conditional_parent_label of this Zip. # 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 Zip. # noqa: E501
conditional_parent_label_metadata
Gets the conditional_parent_label_metadata of this Zip. # noqa: E501
Metadata that indicates whether the conditionalParentLabel property is editable. # noqa: E501
Returns
The conditional_parent_label_metadata of this Zip. # noqa: E501
conditional_parent_value
Gets the conditional_parent_value of this Zip. # 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 Zip. # noqa: E501
conditional_parent_value_metadata
Gets the conditional_parent_value_metadata of this Zip. # noqa: E501
Metadata that indicates whether the conditionalParentValue property is editable. # noqa: E501
Returns
The conditional_parent_value_metadata of this Zip. # noqa: E501
connected_object_details
Gets the connected_object_details of this Zip. # noqa: E501
# noqa: E501
Returns
The connected_object_details of this Zip. # noqa: E501
custom_tab_id
Gets the custom_tab_id of this Zip. # 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 Zip. # noqa: E501
custom_tab_id_metadata
Gets the custom_tab_id_metadata of this Zip. # noqa: E501
Metadata that indicates whether the customTabId property is editable. # noqa: E501
Returns
The custom_tab_id_metadata of this Zip. # noqa: E501
disable_auto_size
Gets the disable_auto_size of this Zip. # noqa: E501
When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. # noqa: E501
Returns
The disable_auto_size of this Zip. # noqa: E501
disable_auto_size_metadata
Gets the disable_auto_size_metadata of this Zip. # noqa: E501
Metadata that indicates whether the disableAutoSize property is editable. # noqa: E501
Returns
The disable_auto_size_metadata of this Zip. # noqa: E501
document_id
Gets the document_id of this Zip. # 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 Zip. # noqa: E501
document_id_metadata
Gets the document_id_metadata of this Zip. # noqa: E501
Metadata that indicates whether the documentId property is editable. # noqa: E501
Returns
The document_id_metadata of this Zip. # noqa: E501
error_details
Gets the error_details of this Zip. # noqa: E501
Array or errors. # noqa: E501
Returns
The error_details of this Zip. # noqa: E501
extension_data
Gets the extension_data of this Zip. # noqa: E501
# noqa: E501
Returns
The extension_data of this Zip. # noqa: E501
font
Gets the font of this Zip. # 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 Zip. # noqa: E501
font_color
Gets the font_color of this Zip. # 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 Zip. # noqa: E501
font_color_metadata
Gets the font_color_metadata of this Zip. # noqa: E501
Metadata that indicates whether the fontColor property is editable. # noqa: E501
Returns
The font_color_metadata of this Zip. # noqa: E501
font_metadata
Gets the font_metadata of this Zip. # noqa: E501
Metadata that indicates whether the font property is editable. # noqa: E501
Returns
The font_metadata of this Zip. # noqa: E501
font_size
Gets the font_size of this Zip. # 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 Zip. # noqa: E501
font_size_metadata
Gets the font_size_metadata of this Zip. # noqa: E501
Metadata that indicates whether the fontSize property is editable. # noqa: E501
Returns
The font_size_metadata of this Zip. # noqa: E501
form_order
Gets the form_order of this Zip. # noqa: E501
# noqa: E501
Returns
The form_order of this Zip. # noqa: E501
form_order_metadata
Gets the form_order_metadata of this Zip. # noqa: E501
Metadata that indicates whether the formOrder property is editable. # noqa: E501
Returns
The form_order_metadata of this Zip. # noqa: E501
form_page_label
Gets the form_page_label of this Zip. # noqa: E501
# noqa: E501
Returns
The form_page_label of this Zip. # noqa: E501
form_page_label_metadata
Gets the form_page_label_metadata of this Zip. # noqa: E501
Metadata that indicates whether the formPageLabel property is editable. # noqa: E501
Returns
The form_page_label_metadata of this Zip. # noqa: E501
form_page_number
Gets the form_page_number of this Zip. # noqa: E501
# noqa: E501
Returns
The form_page_number of this Zip. # noqa: E501
form_page_number_metadata
Gets the form_page_number_metadata of this Zip. # noqa: E501
Metadata that indicates whether the fromPageNumber property is editable. # noqa: E501
Returns
The form_page_number_metadata of this Zip. # noqa: E501
height
Gets the height of this Zip. # noqa: E501
Height of the tab in pixels. # noqa: E501
Returns
The height of this Zip. # noqa: E501
height_metadata
Gets the height_metadata of this Zip. # noqa: E501
Metadata that indicates whether the height property is editable. # noqa: E501
Returns
The height_metadata of this Zip. # noqa: E501
italic
Gets the italic of this Zip. # noqa: E501
When set to true, the information in the tab is italic. # noqa: E501
Returns
The italic of this Zip. # noqa: E501
italic_metadata
Gets the italic_metadata of this Zip. # noqa: E501
Metadata that indicates whether the italic property is editable. # noqa: E501
Returns
The italic_metadata of this Zip. # noqa: E501
locale_policy
Gets the locale_policy of this Zip. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The locale_policy of this Zip. # noqa: E501
locked
Gets the locked of this Zip. # noqa: E501
When set to true, the signer cannot change the data of the custom tab. # noqa: E501
Returns
The locked of this Zip. # noqa: E501
locked_metadata
Gets the locked_metadata of this Zip. # noqa: E501
Metadata that indicates whether the locked property is editable. # noqa: E501
Returns
The locked_metadata of this Zip. # noqa: E501
max_length
Gets the max_length of this Zip. # noqa: E501
An optional value that describes the maximum length of the property when the property is a string. # noqa: E501
Returns
The max_length of this Zip. # noqa: E501
max_length_metadata
Gets the max_length_metadata of this Zip. # noqa: E501
Metadata that indicates whether the maxLength property is editable. # noqa: E501
Returns
The max_length_metadata of this Zip. # noqa: E501
merge_field
Gets the merge_field of this Zip. # noqa: E501
Contains the information necessary to map the tab to a field in SalesForce. # noqa: E501
Returns
The merge_field of this Zip. # noqa: E501
merge_field_xml
Gets the merge_field_xml of this Zip. # noqa: E501
# noqa: E501
Returns
The merge_field_xml of this Zip. # noqa: E501
name
Gets the name of this Zip. # noqa: E501
# noqa: E501
Returns
The name of this Zip. # noqa: E501
name_metadata
Gets the name_metadata of this Zip. # noqa: E501
Metadata that indicates whether the name property is editable. This property is read-only. # noqa: E501
Returns
The name_metadata of this Zip. # noqa: E501
original_value
Gets the original_value of this Zip. # noqa: E501
The initial value of the tab when it was sent to the recipient. # noqa: E501
Returns
The original_value of this Zip. # noqa: E501
original_value_metadata
Gets the original_value_metadata of this Zip. # noqa: E501
Metadata that indicates whether the originalValue property is editable. # noqa: E501
Returns
The original_value_metadata of this Zip. # noqa: E501
page_number
Gets the page_number of this Zip. # noqa: E501
Specifies the page number on which the tab is located. # noqa: E501
Returns
The page_number of this Zip. # noqa: E501
page_number_metadata
Gets the page_number_metadata of this Zip. # noqa: E501
Metadata that indicates whether the pageNumber property is editable. # noqa: E501
Returns
The page_number_metadata of this Zip. # noqa: E501
recipient_id
Gets the recipient_id of this Zip. # 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 Zip. # noqa: E501
recipient_id_guid
Gets the recipient_id_guid of this Zip. # noqa: E501
# noqa: E501
Returns
The recipient_id_guid of this Zip. # noqa: E501
recipient_id_guid_metadata
Gets the recipient_id_guid_metadata of this Zip. # noqa: E501
Metadata that indicates whether the recipientIdGuid property is editable. # noqa: E501
Returns
The recipient_id_guid_metadata of this Zip. # noqa: E501
recipient_id_metadata
Gets the recipient_id_metadata of this Zip. # noqa: E501
Metadata that indicates whether the recipientId property is editable. # noqa: E501
Returns
The recipient_id_metadata of this Zip. # noqa: E501
require_all
Gets the require_all of this Zip. # noqa: E501
When set to true and shared is true, information must be entered in this field to complete the envelope. # noqa: E501
Returns
The require_all of this Zip. # noqa: E501
require_all_metadata
Gets the require_all_metadata of this Zip. # noqa: E501
Metadata that indicates whether the requireAll property is editable. # noqa: E501
Returns
The require_all_metadata of this Zip. # noqa: E501
required
Gets the required of this Zip. # noqa: E501
When set to true, the signer is required to fill out this tab # noqa: E501
Returns
The required of this Zip. # noqa: E501
required_metadata
Gets the required_metadata of this Zip. # noqa: E501
Metadata that indicates whether the required property is editable. # noqa: E501
Returns
The required_metadata of this Zip. # noqa: E501
sender_required
Gets the sender_required of this Zip. # noqa: E501
When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a senderRequired value of true cannot be deleted from an envelope. # noqa: E501
Returns
The sender_required of this Zip. # noqa: E501
sender_required_metadata
Gets the sender_required_metadata of this Zip. # noqa: E501
Metadata that indicates whether the senderRequired property is editable. # noqa: E501
Returns
The sender_required_metadata of this Zip. # noqa: E501
smart_contract_information
Gets the smart_contract_information of this Zip. # noqa: E501
Reserved for DocuSign. # noqa: E501
Returns
The smart_contract_information of this Zip. # noqa: E501
source
Gets the source of this Zip. # noqa: E501
# noqa: E501
Returns
The source of this Zip. # noqa: E501
status
Gets the status of this Zip. # 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 Zip. # noqa: E501
status_metadata
Gets the status_metadata of this Zip. # noqa: E501
Metadata that indicates whether the status property is editable. # noqa: E501
Returns
The status_metadata of this Zip. # noqa: E501
tab_fully_qualified_path
Gets the tab_fully_qualified_path of this Zip. # noqa: E501
# noqa: E501
Returns
The tab_fully_qualified_path of this Zip. # noqa: E501
tab_group_labels
Gets the tab_group_labels of this Zip. # noqa: E501
# noqa: E501
Returns
The tab_group_labels of this Zip. # noqa: E501
tab_group_labels_metadata
Gets the tab_group_labels_metadata of this Zip. # noqa: E501
Metadata that indicates whether the tabGroupLabels property is editable. # noqa: E501
Returns
The tab_group_labels_metadata of this Zip. # noqa: E501
tab_id
Gets the tab_id of this Zip. # 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 Zip. # noqa: E501
tab_id_metadata
Gets the tab_id_metadata of this Zip. # noqa: E501
Metadata that indicates whether the tabId property is editable. # noqa: E501
Returns
The tab_id_metadata of this Zip. # noqa: E501
tab_label
Gets the tab_label of this Zip. # noqa: E501
The label string associated with the tab. # noqa: E501
Returns
The tab_label of this Zip. # noqa: E501
tab_label_metadata
Gets the tab_label_metadata of this Zip. # noqa: E501
Metadata that indicates whether the tabLabel property is editable. # noqa: E501
Returns
The tab_label_metadata of this Zip. # noqa: E501
tab_order
Gets the tab_order of this Zip. # noqa: E501
# noqa: E501
Returns
The tab_order of this Zip. # noqa: E501
tab_order_metadata
Gets the tab_order_metadata of this Zip. # noqa: E501
Metadata that indicates whether the tabOrder property is editable. # noqa: E501
Returns
The tab_order_metadata of this Zip. # noqa: E501
tab_type
Gets the tab_type of this Zip. # noqa: E501
# noqa: E501
Returns
The tab_type of this Zip. # noqa: E501
tab_type_metadata
Gets the tab_type_metadata of this Zip. # noqa: E501
Metadata that indicates whether the tabType property is editable. # noqa: E501
Returns
The tab_type_metadata of this Zip. # noqa: E501
template_locked
Gets the template_locked of this Zip. # 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 Zip. # noqa: E501
template_locked_metadata
Gets the template_locked_metadata of this Zip. # noqa: E501
Metadata that indicates whether the templateLocked property is editable. # noqa: E501
Returns
The template_locked_metadata of this Zip. # noqa: E501
template_required
Gets the template_required of this Zip. # 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 Zip. # noqa: E501
template_required_metadata
Gets the template_required_metadata of this Zip. # noqa: E501
Metadata that indicates whether the templateRequired property is editable. # noqa: E501
Returns
The template_required_metadata of this Zip. # noqa: E501
tooltip
Gets the tooltip of this Zip. # noqa: E501
# noqa: E501
Returns
The tooltip of this Zip. # noqa: E501
tool_tip_metadata
Gets the tool_tip_metadata of this Zip. # noqa: E501
Metadata that indicates whether the toolTip property is editable. # noqa: E501
Returns
The tool_tip_metadata of this Zip. # noqa: E501
underline
Gets the underline of this Zip. # noqa: E501
When set to true, the information in the tab is underlined. # noqa: E501
Returns
The underline of this Zip. # noqa: E501
underline_metadata
Gets the underline_metadata of this Zip. # noqa: E501
Metadata that indicates whether the underline property is editable. # noqa: E501
Returns
The underline_metadata of this Zip. # noqa: E501
use_dash4
Gets the use_dash4 of this Zip. # noqa: E501
# noqa: E501
Returns
The use_dash4 of this Zip. # noqa: E501
use_dash4_metadata
Gets the use_dash4_metadata of this Zip. # noqa: E501
Metadata that indicates whether the useDash4 property is editable. # noqa: E501
Returns
The use_dash4_metadata of this Zip. # noqa: E501
validation_message
Gets the validation_message of this Zip. # noqa: E501
The message displayed if the custom tab fails input validation (either custom of embedded). # noqa: E501
Returns
The validation_message of this Zip. # noqa: E501
validation_message_metadata
Gets the validation_message_metadata of this Zip. # noqa: E501
Metadata that indicates whether the validationMessage property is editable. # noqa: E501
Returns
The validation_message_metadata of this Zip. # noqa: E501
validation_pattern
Gets the validation_pattern of this Zip. # noqa: E501
A regular expression used to validate input for the tab. # noqa: E501
Returns
The validation_pattern of this Zip. # noqa: E501
validation_pattern_metadata
Gets the validation_pattern_metadata of this Zip. # noqa: E501
Metadata that indicates whether the validationPattern property is editable. # noqa: E501
Returns
The validation_pattern_metadata of this Zip. # noqa: E501
value
Gets the value of this Zip. # noqa: E501
Specifies the value of the tab. # noqa: E501
Returns
The value of this Zip. # noqa: E501
value_metadata
Gets the value_metadata of this Zip. # noqa: E501
Metadata that indicates whether the value property is editable. # noqa: E501
Returns
The value_metadata of this Zip. # noqa: E501
warning_details
Gets the warning_details of this Zip. # noqa: E501
# noqa: E501
Returns
The warning_details of this Zip. # noqa: E501
width
Gets the width of this Zip. # noqa: E501
Width of the tab in pixels. # noqa: E501
Returns
The width of this Zip. # noqa: E501
width_metadata
Gets the width_metadata of this Zip. # noqa: E501
Metadata that indicates whether the width property is editable. # noqa: E501
Returns
The width_metadata of this Zip. # noqa: E501
x_position
Gets the x_position of this Zip. # 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 Zip. # noqa: E501
x_position_metadata
Gets the x_position_metadata of this Zip. # noqa: E501
Metadata that indicates whether the xPosition property is editable. # noqa: E501
Returns
The x_position_metadata of this Zip. # noqa: E501
y_position
Gets the y_position of this Zip. # 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 Zip. # noqa: E501
y_position_metadata
Gets the y_position_metadata of this Zip. # noqa: E501
Metadata that indicates whether the yPosition property is editable. # noqa: E501
Returns
The y_position_metadata of this Zip. # noqa: E501
def
to_dict(self)
3399 def to_dict(self): 3400 """Returns the model properties as a dict""" 3401 result = {} 3402 3403 for attr, _ in six.iteritems(self.swagger_types): 3404 value = getattr(self, attr) 3405 if isinstance(value, list): 3406 result[attr] = list(map( 3407 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 3408 value 3409 )) 3410 elif hasattr(value, "to_dict"): 3411 result[attr] = value.to_dict() 3412 elif isinstance(value, dict): 3413 result[attr] = dict(map( 3414 lambda item: (item[0], item[1].to_dict()) 3415 if hasattr(item[1], "to_dict") else item, 3416 value.items() 3417 )) 3418 else: 3419 result[attr] = value 3420 if issubclass(Zip, dict): 3421 for key, value in self.items(): 3422 result[key] = value 3423 3424 return result
Returns the model properties as a dict