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