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