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