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