docusign_esign.models.template_tabs
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 TemplateTabs(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 'approve_tabs': 'list[Approve]', 37 'checkbox_tabs': 'list[Checkbox]', 38 'comment_thread_tabs': 'list[CommentThread]', 39 'commission_county_tabs': 'list[CommissionCounty]', 40 'commission_expiration_tabs': 'list[CommissionExpiration]', 41 'commission_number_tabs': 'list[CommissionNumber]', 42 'commission_state_tabs': 'list[CommissionState]', 43 'company_tabs': 'list[Company]', 44 'date_signed_tabs': 'list[DateSigned]', 45 'date_tabs': 'list[Date]', 46 'decline_tabs': 'list[Decline]', 47 'draw_tabs': 'list[Draw]', 48 'email_address_tabs': 'list[EmailAddress]', 49 'email_tabs': 'list[Email]', 50 'envelope_id_tabs': 'list[EnvelopeId]', 51 'first_name_tabs': 'list[FirstName]', 52 'formula_tabs': 'list[FormulaTab]', 53 'full_name_tabs': 'list[FullName]', 54 'initial_here_tabs': 'list[InitialHere]', 55 'last_name_tabs': 'list[LastName]', 56 'list_tabs': 'list[List]', 57 'notarize_tabs': 'list[Notarize]', 58 'notary_seal_tabs': 'list[NotarySeal]', 59 'note_tabs': 'list[Note]', 60 'number_tabs': 'list[Number]', 61 'numerical_tabs': 'list[Numerical]', 62 'phone_number_tabs': 'list[PhoneNumber]', 63 'poly_line_overlay_tabs': 'list[PolyLineOverlay]', 64 'prefill_tabs': 'PrefillTabs', 65 'radio_group_tabs': 'list[RadioGroup]', 66 'signer_attachment_tabs': 'list[SignerAttachment]', 67 'sign_here_tabs': 'list[SignHere]', 68 'smart_section_tabs': 'list[SmartSection]', 69 'ssn_tabs': 'list[Ssn]', 70 'tab_groups': 'list[TabGroup]', 71 'text_tabs': 'list[Text]', 72 'title_tabs': 'list[Title]', 73 'view_tabs': 'list[View]', 74 'zip_tabs': 'list[Zip]' 75 } 76 77 attribute_map = { 78 'approve_tabs': 'approveTabs', 79 'checkbox_tabs': 'checkboxTabs', 80 'comment_thread_tabs': 'commentThreadTabs', 81 'commission_county_tabs': 'commissionCountyTabs', 82 'commission_expiration_tabs': 'commissionExpirationTabs', 83 'commission_number_tabs': 'commissionNumberTabs', 84 'commission_state_tabs': 'commissionStateTabs', 85 'company_tabs': 'companyTabs', 86 'date_signed_tabs': 'dateSignedTabs', 87 'date_tabs': 'dateTabs', 88 'decline_tabs': 'declineTabs', 89 'draw_tabs': 'drawTabs', 90 'email_address_tabs': 'emailAddressTabs', 91 'email_tabs': 'emailTabs', 92 'envelope_id_tabs': 'envelopeIdTabs', 93 'first_name_tabs': 'firstNameTabs', 94 'formula_tabs': 'formulaTabs', 95 'full_name_tabs': 'fullNameTabs', 96 'initial_here_tabs': 'initialHereTabs', 97 'last_name_tabs': 'lastNameTabs', 98 'list_tabs': 'listTabs', 99 'notarize_tabs': 'notarizeTabs', 100 'notary_seal_tabs': 'notarySealTabs', 101 'note_tabs': 'noteTabs', 102 'number_tabs': 'numberTabs', 103 'numerical_tabs': 'numericalTabs', 104 'phone_number_tabs': 'phoneNumberTabs', 105 'poly_line_overlay_tabs': 'polyLineOverlayTabs', 106 'prefill_tabs': 'prefillTabs', 107 'radio_group_tabs': 'radioGroupTabs', 108 'signer_attachment_tabs': 'signerAttachmentTabs', 109 'sign_here_tabs': 'signHereTabs', 110 'smart_section_tabs': 'smartSectionTabs', 111 'ssn_tabs': 'ssnTabs', 112 'tab_groups': 'tabGroups', 113 'text_tabs': 'textTabs', 114 'title_tabs': 'titleTabs', 115 'view_tabs': 'viewTabs', 116 'zip_tabs': 'zipTabs' 117 } 118 119 def __init__(self, _configuration=None, **kwargs): # noqa: E501 120 """TemplateTabs - a model defined in Swagger""" # noqa: E501 121 if _configuration is None: 122 _configuration = Configuration() 123 self._configuration = _configuration 124 125 self._approve_tabs = None 126 self._checkbox_tabs = None 127 self._comment_thread_tabs = None 128 self._commission_county_tabs = None 129 self._commission_expiration_tabs = None 130 self._commission_number_tabs = None 131 self._commission_state_tabs = None 132 self._company_tabs = None 133 self._date_signed_tabs = None 134 self._date_tabs = None 135 self._decline_tabs = None 136 self._draw_tabs = None 137 self._email_address_tabs = None 138 self._email_tabs = None 139 self._envelope_id_tabs = None 140 self._first_name_tabs = None 141 self._formula_tabs = None 142 self._full_name_tabs = None 143 self._initial_here_tabs = None 144 self._last_name_tabs = None 145 self._list_tabs = None 146 self._notarize_tabs = None 147 self._notary_seal_tabs = None 148 self._note_tabs = None 149 self._number_tabs = None 150 self._numerical_tabs = None 151 self._phone_number_tabs = None 152 self._poly_line_overlay_tabs = None 153 self._prefill_tabs = None 154 self._radio_group_tabs = None 155 self._signer_attachment_tabs = None 156 self._sign_here_tabs = None 157 self._smart_section_tabs = None 158 self._ssn_tabs = None 159 self._tab_groups = None 160 self._text_tabs = None 161 self._title_tabs = None 162 self._view_tabs = None 163 self._zip_tabs = None 164 self.discriminator = None 165 166 setattr(self, "_{}".format('approve_tabs'), kwargs.get('approve_tabs', None)) 167 setattr(self, "_{}".format('checkbox_tabs'), kwargs.get('checkbox_tabs', None)) 168 setattr(self, "_{}".format('comment_thread_tabs'), kwargs.get('comment_thread_tabs', None)) 169 setattr(self, "_{}".format('commission_county_tabs'), kwargs.get('commission_county_tabs', None)) 170 setattr(self, "_{}".format('commission_expiration_tabs'), kwargs.get('commission_expiration_tabs', None)) 171 setattr(self, "_{}".format('commission_number_tabs'), kwargs.get('commission_number_tabs', None)) 172 setattr(self, "_{}".format('commission_state_tabs'), kwargs.get('commission_state_tabs', None)) 173 setattr(self, "_{}".format('company_tabs'), kwargs.get('company_tabs', None)) 174 setattr(self, "_{}".format('date_signed_tabs'), kwargs.get('date_signed_tabs', None)) 175 setattr(self, "_{}".format('date_tabs'), kwargs.get('date_tabs', None)) 176 setattr(self, "_{}".format('decline_tabs'), kwargs.get('decline_tabs', None)) 177 setattr(self, "_{}".format('draw_tabs'), kwargs.get('draw_tabs', None)) 178 setattr(self, "_{}".format('email_address_tabs'), kwargs.get('email_address_tabs', None)) 179 setattr(self, "_{}".format('email_tabs'), kwargs.get('email_tabs', None)) 180 setattr(self, "_{}".format('envelope_id_tabs'), kwargs.get('envelope_id_tabs', None)) 181 setattr(self, "_{}".format('first_name_tabs'), kwargs.get('first_name_tabs', None)) 182 setattr(self, "_{}".format('formula_tabs'), kwargs.get('formula_tabs', None)) 183 setattr(self, "_{}".format('full_name_tabs'), kwargs.get('full_name_tabs', None)) 184 setattr(self, "_{}".format('initial_here_tabs'), kwargs.get('initial_here_tabs', None)) 185 setattr(self, "_{}".format('last_name_tabs'), kwargs.get('last_name_tabs', None)) 186 setattr(self, "_{}".format('list_tabs'), kwargs.get('list_tabs', None)) 187 setattr(self, "_{}".format('notarize_tabs'), kwargs.get('notarize_tabs', None)) 188 setattr(self, "_{}".format('notary_seal_tabs'), kwargs.get('notary_seal_tabs', None)) 189 setattr(self, "_{}".format('note_tabs'), kwargs.get('note_tabs', None)) 190 setattr(self, "_{}".format('number_tabs'), kwargs.get('number_tabs', None)) 191 setattr(self, "_{}".format('numerical_tabs'), kwargs.get('numerical_tabs', None)) 192 setattr(self, "_{}".format('phone_number_tabs'), kwargs.get('phone_number_tabs', None)) 193 setattr(self, "_{}".format('poly_line_overlay_tabs'), kwargs.get('poly_line_overlay_tabs', None)) 194 setattr(self, "_{}".format('prefill_tabs'), kwargs.get('prefill_tabs', None)) 195 setattr(self, "_{}".format('radio_group_tabs'), kwargs.get('radio_group_tabs', None)) 196 setattr(self, "_{}".format('signer_attachment_tabs'), kwargs.get('signer_attachment_tabs', None)) 197 setattr(self, "_{}".format('sign_here_tabs'), kwargs.get('sign_here_tabs', None)) 198 setattr(self, "_{}".format('smart_section_tabs'), kwargs.get('smart_section_tabs', None)) 199 setattr(self, "_{}".format('ssn_tabs'), kwargs.get('ssn_tabs', None)) 200 setattr(self, "_{}".format('tab_groups'), kwargs.get('tab_groups', None)) 201 setattr(self, "_{}".format('text_tabs'), kwargs.get('text_tabs', None)) 202 setattr(self, "_{}".format('title_tabs'), kwargs.get('title_tabs', None)) 203 setattr(self, "_{}".format('view_tabs'), kwargs.get('view_tabs', None)) 204 setattr(self, "_{}".format('zip_tabs'), kwargs.get('zip_tabs', None)) 205 206 @property 207 def approve_tabs(self): 208 """Gets the approve_tabs of this TemplateTabs. # noqa: E501 209 210 Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. # noqa: E501 211 212 :return: The approve_tabs of this TemplateTabs. # noqa: E501 213 :rtype: list[Approve] 214 """ 215 return self._approve_tabs 216 217 @approve_tabs.setter 218 def approve_tabs(self, approve_tabs): 219 """Sets the approve_tabs of this TemplateTabs. 220 221 Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. # noqa: E501 222 223 :param approve_tabs: The approve_tabs of this TemplateTabs. # noqa: E501 224 :type: list[Approve] 225 """ 226 227 self._approve_tabs = approve_tabs 228 229 @property 230 def checkbox_tabs(self): 231 """Gets the checkbox_tabs of this TemplateTabs. # noqa: E501 232 233 Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501 234 235 :return: The checkbox_tabs of this TemplateTabs. # noqa: E501 236 :rtype: list[Checkbox] 237 """ 238 return self._checkbox_tabs 239 240 @checkbox_tabs.setter 241 def checkbox_tabs(self, checkbox_tabs): 242 """Sets the checkbox_tabs of this TemplateTabs. 243 244 Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501 245 246 :param checkbox_tabs: The checkbox_tabs of this TemplateTabs. # noqa: E501 247 :type: list[Checkbox] 248 """ 249 250 self._checkbox_tabs = checkbox_tabs 251 252 @property 253 def comment_thread_tabs(self): 254 """Gets the comment_thread_tabs of this TemplateTabs. # noqa: E501 255 256 # noqa: E501 257 258 :return: The comment_thread_tabs of this TemplateTabs. # noqa: E501 259 :rtype: list[CommentThread] 260 """ 261 return self._comment_thread_tabs 262 263 @comment_thread_tabs.setter 264 def comment_thread_tabs(self, comment_thread_tabs): 265 """Sets the comment_thread_tabs of this TemplateTabs. 266 267 # noqa: E501 268 269 :param comment_thread_tabs: The comment_thread_tabs of this TemplateTabs. # noqa: E501 270 :type: list[CommentThread] 271 """ 272 273 self._comment_thread_tabs = comment_thread_tabs 274 275 @property 276 def commission_county_tabs(self): 277 """Gets the commission_county_tabs of this TemplateTabs. # noqa: E501 278 279 # noqa: E501 280 281 :return: The commission_county_tabs of this TemplateTabs. # noqa: E501 282 :rtype: list[CommissionCounty] 283 """ 284 return self._commission_county_tabs 285 286 @commission_county_tabs.setter 287 def commission_county_tabs(self, commission_county_tabs): 288 """Sets the commission_county_tabs of this TemplateTabs. 289 290 # noqa: E501 291 292 :param commission_county_tabs: The commission_county_tabs of this TemplateTabs. # noqa: E501 293 :type: list[CommissionCounty] 294 """ 295 296 self._commission_county_tabs = commission_county_tabs 297 298 @property 299 def commission_expiration_tabs(self): 300 """Gets the commission_expiration_tabs of this TemplateTabs. # noqa: E501 301 302 # noqa: E501 303 304 :return: The commission_expiration_tabs of this TemplateTabs. # noqa: E501 305 :rtype: list[CommissionExpiration] 306 """ 307 return self._commission_expiration_tabs 308 309 @commission_expiration_tabs.setter 310 def commission_expiration_tabs(self, commission_expiration_tabs): 311 """Sets the commission_expiration_tabs of this TemplateTabs. 312 313 # noqa: E501 314 315 :param commission_expiration_tabs: The commission_expiration_tabs of this TemplateTabs. # noqa: E501 316 :type: list[CommissionExpiration] 317 """ 318 319 self._commission_expiration_tabs = commission_expiration_tabs 320 321 @property 322 def commission_number_tabs(self): 323 """Gets the commission_number_tabs of this TemplateTabs. # noqa: E501 324 325 # noqa: E501 326 327 :return: The commission_number_tabs of this TemplateTabs. # noqa: E501 328 :rtype: list[CommissionNumber] 329 """ 330 return self._commission_number_tabs 331 332 @commission_number_tabs.setter 333 def commission_number_tabs(self, commission_number_tabs): 334 """Sets the commission_number_tabs of this TemplateTabs. 335 336 # noqa: E501 337 338 :param commission_number_tabs: The commission_number_tabs of this TemplateTabs. # noqa: E501 339 :type: list[CommissionNumber] 340 """ 341 342 self._commission_number_tabs = commission_number_tabs 343 344 @property 345 def commission_state_tabs(self): 346 """Gets the commission_state_tabs of this TemplateTabs. # noqa: E501 347 348 # noqa: E501 349 350 :return: The commission_state_tabs of this TemplateTabs. # noqa: E501 351 :rtype: list[CommissionState] 352 """ 353 return self._commission_state_tabs 354 355 @commission_state_tabs.setter 356 def commission_state_tabs(self, commission_state_tabs): 357 """Sets the commission_state_tabs of this TemplateTabs. 358 359 # noqa: E501 360 361 :param commission_state_tabs: The commission_state_tabs of this TemplateTabs. # noqa: E501 362 :type: list[CommissionState] 363 """ 364 365 self._commission_state_tabs = commission_state_tabs 366 367 @property 368 def company_tabs(self): 369 """Gets the company_tabs of this TemplateTabs. # noqa: E501 370 371 Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 372 373 :return: The company_tabs of this TemplateTabs. # noqa: E501 374 :rtype: list[Company] 375 """ 376 return self._company_tabs 377 378 @company_tabs.setter 379 def company_tabs(self, company_tabs): 380 """Sets the company_tabs of this TemplateTabs. 381 382 Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 383 384 :param company_tabs: The company_tabs of this TemplateTabs. # noqa: E501 385 :type: list[Company] 386 """ 387 388 self._company_tabs = company_tabs 389 390 @property 391 def date_signed_tabs(self): 392 """Gets the date_signed_tabs of this TemplateTabs. # noqa: E501 393 394 Specifies a tab on the document where the date the document was signed will automatically appear. # noqa: E501 395 396 :return: The date_signed_tabs of this TemplateTabs. # noqa: E501 397 :rtype: list[DateSigned] 398 """ 399 return self._date_signed_tabs 400 401 @date_signed_tabs.setter 402 def date_signed_tabs(self, date_signed_tabs): 403 """Sets the date_signed_tabs of this TemplateTabs. 404 405 Specifies a tab on the document where the date the document was signed will automatically appear. # noqa: E501 406 407 :param date_signed_tabs: The date_signed_tabs of this TemplateTabs. # noqa: E501 408 :type: list[DateSigned] 409 """ 410 411 self._date_signed_tabs = date_signed_tabs 412 413 @property 414 def date_tabs(self): 415 """Gets the date_tabs of this TemplateTabs. # noqa: E501 416 417 Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. # noqa: E501 418 419 :return: The date_tabs of this TemplateTabs. # noqa: E501 420 :rtype: list[Date] 421 """ 422 return self._date_tabs 423 424 @date_tabs.setter 425 def date_tabs(self, date_tabs): 426 """Sets the date_tabs of this TemplateTabs. 427 428 Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. # noqa: E501 429 430 :param date_tabs: The date_tabs of this TemplateTabs. # noqa: E501 431 :type: list[Date] 432 """ 433 434 self._date_tabs = date_tabs 435 436 @property 437 def decline_tabs(self): 438 """Gets the decline_tabs of this TemplateTabs. # noqa: E501 439 440 Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. # noqa: E501 441 442 :return: The decline_tabs of this TemplateTabs. # noqa: E501 443 :rtype: list[Decline] 444 """ 445 return self._decline_tabs 446 447 @decline_tabs.setter 448 def decline_tabs(self, decline_tabs): 449 """Sets the decline_tabs of this TemplateTabs. 450 451 Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. # noqa: E501 452 453 :param decline_tabs: The decline_tabs of this TemplateTabs. # noqa: E501 454 :type: list[Decline] 455 """ 456 457 self._decline_tabs = decline_tabs 458 459 @property 460 def draw_tabs(self): 461 """Gets the draw_tabs of this TemplateTabs. # noqa: E501 462 463 # noqa: E501 464 465 :return: The draw_tabs of this TemplateTabs. # noqa: E501 466 :rtype: list[Draw] 467 """ 468 return self._draw_tabs 469 470 @draw_tabs.setter 471 def draw_tabs(self, draw_tabs): 472 """Sets the draw_tabs of this TemplateTabs. 473 474 # noqa: E501 475 476 :param draw_tabs: The draw_tabs of this TemplateTabs. # noqa: E501 477 :type: list[Draw] 478 """ 479 480 self._draw_tabs = draw_tabs 481 482 @property 483 def email_address_tabs(self): 484 """Gets the email_address_tabs of this TemplateTabs. # noqa: E501 485 486 Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. # noqa: E501 487 488 :return: The email_address_tabs of this TemplateTabs. # noqa: E501 489 :rtype: list[EmailAddress] 490 """ 491 return self._email_address_tabs 492 493 @email_address_tabs.setter 494 def email_address_tabs(self, email_address_tabs): 495 """Sets the email_address_tabs of this TemplateTabs. 496 497 Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. # noqa: E501 498 499 :param email_address_tabs: The email_address_tabs of this TemplateTabs. # noqa: E501 500 :type: list[EmailAddress] 501 """ 502 503 self._email_address_tabs = email_address_tabs 504 505 @property 506 def email_tabs(self): 507 """Gets the email_tabs of this TemplateTabs. # noqa: E501 508 509 Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 510 511 :return: The email_tabs of this TemplateTabs. # noqa: E501 512 :rtype: list[Email] 513 """ 514 return self._email_tabs 515 516 @email_tabs.setter 517 def email_tabs(self, email_tabs): 518 """Sets the email_tabs of this TemplateTabs. 519 520 Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 521 522 :param email_tabs: The email_tabs of this TemplateTabs. # noqa: E501 523 :type: list[Email] 524 """ 525 526 self._email_tabs = email_tabs 527 528 @property 529 def envelope_id_tabs(self): 530 """Gets the envelope_id_tabs of this TemplateTabs. # noqa: E501 531 532 Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. # noqa: E501 533 534 :return: The envelope_id_tabs of this TemplateTabs. # noqa: E501 535 :rtype: list[EnvelopeId] 536 """ 537 return self._envelope_id_tabs 538 539 @envelope_id_tabs.setter 540 def envelope_id_tabs(self, envelope_id_tabs): 541 """Sets the envelope_id_tabs of this TemplateTabs. 542 543 Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. # noqa: E501 544 545 :param envelope_id_tabs: The envelope_id_tabs of this TemplateTabs. # noqa: E501 546 :type: list[EnvelopeId] 547 """ 548 549 self._envelope_id_tabs = envelope_id_tabs 550 551 @property 552 def first_name_tabs(self): 553 """Gets the first_name_tabs of this TemplateTabs. # noqa: E501 554 555 Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. # noqa: E501 556 557 :return: The first_name_tabs of this TemplateTabs. # noqa: E501 558 :rtype: list[FirstName] 559 """ 560 return self._first_name_tabs 561 562 @first_name_tabs.setter 563 def first_name_tabs(self, first_name_tabs): 564 """Sets the first_name_tabs of this TemplateTabs. 565 566 Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. # noqa: E501 567 568 :param first_name_tabs: The first_name_tabs of this TemplateTabs. # noqa: E501 569 :type: list[FirstName] 570 """ 571 572 self._first_name_tabs = first_name_tabs 573 574 @property 575 def formula_tabs(self): 576 """Gets the formula_tabs of this TemplateTabs. # noqa: E501 577 578 Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. # noqa: E501 579 580 :return: The formula_tabs of this TemplateTabs. # noqa: E501 581 :rtype: list[FormulaTab] 582 """ 583 return self._formula_tabs 584 585 @formula_tabs.setter 586 def formula_tabs(self, formula_tabs): 587 """Sets the formula_tabs of this TemplateTabs. 588 589 Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. # noqa: E501 590 591 :param formula_tabs: The formula_tabs of this TemplateTabs. # noqa: E501 592 :type: list[FormulaTab] 593 """ 594 595 self._formula_tabs = formula_tabs 596 597 @property 598 def full_name_tabs(self): 599 """Gets the full_name_tabs of this TemplateTabs. # noqa: E501 600 601 Specifies a tag on the document where you want the recipient's name to appear. # noqa: E501 602 603 :return: The full_name_tabs of this TemplateTabs. # noqa: E501 604 :rtype: list[FullName] 605 """ 606 return self._full_name_tabs 607 608 @full_name_tabs.setter 609 def full_name_tabs(self, full_name_tabs): 610 """Sets the full_name_tabs of this TemplateTabs. 611 612 Specifies a tag on the document where you want the recipient's name to appear. # noqa: E501 613 614 :param full_name_tabs: The full_name_tabs of this TemplateTabs. # noqa: E501 615 :type: list[FullName] 616 """ 617 618 self._full_name_tabs = full_name_tabs 619 620 @property 621 def initial_here_tabs(self): 622 """Gets the initial_here_tabs of this TemplateTabs. # noqa: E501 623 624 Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. # noqa: E501 625 626 :return: The initial_here_tabs of this TemplateTabs. # noqa: E501 627 :rtype: list[InitialHere] 628 """ 629 return self._initial_here_tabs 630 631 @initial_here_tabs.setter 632 def initial_here_tabs(self, initial_here_tabs): 633 """Sets the initial_here_tabs of this TemplateTabs. 634 635 Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. # noqa: E501 636 637 :param initial_here_tabs: The initial_here_tabs of this TemplateTabs. # noqa: E501 638 :type: list[InitialHere] 639 """ 640 641 self._initial_here_tabs = initial_here_tabs 642 643 @property 644 def last_name_tabs(self): 645 """Gets the last_name_tabs of this TemplateTabs. # noqa: E501 646 647 Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. # noqa: E501 648 649 :return: The last_name_tabs of this TemplateTabs. # noqa: E501 650 :rtype: list[LastName] 651 """ 652 return self._last_name_tabs 653 654 @last_name_tabs.setter 655 def last_name_tabs(self, last_name_tabs): 656 """Sets the last_name_tabs of this TemplateTabs. 657 658 Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. # noqa: E501 659 660 :param last_name_tabs: The last_name_tabs of this TemplateTabs. # noqa: E501 661 :type: list[LastName] 662 """ 663 664 self._last_name_tabs = last_name_tabs 665 666 @property 667 def list_tabs(self): 668 """Gets the list_tabs of this TemplateTabs. # noqa: E501 669 670 Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. # noqa: E501 671 672 :return: The list_tabs of this TemplateTabs. # noqa: E501 673 :rtype: list[List] 674 """ 675 return self._list_tabs 676 677 @list_tabs.setter 678 def list_tabs(self, list_tabs): 679 """Sets the list_tabs of this TemplateTabs. 680 681 Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. # noqa: E501 682 683 :param list_tabs: The list_tabs of this TemplateTabs. # noqa: E501 684 :type: list[List] 685 """ 686 687 self._list_tabs = list_tabs 688 689 @property 690 def notarize_tabs(self): 691 """Gets the notarize_tabs of this TemplateTabs. # noqa: E501 692 693 # noqa: E501 694 695 :return: The notarize_tabs of this TemplateTabs. # noqa: E501 696 :rtype: list[Notarize] 697 """ 698 return self._notarize_tabs 699 700 @notarize_tabs.setter 701 def notarize_tabs(self, notarize_tabs): 702 """Sets the notarize_tabs of this TemplateTabs. 703 704 # noqa: E501 705 706 :param notarize_tabs: The notarize_tabs of this TemplateTabs. # noqa: E501 707 :type: list[Notarize] 708 """ 709 710 self._notarize_tabs = notarize_tabs 711 712 @property 713 def notary_seal_tabs(self): 714 """Gets the notary_seal_tabs of this TemplateTabs. # noqa: E501 715 716 # noqa: E501 717 718 :return: The notary_seal_tabs of this TemplateTabs. # noqa: E501 719 :rtype: list[NotarySeal] 720 """ 721 return self._notary_seal_tabs 722 723 @notary_seal_tabs.setter 724 def notary_seal_tabs(self, notary_seal_tabs): 725 """Sets the notary_seal_tabs of this TemplateTabs. 726 727 # noqa: E501 728 729 :param notary_seal_tabs: The notary_seal_tabs of this TemplateTabs. # noqa: E501 730 :type: list[NotarySeal] 731 """ 732 733 self._notary_seal_tabs = notary_seal_tabs 734 735 @property 736 def note_tabs(self): 737 """Gets the note_tabs of this TemplateTabs. # noqa: E501 738 739 Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. # noqa: E501 740 741 :return: The note_tabs of this TemplateTabs. # noqa: E501 742 :rtype: list[Note] 743 """ 744 return self._note_tabs 745 746 @note_tabs.setter 747 def note_tabs(self, note_tabs): 748 """Sets the note_tabs of this TemplateTabs. 749 750 Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. # noqa: E501 751 752 :param note_tabs: The note_tabs of this TemplateTabs. # noqa: E501 753 :type: list[Note] 754 """ 755 756 self._note_tabs = note_tabs 757 758 @property 759 def number_tabs(self): 760 """Gets the number_tabs of this TemplateTabs. # noqa: E501 761 762 Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 763 764 :return: The number_tabs of this TemplateTabs. # noqa: E501 765 :rtype: list[Number] 766 """ 767 return self._number_tabs 768 769 @number_tabs.setter 770 def number_tabs(self, number_tabs): 771 """Sets the number_tabs of this TemplateTabs. 772 773 Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 774 775 :param number_tabs: The number_tabs of this TemplateTabs. # noqa: E501 776 :type: list[Number] 777 """ 778 779 self._number_tabs = number_tabs 780 781 @property 782 def numerical_tabs(self): 783 """Gets the numerical_tabs of this TemplateTabs. # noqa: E501 784 785 # noqa: E501 786 787 :return: The numerical_tabs of this TemplateTabs. # noqa: E501 788 :rtype: list[Numerical] 789 """ 790 return self._numerical_tabs 791 792 @numerical_tabs.setter 793 def numerical_tabs(self, numerical_tabs): 794 """Sets the numerical_tabs of this TemplateTabs. 795 796 # noqa: E501 797 798 :param numerical_tabs: The numerical_tabs of this TemplateTabs. # noqa: E501 799 :type: list[Numerical] 800 """ 801 802 self._numerical_tabs = numerical_tabs 803 804 @property 805 def phone_number_tabs(self): 806 """Gets the phone_number_tabs of this TemplateTabs. # noqa: E501 807 808 # noqa: E501 809 810 :return: The phone_number_tabs of this TemplateTabs. # noqa: E501 811 :rtype: list[PhoneNumber] 812 """ 813 return self._phone_number_tabs 814 815 @phone_number_tabs.setter 816 def phone_number_tabs(self, phone_number_tabs): 817 """Sets the phone_number_tabs of this TemplateTabs. 818 819 # noqa: E501 820 821 :param phone_number_tabs: The phone_number_tabs of this TemplateTabs. # noqa: E501 822 :type: list[PhoneNumber] 823 """ 824 825 self._phone_number_tabs = phone_number_tabs 826 827 @property 828 def poly_line_overlay_tabs(self): 829 """Gets the poly_line_overlay_tabs of this TemplateTabs. # noqa: E501 830 831 # noqa: E501 832 833 :return: The poly_line_overlay_tabs of this TemplateTabs. # noqa: E501 834 :rtype: list[PolyLineOverlay] 835 """ 836 return self._poly_line_overlay_tabs 837 838 @poly_line_overlay_tabs.setter 839 def poly_line_overlay_tabs(self, poly_line_overlay_tabs): 840 """Sets the poly_line_overlay_tabs of this TemplateTabs. 841 842 # noqa: E501 843 844 :param poly_line_overlay_tabs: The poly_line_overlay_tabs of this TemplateTabs. # noqa: E501 845 :type: list[PolyLineOverlay] 846 """ 847 848 self._poly_line_overlay_tabs = poly_line_overlay_tabs 849 850 @property 851 def prefill_tabs(self): 852 """Gets the prefill_tabs of this TemplateTabs. # noqa: E501 853 854 Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields # noqa: E501 855 856 :return: The prefill_tabs of this TemplateTabs. # noqa: E501 857 :rtype: PrefillTabs 858 """ 859 return self._prefill_tabs 860 861 @prefill_tabs.setter 862 def prefill_tabs(self, prefill_tabs): 863 """Sets the prefill_tabs of this TemplateTabs. 864 865 Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields # noqa: E501 866 867 :param prefill_tabs: The prefill_tabs of this TemplateTabs. # noqa: E501 868 :type: PrefillTabs 869 """ 870 871 self._prefill_tabs = prefill_tabs 872 873 @property 874 def radio_group_tabs(self): 875 """Gets the radio_group_tabs of this TemplateTabs. # noqa: E501 876 877 Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501 878 879 :return: The radio_group_tabs of this TemplateTabs. # noqa: E501 880 :rtype: list[RadioGroup] 881 """ 882 return self._radio_group_tabs 883 884 @radio_group_tabs.setter 885 def radio_group_tabs(self, radio_group_tabs): 886 """Sets the radio_group_tabs of this TemplateTabs. 887 888 Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501 889 890 :param radio_group_tabs: The radio_group_tabs of this TemplateTabs. # noqa: E501 891 :type: list[RadioGroup] 892 """ 893 894 self._radio_group_tabs = radio_group_tabs 895 896 @property 897 def signer_attachment_tabs(self): 898 """Gets the signer_attachment_tabs of this TemplateTabs. # noqa: E501 899 900 Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. # noqa: E501 901 902 :return: The signer_attachment_tabs of this TemplateTabs. # noqa: E501 903 :rtype: list[SignerAttachment] 904 """ 905 return self._signer_attachment_tabs 906 907 @signer_attachment_tabs.setter 908 def signer_attachment_tabs(self, signer_attachment_tabs): 909 """Sets the signer_attachment_tabs of this TemplateTabs. 910 911 Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. # noqa: E501 912 913 :param signer_attachment_tabs: The signer_attachment_tabs of this TemplateTabs. # noqa: E501 914 :type: list[SignerAttachment] 915 """ 916 917 self._signer_attachment_tabs = signer_attachment_tabs 918 919 @property 920 def sign_here_tabs(self): 921 """Gets the sign_here_tabs of this TemplateTabs. # noqa: E501 922 923 A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. # noqa: E501 924 925 :return: The sign_here_tabs of this TemplateTabs. # noqa: E501 926 :rtype: list[SignHere] 927 """ 928 return self._sign_here_tabs 929 930 @sign_here_tabs.setter 931 def sign_here_tabs(self, sign_here_tabs): 932 """Sets the sign_here_tabs of this TemplateTabs. 933 934 A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. # noqa: E501 935 936 :param sign_here_tabs: The sign_here_tabs of this TemplateTabs. # noqa: E501 937 :type: list[SignHere] 938 """ 939 940 self._sign_here_tabs = sign_here_tabs 941 942 @property 943 def smart_section_tabs(self): 944 """Gets the smart_section_tabs of this TemplateTabs. # noqa: E501 945 946 # noqa: E501 947 948 :return: The smart_section_tabs of this TemplateTabs. # noqa: E501 949 :rtype: list[SmartSection] 950 """ 951 return self._smart_section_tabs 952 953 @smart_section_tabs.setter 954 def smart_section_tabs(self, smart_section_tabs): 955 """Sets the smart_section_tabs of this TemplateTabs. 956 957 # noqa: E501 958 959 :param smart_section_tabs: The smart_section_tabs of this TemplateTabs. # noqa: E501 960 :type: list[SmartSection] 961 """ 962 963 self._smart_section_tabs = smart_section_tabs 964 965 @property 966 def ssn_tabs(self): 967 """Gets the ssn_tabs of this TemplateTabs. # noqa: E501 968 969 Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 970 971 :return: The ssn_tabs of this TemplateTabs. # noqa: E501 972 :rtype: list[Ssn] 973 """ 974 return self._ssn_tabs 975 976 @ssn_tabs.setter 977 def ssn_tabs(self, ssn_tabs): 978 """Sets the ssn_tabs of this TemplateTabs. 979 980 Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 981 982 :param ssn_tabs: The ssn_tabs of this TemplateTabs. # noqa: E501 983 :type: list[Ssn] 984 """ 985 986 self._ssn_tabs = ssn_tabs 987 988 @property 989 def tab_groups(self): 990 """Gets the tab_groups of this TemplateTabs. # noqa: E501 991 992 # noqa: E501 993 994 :return: The tab_groups of this TemplateTabs. # noqa: E501 995 :rtype: list[TabGroup] 996 """ 997 return self._tab_groups 998 999 @tab_groups.setter 1000 def tab_groups(self, tab_groups): 1001 """Sets the tab_groups of this TemplateTabs. 1002 1003 # noqa: E501 1004 1005 :param tab_groups: The tab_groups of this TemplateTabs. # noqa: E501 1006 :type: list[TabGroup] 1007 """ 1008 1009 self._tab_groups = tab_groups 1010 1011 @property 1012 def text_tabs(self): 1013 """Gets the text_tabs of this TemplateTabs. # noqa: E501 1014 1015 Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1016 1017 :return: The text_tabs of this TemplateTabs. # noqa: E501 1018 :rtype: list[Text] 1019 """ 1020 return self._text_tabs 1021 1022 @text_tabs.setter 1023 def text_tabs(self, text_tabs): 1024 """Sets the text_tabs of this TemplateTabs. 1025 1026 Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1027 1028 :param text_tabs: The text_tabs of this TemplateTabs. # noqa: E501 1029 :type: list[Text] 1030 """ 1031 1032 self._text_tabs = text_tabs 1033 1034 @property 1035 def title_tabs(self): 1036 """Gets the title_tabs of this TemplateTabs. # noqa: E501 1037 1038 Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1039 1040 :return: The title_tabs of this TemplateTabs. # noqa: E501 1041 :rtype: list[Title] 1042 """ 1043 return self._title_tabs 1044 1045 @title_tabs.setter 1046 def title_tabs(self, title_tabs): 1047 """Sets the title_tabs of this TemplateTabs. 1048 1049 Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1050 1051 :param title_tabs: The title_tabs of this TemplateTabs. # noqa: E501 1052 :type: list[Title] 1053 """ 1054 1055 self._title_tabs = title_tabs 1056 1057 @property 1058 def view_tabs(self): 1059 """Gets the view_tabs of this TemplateTabs. # noqa: E501 1060 1061 # noqa: E501 1062 1063 :return: The view_tabs of this TemplateTabs. # noqa: E501 1064 :rtype: list[View] 1065 """ 1066 return self._view_tabs 1067 1068 @view_tabs.setter 1069 def view_tabs(self, view_tabs): 1070 """Sets the view_tabs of this TemplateTabs. 1071 1072 # noqa: E501 1073 1074 :param view_tabs: The view_tabs of this TemplateTabs. # noqa: E501 1075 :type: list[View] 1076 """ 1077 1078 self._view_tabs = view_tabs 1079 1080 @property 1081 def zip_tabs(self): 1082 """Gets the zip_tabs of this TemplateTabs. # noqa: E501 1083 1084 Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1085 1086 :return: The zip_tabs of this TemplateTabs. # noqa: E501 1087 :rtype: list[Zip] 1088 """ 1089 return self._zip_tabs 1090 1091 @zip_tabs.setter 1092 def zip_tabs(self, zip_tabs): 1093 """Sets the zip_tabs of this TemplateTabs. 1094 1095 Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1096 1097 :param zip_tabs: The zip_tabs of this TemplateTabs. # noqa: E501 1098 :type: list[Zip] 1099 """ 1100 1101 self._zip_tabs = zip_tabs 1102 1103 def to_dict(self): 1104 """Returns the model properties as a dict""" 1105 result = {} 1106 1107 for attr, _ in six.iteritems(self.swagger_types): 1108 value = getattr(self, attr) 1109 if isinstance(value, list): 1110 result[attr] = list(map( 1111 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 1112 value 1113 )) 1114 elif hasattr(value, "to_dict"): 1115 result[attr] = value.to_dict() 1116 elif isinstance(value, dict): 1117 result[attr] = dict(map( 1118 lambda item: (item[0], item[1].to_dict()) 1119 if hasattr(item[1], "to_dict") else item, 1120 value.items() 1121 )) 1122 else: 1123 result[attr] = value 1124 if issubclass(TemplateTabs, dict): 1125 for key, value in self.items(): 1126 result[key] = value 1127 1128 return result 1129 1130 def to_str(self): 1131 """Returns the string representation of the model""" 1132 return pprint.pformat(self.to_dict()) 1133 1134 def __repr__(self): 1135 """For `print` and `pprint`""" 1136 return self.to_str() 1137 1138 def __eq__(self, other): 1139 """Returns true if both objects are equal""" 1140 if not isinstance(other, TemplateTabs): 1141 return False 1142 1143 return self.to_dict() == other.to_dict() 1144 1145 def __ne__(self, other): 1146 """Returns true if both objects are not equal""" 1147 if not isinstance(other, TemplateTabs): 1148 return True 1149 1150 return self.to_dict() != other.to_dict()
23class TemplateTabs(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 'approve_tabs': 'list[Approve]', 38 'checkbox_tabs': 'list[Checkbox]', 39 'comment_thread_tabs': 'list[CommentThread]', 40 'commission_county_tabs': 'list[CommissionCounty]', 41 'commission_expiration_tabs': 'list[CommissionExpiration]', 42 'commission_number_tabs': 'list[CommissionNumber]', 43 'commission_state_tabs': 'list[CommissionState]', 44 'company_tabs': 'list[Company]', 45 'date_signed_tabs': 'list[DateSigned]', 46 'date_tabs': 'list[Date]', 47 'decline_tabs': 'list[Decline]', 48 'draw_tabs': 'list[Draw]', 49 'email_address_tabs': 'list[EmailAddress]', 50 'email_tabs': 'list[Email]', 51 'envelope_id_tabs': 'list[EnvelopeId]', 52 'first_name_tabs': 'list[FirstName]', 53 'formula_tabs': 'list[FormulaTab]', 54 'full_name_tabs': 'list[FullName]', 55 'initial_here_tabs': 'list[InitialHere]', 56 'last_name_tabs': 'list[LastName]', 57 'list_tabs': 'list[List]', 58 'notarize_tabs': 'list[Notarize]', 59 'notary_seal_tabs': 'list[NotarySeal]', 60 'note_tabs': 'list[Note]', 61 'number_tabs': 'list[Number]', 62 'numerical_tabs': 'list[Numerical]', 63 'phone_number_tabs': 'list[PhoneNumber]', 64 'poly_line_overlay_tabs': 'list[PolyLineOverlay]', 65 'prefill_tabs': 'PrefillTabs', 66 'radio_group_tabs': 'list[RadioGroup]', 67 'signer_attachment_tabs': 'list[SignerAttachment]', 68 'sign_here_tabs': 'list[SignHere]', 69 'smart_section_tabs': 'list[SmartSection]', 70 'ssn_tabs': 'list[Ssn]', 71 'tab_groups': 'list[TabGroup]', 72 'text_tabs': 'list[Text]', 73 'title_tabs': 'list[Title]', 74 'view_tabs': 'list[View]', 75 'zip_tabs': 'list[Zip]' 76 } 77 78 attribute_map = { 79 'approve_tabs': 'approveTabs', 80 'checkbox_tabs': 'checkboxTabs', 81 'comment_thread_tabs': 'commentThreadTabs', 82 'commission_county_tabs': 'commissionCountyTabs', 83 'commission_expiration_tabs': 'commissionExpirationTabs', 84 'commission_number_tabs': 'commissionNumberTabs', 85 'commission_state_tabs': 'commissionStateTabs', 86 'company_tabs': 'companyTabs', 87 'date_signed_tabs': 'dateSignedTabs', 88 'date_tabs': 'dateTabs', 89 'decline_tabs': 'declineTabs', 90 'draw_tabs': 'drawTabs', 91 'email_address_tabs': 'emailAddressTabs', 92 'email_tabs': 'emailTabs', 93 'envelope_id_tabs': 'envelopeIdTabs', 94 'first_name_tabs': 'firstNameTabs', 95 'formula_tabs': 'formulaTabs', 96 'full_name_tabs': 'fullNameTabs', 97 'initial_here_tabs': 'initialHereTabs', 98 'last_name_tabs': 'lastNameTabs', 99 'list_tabs': 'listTabs', 100 'notarize_tabs': 'notarizeTabs', 101 'notary_seal_tabs': 'notarySealTabs', 102 'note_tabs': 'noteTabs', 103 'number_tabs': 'numberTabs', 104 'numerical_tabs': 'numericalTabs', 105 'phone_number_tabs': 'phoneNumberTabs', 106 'poly_line_overlay_tabs': 'polyLineOverlayTabs', 107 'prefill_tabs': 'prefillTabs', 108 'radio_group_tabs': 'radioGroupTabs', 109 'signer_attachment_tabs': 'signerAttachmentTabs', 110 'sign_here_tabs': 'signHereTabs', 111 'smart_section_tabs': 'smartSectionTabs', 112 'ssn_tabs': 'ssnTabs', 113 'tab_groups': 'tabGroups', 114 'text_tabs': 'textTabs', 115 'title_tabs': 'titleTabs', 116 'view_tabs': 'viewTabs', 117 'zip_tabs': 'zipTabs' 118 } 119 120 def __init__(self, _configuration=None, **kwargs): # noqa: E501 121 """TemplateTabs - a model defined in Swagger""" # noqa: E501 122 if _configuration is None: 123 _configuration = Configuration() 124 self._configuration = _configuration 125 126 self._approve_tabs = None 127 self._checkbox_tabs = None 128 self._comment_thread_tabs = None 129 self._commission_county_tabs = None 130 self._commission_expiration_tabs = None 131 self._commission_number_tabs = None 132 self._commission_state_tabs = None 133 self._company_tabs = None 134 self._date_signed_tabs = None 135 self._date_tabs = None 136 self._decline_tabs = None 137 self._draw_tabs = None 138 self._email_address_tabs = None 139 self._email_tabs = None 140 self._envelope_id_tabs = None 141 self._first_name_tabs = None 142 self._formula_tabs = None 143 self._full_name_tabs = None 144 self._initial_here_tabs = None 145 self._last_name_tabs = None 146 self._list_tabs = None 147 self._notarize_tabs = None 148 self._notary_seal_tabs = None 149 self._note_tabs = None 150 self._number_tabs = None 151 self._numerical_tabs = None 152 self._phone_number_tabs = None 153 self._poly_line_overlay_tabs = None 154 self._prefill_tabs = None 155 self._radio_group_tabs = None 156 self._signer_attachment_tabs = None 157 self._sign_here_tabs = None 158 self._smart_section_tabs = None 159 self._ssn_tabs = None 160 self._tab_groups = None 161 self._text_tabs = None 162 self._title_tabs = None 163 self._view_tabs = None 164 self._zip_tabs = None 165 self.discriminator = None 166 167 setattr(self, "_{}".format('approve_tabs'), kwargs.get('approve_tabs', None)) 168 setattr(self, "_{}".format('checkbox_tabs'), kwargs.get('checkbox_tabs', None)) 169 setattr(self, "_{}".format('comment_thread_tabs'), kwargs.get('comment_thread_tabs', None)) 170 setattr(self, "_{}".format('commission_county_tabs'), kwargs.get('commission_county_tabs', None)) 171 setattr(self, "_{}".format('commission_expiration_tabs'), kwargs.get('commission_expiration_tabs', None)) 172 setattr(self, "_{}".format('commission_number_tabs'), kwargs.get('commission_number_tabs', None)) 173 setattr(self, "_{}".format('commission_state_tabs'), kwargs.get('commission_state_tabs', None)) 174 setattr(self, "_{}".format('company_tabs'), kwargs.get('company_tabs', None)) 175 setattr(self, "_{}".format('date_signed_tabs'), kwargs.get('date_signed_tabs', None)) 176 setattr(self, "_{}".format('date_tabs'), kwargs.get('date_tabs', None)) 177 setattr(self, "_{}".format('decline_tabs'), kwargs.get('decline_tabs', None)) 178 setattr(self, "_{}".format('draw_tabs'), kwargs.get('draw_tabs', None)) 179 setattr(self, "_{}".format('email_address_tabs'), kwargs.get('email_address_tabs', None)) 180 setattr(self, "_{}".format('email_tabs'), kwargs.get('email_tabs', None)) 181 setattr(self, "_{}".format('envelope_id_tabs'), kwargs.get('envelope_id_tabs', None)) 182 setattr(self, "_{}".format('first_name_tabs'), kwargs.get('first_name_tabs', None)) 183 setattr(self, "_{}".format('formula_tabs'), kwargs.get('formula_tabs', None)) 184 setattr(self, "_{}".format('full_name_tabs'), kwargs.get('full_name_tabs', None)) 185 setattr(self, "_{}".format('initial_here_tabs'), kwargs.get('initial_here_tabs', None)) 186 setattr(self, "_{}".format('last_name_tabs'), kwargs.get('last_name_tabs', None)) 187 setattr(self, "_{}".format('list_tabs'), kwargs.get('list_tabs', None)) 188 setattr(self, "_{}".format('notarize_tabs'), kwargs.get('notarize_tabs', None)) 189 setattr(self, "_{}".format('notary_seal_tabs'), kwargs.get('notary_seal_tabs', None)) 190 setattr(self, "_{}".format('note_tabs'), kwargs.get('note_tabs', None)) 191 setattr(self, "_{}".format('number_tabs'), kwargs.get('number_tabs', None)) 192 setattr(self, "_{}".format('numerical_tabs'), kwargs.get('numerical_tabs', None)) 193 setattr(self, "_{}".format('phone_number_tabs'), kwargs.get('phone_number_tabs', None)) 194 setattr(self, "_{}".format('poly_line_overlay_tabs'), kwargs.get('poly_line_overlay_tabs', None)) 195 setattr(self, "_{}".format('prefill_tabs'), kwargs.get('prefill_tabs', None)) 196 setattr(self, "_{}".format('radio_group_tabs'), kwargs.get('radio_group_tabs', None)) 197 setattr(self, "_{}".format('signer_attachment_tabs'), kwargs.get('signer_attachment_tabs', None)) 198 setattr(self, "_{}".format('sign_here_tabs'), kwargs.get('sign_here_tabs', None)) 199 setattr(self, "_{}".format('smart_section_tabs'), kwargs.get('smart_section_tabs', None)) 200 setattr(self, "_{}".format('ssn_tabs'), kwargs.get('ssn_tabs', None)) 201 setattr(self, "_{}".format('tab_groups'), kwargs.get('tab_groups', None)) 202 setattr(self, "_{}".format('text_tabs'), kwargs.get('text_tabs', None)) 203 setattr(self, "_{}".format('title_tabs'), kwargs.get('title_tabs', None)) 204 setattr(self, "_{}".format('view_tabs'), kwargs.get('view_tabs', None)) 205 setattr(self, "_{}".format('zip_tabs'), kwargs.get('zip_tabs', None)) 206 207 @property 208 def approve_tabs(self): 209 """Gets the approve_tabs of this TemplateTabs. # noqa: E501 210 211 Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. # noqa: E501 212 213 :return: The approve_tabs of this TemplateTabs. # noqa: E501 214 :rtype: list[Approve] 215 """ 216 return self._approve_tabs 217 218 @approve_tabs.setter 219 def approve_tabs(self, approve_tabs): 220 """Sets the approve_tabs of this TemplateTabs. 221 222 Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. # noqa: E501 223 224 :param approve_tabs: The approve_tabs of this TemplateTabs. # noqa: E501 225 :type: list[Approve] 226 """ 227 228 self._approve_tabs = approve_tabs 229 230 @property 231 def checkbox_tabs(self): 232 """Gets the checkbox_tabs of this TemplateTabs. # noqa: E501 233 234 Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501 235 236 :return: The checkbox_tabs of this TemplateTabs. # noqa: E501 237 :rtype: list[Checkbox] 238 """ 239 return self._checkbox_tabs 240 241 @checkbox_tabs.setter 242 def checkbox_tabs(self, checkbox_tabs): 243 """Sets the checkbox_tabs of this TemplateTabs. 244 245 Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501 246 247 :param checkbox_tabs: The checkbox_tabs of this TemplateTabs. # noqa: E501 248 :type: list[Checkbox] 249 """ 250 251 self._checkbox_tabs = checkbox_tabs 252 253 @property 254 def comment_thread_tabs(self): 255 """Gets the comment_thread_tabs of this TemplateTabs. # noqa: E501 256 257 # noqa: E501 258 259 :return: The comment_thread_tabs of this TemplateTabs. # noqa: E501 260 :rtype: list[CommentThread] 261 """ 262 return self._comment_thread_tabs 263 264 @comment_thread_tabs.setter 265 def comment_thread_tabs(self, comment_thread_tabs): 266 """Sets the comment_thread_tabs of this TemplateTabs. 267 268 # noqa: E501 269 270 :param comment_thread_tabs: The comment_thread_tabs of this TemplateTabs. # noqa: E501 271 :type: list[CommentThread] 272 """ 273 274 self._comment_thread_tabs = comment_thread_tabs 275 276 @property 277 def commission_county_tabs(self): 278 """Gets the commission_county_tabs of this TemplateTabs. # noqa: E501 279 280 # noqa: E501 281 282 :return: The commission_county_tabs of this TemplateTabs. # noqa: E501 283 :rtype: list[CommissionCounty] 284 """ 285 return self._commission_county_tabs 286 287 @commission_county_tabs.setter 288 def commission_county_tabs(self, commission_county_tabs): 289 """Sets the commission_county_tabs of this TemplateTabs. 290 291 # noqa: E501 292 293 :param commission_county_tabs: The commission_county_tabs of this TemplateTabs. # noqa: E501 294 :type: list[CommissionCounty] 295 """ 296 297 self._commission_county_tabs = commission_county_tabs 298 299 @property 300 def commission_expiration_tabs(self): 301 """Gets the commission_expiration_tabs of this TemplateTabs. # noqa: E501 302 303 # noqa: E501 304 305 :return: The commission_expiration_tabs of this TemplateTabs. # noqa: E501 306 :rtype: list[CommissionExpiration] 307 """ 308 return self._commission_expiration_tabs 309 310 @commission_expiration_tabs.setter 311 def commission_expiration_tabs(self, commission_expiration_tabs): 312 """Sets the commission_expiration_tabs of this TemplateTabs. 313 314 # noqa: E501 315 316 :param commission_expiration_tabs: The commission_expiration_tabs of this TemplateTabs. # noqa: E501 317 :type: list[CommissionExpiration] 318 """ 319 320 self._commission_expiration_tabs = commission_expiration_tabs 321 322 @property 323 def commission_number_tabs(self): 324 """Gets the commission_number_tabs of this TemplateTabs. # noqa: E501 325 326 # noqa: E501 327 328 :return: The commission_number_tabs of this TemplateTabs. # noqa: E501 329 :rtype: list[CommissionNumber] 330 """ 331 return self._commission_number_tabs 332 333 @commission_number_tabs.setter 334 def commission_number_tabs(self, commission_number_tabs): 335 """Sets the commission_number_tabs of this TemplateTabs. 336 337 # noqa: E501 338 339 :param commission_number_tabs: The commission_number_tabs of this TemplateTabs. # noqa: E501 340 :type: list[CommissionNumber] 341 """ 342 343 self._commission_number_tabs = commission_number_tabs 344 345 @property 346 def commission_state_tabs(self): 347 """Gets the commission_state_tabs of this TemplateTabs. # noqa: E501 348 349 # noqa: E501 350 351 :return: The commission_state_tabs of this TemplateTabs. # noqa: E501 352 :rtype: list[CommissionState] 353 """ 354 return self._commission_state_tabs 355 356 @commission_state_tabs.setter 357 def commission_state_tabs(self, commission_state_tabs): 358 """Sets the commission_state_tabs of this TemplateTabs. 359 360 # noqa: E501 361 362 :param commission_state_tabs: The commission_state_tabs of this TemplateTabs. # noqa: E501 363 :type: list[CommissionState] 364 """ 365 366 self._commission_state_tabs = commission_state_tabs 367 368 @property 369 def company_tabs(self): 370 """Gets the company_tabs of this TemplateTabs. # noqa: E501 371 372 Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 373 374 :return: The company_tabs of this TemplateTabs. # noqa: E501 375 :rtype: list[Company] 376 """ 377 return self._company_tabs 378 379 @company_tabs.setter 380 def company_tabs(self, company_tabs): 381 """Sets the company_tabs of this TemplateTabs. 382 383 Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 384 385 :param company_tabs: The company_tabs of this TemplateTabs. # noqa: E501 386 :type: list[Company] 387 """ 388 389 self._company_tabs = company_tabs 390 391 @property 392 def date_signed_tabs(self): 393 """Gets the date_signed_tabs of this TemplateTabs. # noqa: E501 394 395 Specifies a tab on the document where the date the document was signed will automatically appear. # noqa: E501 396 397 :return: The date_signed_tabs of this TemplateTabs. # noqa: E501 398 :rtype: list[DateSigned] 399 """ 400 return self._date_signed_tabs 401 402 @date_signed_tabs.setter 403 def date_signed_tabs(self, date_signed_tabs): 404 """Sets the date_signed_tabs of this TemplateTabs. 405 406 Specifies a tab on the document where the date the document was signed will automatically appear. # noqa: E501 407 408 :param date_signed_tabs: The date_signed_tabs of this TemplateTabs. # noqa: E501 409 :type: list[DateSigned] 410 """ 411 412 self._date_signed_tabs = date_signed_tabs 413 414 @property 415 def date_tabs(self): 416 """Gets the date_tabs of this TemplateTabs. # noqa: E501 417 418 Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. # noqa: E501 419 420 :return: The date_tabs of this TemplateTabs. # noqa: E501 421 :rtype: list[Date] 422 """ 423 return self._date_tabs 424 425 @date_tabs.setter 426 def date_tabs(self, date_tabs): 427 """Sets the date_tabs of this TemplateTabs. 428 429 Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. # noqa: E501 430 431 :param date_tabs: The date_tabs of this TemplateTabs. # noqa: E501 432 :type: list[Date] 433 """ 434 435 self._date_tabs = date_tabs 436 437 @property 438 def decline_tabs(self): 439 """Gets the decline_tabs of this TemplateTabs. # noqa: E501 440 441 Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. # noqa: E501 442 443 :return: The decline_tabs of this TemplateTabs. # noqa: E501 444 :rtype: list[Decline] 445 """ 446 return self._decline_tabs 447 448 @decline_tabs.setter 449 def decline_tabs(self, decline_tabs): 450 """Sets the decline_tabs of this TemplateTabs. 451 452 Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. # noqa: E501 453 454 :param decline_tabs: The decline_tabs of this TemplateTabs. # noqa: E501 455 :type: list[Decline] 456 """ 457 458 self._decline_tabs = decline_tabs 459 460 @property 461 def draw_tabs(self): 462 """Gets the draw_tabs of this TemplateTabs. # noqa: E501 463 464 # noqa: E501 465 466 :return: The draw_tabs of this TemplateTabs. # noqa: E501 467 :rtype: list[Draw] 468 """ 469 return self._draw_tabs 470 471 @draw_tabs.setter 472 def draw_tabs(self, draw_tabs): 473 """Sets the draw_tabs of this TemplateTabs. 474 475 # noqa: E501 476 477 :param draw_tabs: The draw_tabs of this TemplateTabs. # noqa: E501 478 :type: list[Draw] 479 """ 480 481 self._draw_tabs = draw_tabs 482 483 @property 484 def email_address_tabs(self): 485 """Gets the email_address_tabs of this TemplateTabs. # noqa: E501 486 487 Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. # noqa: E501 488 489 :return: The email_address_tabs of this TemplateTabs. # noqa: E501 490 :rtype: list[EmailAddress] 491 """ 492 return self._email_address_tabs 493 494 @email_address_tabs.setter 495 def email_address_tabs(self, email_address_tabs): 496 """Sets the email_address_tabs of this TemplateTabs. 497 498 Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. # noqa: E501 499 500 :param email_address_tabs: The email_address_tabs of this TemplateTabs. # noqa: E501 501 :type: list[EmailAddress] 502 """ 503 504 self._email_address_tabs = email_address_tabs 505 506 @property 507 def email_tabs(self): 508 """Gets the email_tabs of this TemplateTabs. # noqa: E501 509 510 Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 511 512 :return: The email_tabs of this TemplateTabs. # noqa: E501 513 :rtype: list[Email] 514 """ 515 return self._email_tabs 516 517 @email_tabs.setter 518 def email_tabs(self, email_tabs): 519 """Sets the email_tabs of this TemplateTabs. 520 521 Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 522 523 :param email_tabs: The email_tabs of this TemplateTabs. # noqa: E501 524 :type: list[Email] 525 """ 526 527 self._email_tabs = email_tabs 528 529 @property 530 def envelope_id_tabs(self): 531 """Gets the envelope_id_tabs of this TemplateTabs. # noqa: E501 532 533 Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. # noqa: E501 534 535 :return: The envelope_id_tabs of this TemplateTabs. # noqa: E501 536 :rtype: list[EnvelopeId] 537 """ 538 return self._envelope_id_tabs 539 540 @envelope_id_tabs.setter 541 def envelope_id_tabs(self, envelope_id_tabs): 542 """Sets the envelope_id_tabs of this TemplateTabs. 543 544 Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. # noqa: E501 545 546 :param envelope_id_tabs: The envelope_id_tabs of this TemplateTabs. # noqa: E501 547 :type: list[EnvelopeId] 548 """ 549 550 self._envelope_id_tabs = envelope_id_tabs 551 552 @property 553 def first_name_tabs(self): 554 """Gets the first_name_tabs of this TemplateTabs. # noqa: E501 555 556 Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. # noqa: E501 557 558 :return: The first_name_tabs of this TemplateTabs. # noqa: E501 559 :rtype: list[FirstName] 560 """ 561 return self._first_name_tabs 562 563 @first_name_tabs.setter 564 def first_name_tabs(self, first_name_tabs): 565 """Sets the first_name_tabs of this TemplateTabs. 566 567 Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. # noqa: E501 568 569 :param first_name_tabs: The first_name_tabs of this TemplateTabs. # noqa: E501 570 :type: list[FirstName] 571 """ 572 573 self._first_name_tabs = first_name_tabs 574 575 @property 576 def formula_tabs(self): 577 """Gets the formula_tabs of this TemplateTabs. # noqa: E501 578 579 Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. # noqa: E501 580 581 :return: The formula_tabs of this TemplateTabs. # noqa: E501 582 :rtype: list[FormulaTab] 583 """ 584 return self._formula_tabs 585 586 @formula_tabs.setter 587 def formula_tabs(self, formula_tabs): 588 """Sets the formula_tabs of this TemplateTabs. 589 590 Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the \"formula\" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. # noqa: E501 591 592 :param formula_tabs: The formula_tabs of this TemplateTabs. # noqa: E501 593 :type: list[FormulaTab] 594 """ 595 596 self._formula_tabs = formula_tabs 597 598 @property 599 def full_name_tabs(self): 600 """Gets the full_name_tabs of this TemplateTabs. # noqa: E501 601 602 Specifies a tag on the document where you want the recipient's name to appear. # noqa: E501 603 604 :return: The full_name_tabs of this TemplateTabs. # noqa: E501 605 :rtype: list[FullName] 606 """ 607 return self._full_name_tabs 608 609 @full_name_tabs.setter 610 def full_name_tabs(self, full_name_tabs): 611 """Sets the full_name_tabs of this TemplateTabs. 612 613 Specifies a tag on the document where you want the recipient's name to appear. # noqa: E501 614 615 :param full_name_tabs: The full_name_tabs of this TemplateTabs. # noqa: E501 616 :type: list[FullName] 617 """ 618 619 self._full_name_tabs = full_name_tabs 620 621 @property 622 def initial_here_tabs(self): 623 """Gets the initial_here_tabs of this TemplateTabs. # noqa: E501 624 625 Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. # noqa: E501 626 627 :return: The initial_here_tabs of this TemplateTabs. # noqa: E501 628 :rtype: list[InitialHere] 629 """ 630 return self._initial_here_tabs 631 632 @initial_here_tabs.setter 633 def initial_here_tabs(self, initial_here_tabs): 634 """Sets the initial_here_tabs of this TemplateTabs. 635 636 Specifies a tag location in the document at which a recipient will place their initials. The `optional` parameter specifies whether the initials are required or optional. # noqa: E501 637 638 :param initial_here_tabs: The initial_here_tabs of this TemplateTabs. # noqa: E501 639 :type: list[InitialHere] 640 """ 641 642 self._initial_here_tabs = initial_here_tabs 643 644 @property 645 def last_name_tabs(self): 646 """Gets the last_name_tabs of this TemplateTabs. # noqa: E501 647 648 Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. # noqa: E501 649 650 :return: The last_name_tabs of this TemplateTabs. # noqa: E501 651 :rtype: list[LastName] 652 """ 653 return self._last_name_tabs 654 655 @last_name_tabs.setter 656 def last_name_tabs(self, last_name_tabs): 657 """Sets the last_name_tabs of this TemplateTabs. 658 659 Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. # noqa: E501 660 661 :param last_name_tabs: The last_name_tabs of this TemplateTabs. # noqa: E501 662 :type: list[LastName] 663 """ 664 665 self._last_name_tabs = last_name_tabs 666 667 @property 668 def list_tabs(self): 669 """Gets the list_tabs of this TemplateTabs. # noqa: E501 670 671 Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. # noqa: E501 672 673 :return: The list_tabs of this TemplateTabs. # noqa: E501 674 :rtype: list[List] 675 """ 676 return self._list_tabs 677 678 @list_tabs.setter 679 def list_tabs(self, list_tabs): 680 """Sets the list_tabs of this TemplateTabs. 681 682 Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. # noqa: E501 683 684 :param list_tabs: The list_tabs of this TemplateTabs. # noqa: E501 685 :type: list[List] 686 """ 687 688 self._list_tabs = list_tabs 689 690 @property 691 def notarize_tabs(self): 692 """Gets the notarize_tabs of this TemplateTabs. # noqa: E501 693 694 # noqa: E501 695 696 :return: The notarize_tabs of this TemplateTabs. # noqa: E501 697 :rtype: list[Notarize] 698 """ 699 return self._notarize_tabs 700 701 @notarize_tabs.setter 702 def notarize_tabs(self, notarize_tabs): 703 """Sets the notarize_tabs of this TemplateTabs. 704 705 # noqa: E501 706 707 :param notarize_tabs: The notarize_tabs of this TemplateTabs. # noqa: E501 708 :type: list[Notarize] 709 """ 710 711 self._notarize_tabs = notarize_tabs 712 713 @property 714 def notary_seal_tabs(self): 715 """Gets the notary_seal_tabs of this TemplateTabs. # noqa: E501 716 717 # noqa: E501 718 719 :return: The notary_seal_tabs of this TemplateTabs. # noqa: E501 720 :rtype: list[NotarySeal] 721 """ 722 return self._notary_seal_tabs 723 724 @notary_seal_tabs.setter 725 def notary_seal_tabs(self, notary_seal_tabs): 726 """Sets the notary_seal_tabs of this TemplateTabs. 727 728 # noqa: E501 729 730 :param notary_seal_tabs: The notary_seal_tabs of this TemplateTabs. # noqa: E501 731 :type: list[NotarySeal] 732 """ 733 734 self._notary_seal_tabs = notary_seal_tabs 735 736 @property 737 def note_tabs(self): 738 """Gets the note_tabs of this TemplateTabs. # noqa: E501 739 740 Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. # noqa: E501 741 742 :return: The note_tabs of this TemplateTabs. # noqa: E501 743 :rtype: list[Note] 744 """ 745 return self._note_tabs 746 747 @note_tabs.setter 748 def note_tabs(self, note_tabs): 749 """Sets the note_tabs of this TemplateTabs. 750 751 Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. # noqa: E501 752 753 :param note_tabs: The note_tabs of this TemplateTabs. # noqa: E501 754 :type: list[Note] 755 """ 756 757 self._note_tabs = note_tabs 758 759 @property 760 def number_tabs(self): 761 """Gets the number_tabs of this TemplateTabs. # noqa: E501 762 763 Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 764 765 :return: The number_tabs of this TemplateTabs. # noqa: E501 766 :rtype: list[Number] 767 """ 768 return self._number_tabs 769 770 @number_tabs.setter 771 def number_tabs(self, number_tabs): 772 """Sets the number_tabs of this TemplateTabs. 773 774 Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 775 776 :param number_tabs: The number_tabs of this TemplateTabs. # noqa: E501 777 :type: list[Number] 778 """ 779 780 self._number_tabs = number_tabs 781 782 @property 783 def numerical_tabs(self): 784 """Gets the numerical_tabs of this TemplateTabs. # noqa: E501 785 786 # noqa: E501 787 788 :return: The numerical_tabs of this TemplateTabs. # noqa: E501 789 :rtype: list[Numerical] 790 """ 791 return self._numerical_tabs 792 793 @numerical_tabs.setter 794 def numerical_tabs(self, numerical_tabs): 795 """Sets the numerical_tabs of this TemplateTabs. 796 797 # noqa: E501 798 799 :param numerical_tabs: The numerical_tabs of this TemplateTabs. # noqa: E501 800 :type: list[Numerical] 801 """ 802 803 self._numerical_tabs = numerical_tabs 804 805 @property 806 def phone_number_tabs(self): 807 """Gets the phone_number_tabs of this TemplateTabs. # noqa: E501 808 809 # noqa: E501 810 811 :return: The phone_number_tabs of this TemplateTabs. # noqa: E501 812 :rtype: list[PhoneNumber] 813 """ 814 return self._phone_number_tabs 815 816 @phone_number_tabs.setter 817 def phone_number_tabs(self, phone_number_tabs): 818 """Sets the phone_number_tabs of this TemplateTabs. 819 820 # noqa: E501 821 822 :param phone_number_tabs: The phone_number_tabs of this TemplateTabs. # noqa: E501 823 :type: list[PhoneNumber] 824 """ 825 826 self._phone_number_tabs = phone_number_tabs 827 828 @property 829 def poly_line_overlay_tabs(self): 830 """Gets the poly_line_overlay_tabs of this TemplateTabs. # noqa: E501 831 832 # noqa: E501 833 834 :return: The poly_line_overlay_tabs of this TemplateTabs. # noqa: E501 835 :rtype: list[PolyLineOverlay] 836 """ 837 return self._poly_line_overlay_tabs 838 839 @poly_line_overlay_tabs.setter 840 def poly_line_overlay_tabs(self, poly_line_overlay_tabs): 841 """Sets the poly_line_overlay_tabs of this TemplateTabs. 842 843 # noqa: E501 844 845 :param poly_line_overlay_tabs: The poly_line_overlay_tabs of this TemplateTabs. # noqa: E501 846 :type: list[PolyLineOverlay] 847 """ 848 849 self._poly_line_overlay_tabs = poly_line_overlay_tabs 850 851 @property 852 def prefill_tabs(self): 853 """Gets the prefill_tabs of this TemplateTabs. # noqa: E501 854 855 Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields # noqa: E501 856 857 :return: The prefill_tabs of this TemplateTabs. # noqa: E501 858 :rtype: PrefillTabs 859 """ 860 return self._prefill_tabs 861 862 @prefill_tabs.setter 863 def prefill_tabs(self, prefill_tabs): 864 """Sets the prefill_tabs of this TemplateTabs. 865 866 Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields # noqa: E501 867 868 :param prefill_tabs: The prefill_tabs of this TemplateTabs. # noqa: E501 869 :type: PrefillTabs 870 """ 871 872 self._prefill_tabs = prefill_tabs 873 874 @property 875 def radio_group_tabs(self): 876 """Gets the radio_group_tabs of this TemplateTabs. # noqa: E501 877 878 Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501 879 880 :return: The radio_group_tabs of this TemplateTabs. # noqa: E501 881 :rtype: list[RadioGroup] 882 """ 883 return self._radio_group_tabs 884 885 @radio_group_tabs.setter 886 def radio_group_tabs(self, radio_group_tabs): 887 """Sets the radio_group_tabs of this TemplateTabs. 888 889 Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501 890 891 :param radio_group_tabs: The radio_group_tabs of this TemplateTabs. # noqa: E501 892 :type: list[RadioGroup] 893 """ 894 895 self._radio_group_tabs = radio_group_tabs 896 897 @property 898 def signer_attachment_tabs(self): 899 """Gets the signer_attachment_tabs of this TemplateTabs. # noqa: E501 900 901 Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. # noqa: E501 902 903 :return: The signer_attachment_tabs of this TemplateTabs. # noqa: E501 904 :rtype: list[SignerAttachment] 905 """ 906 return self._signer_attachment_tabs 907 908 @signer_attachment_tabs.setter 909 def signer_attachment_tabs(self, signer_attachment_tabs): 910 """Sets the signer_attachment_tabs of this TemplateTabs. 911 912 Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. # noqa: E501 913 914 :param signer_attachment_tabs: The signer_attachment_tabs of this TemplateTabs. # noqa: E501 915 :type: list[SignerAttachment] 916 """ 917 918 self._signer_attachment_tabs = signer_attachment_tabs 919 920 @property 921 def sign_here_tabs(self): 922 """Gets the sign_here_tabs of this TemplateTabs. # noqa: E501 923 924 A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. # noqa: E501 925 926 :return: The sign_here_tabs of this TemplateTabs. # noqa: E501 927 :rtype: list[SignHere] 928 """ 929 return self._sign_here_tabs 930 931 @sign_here_tabs.setter 932 def sign_here_tabs(self, sign_here_tabs): 933 """Sets the sign_here_tabs of this TemplateTabs. 934 935 A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The \"optional\" parameter sets if the signature is required or optional. # noqa: E501 936 937 :param sign_here_tabs: The sign_here_tabs of this TemplateTabs. # noqa: E501 938 :type: list[SignHere] 939 """ 940 941 self._sign_here_tabs = sign_here_tabs 942 943 @property 944 def smart_section_tabs(self): 945 """Gets the smart_section_tabs of this TemplateTabs. # noqa: E501 946 947 # noqa: E501 948 949 :return: The smart_section_tabs of this TemplateTabs. # noqa: E501 950 :rtype: list[SmartSection] 951 """ 952 return self._smart_section_tabs 953 954 @smart_section_tabs.setter 955 def smart_section_tabs(self, smart_section_tabs): 956 """Sets the smart_section_tabs of this TemplateTabs. 957 958 # noqa: E501 959 960 :param smart_section_tabs: The smart_section_tabs of this TemplateTabs. # noqa: E501 961 :type: list[SmartSection] 962 """ 963 964 self._smart_section_tabs = smart_section_tabs 965 966 @property 967 def ssn_tabs(self): 968 """Gets the ssn_tabs of this TemplateTabs. # noqa: E501 969 970 Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 971 972 :return: The ssn_tabs of this TemplateTabs. # noqa: E501 973 :rtype: list[Ssn] 974 """ 975 return self._ssn_tabs 976 977 @ssn_tabs.setter 978 def ssn_tabs(self, ssn_tabs): 979 """Sets the ssn_tabs of this TemplateTabs. 980 981 Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 982 983 :param ssn_tabs: The ssn_tabs of this TemplateTabs. # noqa: E501 984 :type: list[Ssn] 985 """ 986 987 self._ssn_tabs = ssn_tabs 988 989 @property 990 def tab_groups(self): 991 """Gets the tab_groups of this TemplateTabs. # noqa: E501 992 993 # noqa: E501 994 995 :return: The tab_groups of this TemplateTabs. # noqa: E501 996 :rtype: list[TabGroup] 997 """ 998 return self._tab_groups 999 1000 @tab_groups.setter 1001 def tab_groups(self, tab_groups): 1002 """Sets the tab_groups of this TemplateTabs. 1003 1004 # noqa: E501 1005 1006 :param tab_groups: The tab_groups of this TemplateTabs. # noqa: E501 1007 :type: list[TabGroup] 1008 """ 1009 1010 self._tab_groups = tab_groups 1011 1012 @property 1013 def text_tabs(self): 1014 """Gets the text_tabs of this TemplateTabs. # noqa: E501 1015 1016 Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1017 1018 :return: The text_tabs of this TemplateTabs. # noqa: E501 1019 :rtype: list[Text] 1020 """ 1021 return self._text_tabs 1022 1023 @text_tabs.setter 1024 def text_tabs(self, text_tabs): 1025 """Sets the text_tabs of this TemplateTabs. 1026 1027 Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1028 1029 :param text_tabs: The text_tabs of this TemplateTabs. # noqa: E501 1030 :type: list[Text] 1031 """ 1032 1033 self._text_tabs = text_tabs 1034 1035 @property 1036 def title_tabs(self): 1037 """Gets the title_tabs of this TemplateTabs. # noqa: E501 1038 1039 Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1040 1041 :return: The title_tabs of this TemplateTabs. # noqa: E501 1042 :rtype: list[Title] 1043 """ 1044 return self._title_tabs 1045 1046 @title_tabs.setter 1047 def title_tabs(self, title_tabs): 1048 """Sets the title_tabs of this TemplateTabs. 1049 1050 Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1051 1052 :param title_tabs: The title_tabs of this TemplateTabs. # noqa: E501 1053 :type: list[Title] 1054 """ 1055 1056 self._title_tabs = title_tabs 1057 1058 @property 1059 def view_tabs(self): 1060 """Gets the view_tabs of this TemplateTabs. # noqa: E501 1061 1062 # noqa: E501 1063 1064 :return: The view_tabs of this TemplateTabs. # noqa: E501 1065 :rtype: list[View] 1066 """ 1067 return self._view_tabs 1068 1069 @view_tabs.setter 1070 def view_tabs(self, view_tabs): 1071 """Sets the view_tabs of this TemplateTabs. 1072 1073 # noqa: E501 1074 1075 :param view_tabs: The view_tabs of this TemplateTabs. # noqa: E501 1076 :type: list[View] 1077 """ 1078 1079 self._view_tabs = view_tabs 1080 1081 @property 1082 def zip_tabs(self): 1083 """Gets the zip_tabs of this TemplateTabs. # noqa: E501 1084 1085 Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1086 1087 :return: The zip_tabs of this TemplateTabs. # noqa: E501 1088 :rtype: list[Zip] 1089 """ 1090 return self._zip_tabs 1091 1092 @zip_tabs.setter 1093 def zip_tabs(self, zip_tabs): 1094 """Sets the zip_tabs of this TemplateTabs. 1095 1096 Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501 1097 1098 :param zip_tabs: The zip_tabs of this TemplateTabs. # noqa: E501 1099 :type: list[Zip] 1100 """ 1101 1102 self._zip_tabs = zip_tabs 1103 1104 def to_dict(self): 1105 """Returns the model properties as a dict""" 1106 result = {} 1107 1108 for attr, _ in six.iteritems(self.swagger_types): 1109 value = getattr(self, attr) 1110 if isinstance(value, list): 1111 result[attr] = list(map( 1112 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 1113 value 1114 )) 1115 elif hasattr(value, "to_dict"): 1116 result[attr] = value.to_dict() 1117 elif isinstance(value, dict): 1118 result[attr] = dict(map( 1119 lambda item: (item[0], item[1].to_dict()) 1120 if hasattr(item[1], "to_dict") else item, 1121 value.items() 1122 )) 1123 else: 1124 result[attr] = value 1125 if issubclass(TemplateTabs, dict): 1126 for key, value in self.items(): 1127 result[key] = value 1128 1129 return result 1130 1131 def to_str(self): 1132 """Returns the string representation of the model""" 1133 return pprint.pformat(self.to_dict()) 1134 1135 def __repr__(self): 1136 """For `print` and `pprint`""" 1137 return self.to_str() 1138 1139 def __eq__(self, other): 1140 """Returns true if both objects are equal""" 1141 if not isinstance(other, TemplateTabs): 1142 return False 1143 1144 return self.to_dict() == other.to_dict() 1145 1146 def __ne__(self, other): 1147 """Returns true if both objects are not equal""" 1148 if not isinstance(other, TemplateTabs): 1149 return True 1150 1151 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.
120 def __init__(self, _configuration=None, **kwargs): # noqa: E501 121 """TemplateTabs - a model defined in Swagger""" # noqa: E501 122 if _configuration is None: 123 _configuration = Configuration() 124 self._configuration = _configuration 125 126 self._approve_tabs = None 127 self._checkbox_tabs = None 128 self._comment_thread_tabs = None 129 self._commission_county_tabs = None 130 self._commission_expiration_tabs = None 131 self._commission_number_tabs = None 132 self._commission_state_tabs = None 133 self._company_tabs = None 134 self._date_signed_tabs = None 135 self._date_tabs = None 136 self._decline_tabs = None 137 self._draw_tabs = None 138 self._email_address_tabs = None 139 self._email_tabs = None 140 self._envelope_id_tabs = None 141 self._first_name_tabs = None 142 self._formula_tabs = None 143 self._full_name_tabs = None 144 self._initial_here_tabs = None 145 self._last_name_tabs = None 146 self._list_tabs = None 147 self._notarize_tabs = None 148 self._notary_seal_tabs = None 149 self._note_tabs = None 150 self._number_tabs = None 151 self._numerical_tabs = None 152 self._phone_number_tabs = None 153 self._poly_line_overlay_tabs = None 154 self._prefill_tabs = None 155 self._radio_group_tabs = None 156 self._signer_attachment_tabs = None 157 self._sign_here_tabs = None 158 self._smart_section_tabs = None 159 self._ssn_tabs = None 160 self._tab_groups = None 161 self._text_tabs = None 162 self._title_tabs = None 163 self._view_tabs = None 164 self._zip_tabs = None 165 self.discriminator = None 166 167 setattr(self, "_{}".format('approve_tabs'), kwargs.get('approve_tabs', None)) 168 setattr(self, "_{}".format('checkbox_tabs'), kwargs.get('checkbox_tabs', None)) 169 setattr(self, "_{}".format('comment_thread_tabs'), kwargs.get('comment_thread_tabs', None)) 170 setattr(self, "_{}".format('commission_county_tabs'), kwargs.get('commission_county_tabs', None)) 171 setattr(self, "_{}".format('commission_expiration_tabs'), kwargs.get('commission_expiration_tabs', None)) 172 setattr(self, "_{}".format('commission_number_tabs'), kwargs.get('commission_number_tabs', None)) 173 setattr(self, "_{}".format('commission_state_tabs'), kwargs.get('commission_state_tabs', None)) 174 setattr(self, "_{}".format('company_tabs'), kwargs.get('company_tabs', None)) 175 setattr(self, "_{}".format('date_signed_tabs'), kwargs.get('date_signed_tabs', None)) 176 setattr(self, "_{}".format('date_tabs'), kwargs.get('date_tabs', None)) 177 setattr(self, "_{}".format('decline_tabs'), kwargs.get('decline_tabs', None)) 178 setattr(self, "_{}".format('draw_tabs'), kwargs.get('draw_tabs', None)) 179 setattr(self, "_{}".format('email_address_tabs'), kwargs.get('email_address_tabs', None)) 180 setattr(self, "_{}".format('email_tabs'), kwargs.get('email_tabs', None)) 181 setattr(self, "_{}".format('envelope_id_tabs'), kwargs.get('envelope_id_tabs', None)) 182 setattr(self, "_{}".format('first_name_tabs'), kwargs.get('first_name_tabs', None)) 183 setattr(self, "_{}".format('formula_tabs'), kwargs.get('formula_tabs', None)) 184 setattr(self, "_{}".format('full_name_tabs'), kwargs.get('full_name_tabs', None)) 185 setattr(self, "_{}".format('initial_here_tabs'), kwargs.get('initial_here_tabs', None)) 186 setattr(self, "_{}".format('last_name_tabs'), kwargs.get('last_name_tabs', None)) 187 setattr(self, "_{}".format('list_tabs'), kwargs.get('list_tabs', None)) 188 setattr(self, "_{}".format('notarize_tabs'), kwargs.get('notarize_tabs', None)) 189 setattr(self, "_{}".format('notary_seal_tabs'), kwargs.get('notary_seal_tabs', None)) 190 setattr(self, "_{}".format('note_tabs'), kwargs.get('note_tabs', None)) 191 setattr(self, "_{}".format('number_tabs'), kwargs.get('number_tabs', None)) 192 setattr(self, "_{}".format('numerical_tabs'), kwargs.get('numerical_tabs', None)) 193 setattr(self, "_{}".format('phone_number_tabs'), kwargs.get('phone_number_tabs', None)) 194 setattr(self, "_{}".format('poly_line_overlay_tabs'), kwargs.get('poly_line_overlay_tabs', None)) 195 setattr(self, "_{}".format('prefill_tabs'), kwargs.get('prefill_tabs', None)) 196 setattr(self, "_{}".format('radio_group_tabs'), kwargs.get('radio_group_tabs', None)) 197 setattr(self, "_{}".format('signer_attachment_tabs'), kwargs.get('signer_attachment_tabs', None)) 198 setattr(self, "_{}".format('sign_here_tabs'), kwargs.get('sign_here_tabs', None)) 199 setattr(self, "_{}".format('smart_section_tabs'), kwargs.get('smart_section_tabs', None)) 200 setattr(self, "_{}".format('ssn_tabs'), kwargs.get('ssn_tabs', None)) 201 setattr(self, "_{}".format('tab_groups'), kwargs.get('tab_groups', None)) 202 setattr(self, "_{}".format('text_tabs'), kwargs.get('text_tabs', None)) 203 setattr(self, "_{}".format('title_tabs'), kwargs.get('title_tabs', None)) 204 setattr(self, "_{}".format('view_tabs'), kwargs.get('view_tabs', None)) 205 setattr(self, "_{}".format('zip_tabs'), kwargs.get('zip_tabs', None))
TemplateTabs - a model defined in Swagger
Gets the approve_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history. # noqa: E501
Returns
The approve_tabs of this TemplateTabs. # noqa: E501
Gets the checkbox_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document in a location where the recipient can select an option. # noqa: E501
Returns
The checkbox_tabs of this TemplateTabs. # noqa: E501
Gets the comment_thread_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The comment_thread_tabs of this TemplateTabs. # noqa: E501
Gets the commission_county_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The commission_county_tabs of this TemplateTabs. # noqa: E501
Gets the commission_expiration_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The commission_expiration_tabs of this TemplateTabs. # noqa: E501
Gets the commission_number_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The commission_number_tabs of this TemplateTabs. # noqa: E501
Gets the commission_state_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The commission_state_tabs of this TemplateTabs. # noqa: E501
Gets the company_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The company_tabs of this TemplateTabs. # noqa: E501
Gets the date_signed_tabs of this TemplateTabs. # noqa: E501
Specifies a tab on the document where the date the document was signed will automatically appear. # noqa: E501
Returns
The date_signed_tabs of this TemplateTabs. # noqa: E501
Gets the date_tabs of this TemplateTabs. # noqa: E501
Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format. # noqa: E501
Returns
The date_tabs of this TemplateTabs. # noqa: E501
Gets the decline_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided. # noqa: E501
Returns
The decline_tabs of this TemplateTabs. # noqa: E501
Gets the draw_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The draw_tabs of this TemplateTabs. # noqa: E501
Gets the email_address_tabs of this TemplateTabs. # noqa: E501
Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display. # noqa: E501
Returns
The email_address_tabs of this TemplateTabs. # noqa: E501
Gets the email_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The email_tabs of this TemplateTabs. # noqa: E501
Gets the envelope_id_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only. # noqa: E501
Returns
The envelope_id_tabs of this TemplateTabs. # noqa: E501
Gets the first_name_tabs of this TemplateTabs. # noqa: E501
Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name. # noqa: E501
Returns
The first_name_tabs of this TemplateTabs. # noqa: E501
Gets the formula_tabs of this TemplateTabs. # noqa: E501
Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the "formula" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas. # noqa: E501
Returns
The formula_tabs of this TemplateTabs. # noqa: E501
Gets the full_name_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient's name to appear. # noqa: E501
Returns
The full_name_tabs of this TemplateTabs. # noqa: E501
Gets the initial_here_tabs of this TemplateTabs. # noqa: E501
Specifies a tag location in the document at which a recipient will place their initials. The optional
parameter specifies whether the initials are required or optional. # noqa: E501
Returns
The initial_here_tabs of this TemplateTabs. # noqa: E501
Gets the last_name_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name. # noqa: E501
Returns
The last_name_tabs of this TemplateTabs. # noqa: E501
Gets the list_tabs of this TemplateTabs. # noqa: E501
Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select. # noqa: E501
Returns
The list_tabs of this TemplateTabs. # noqa: E501
Gets the notarize_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The notarize_tabs of this TemplateTabs. # noqa: E501
Gets the notary_seal_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The notary_seal_tabs of this TemplateTabs. # noqa: E501
Gets the note_tabs of this TemplateTabs. # noqa: E501
Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient. # noqa: E501
Returns
The note_tabs of this TemplateTabs. # noqa: E501
Gets the number_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The number_tabs of this TemplateTabs. # noqa: E501
Gets the numerical_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The numerical_tabs of this TemplateTabs. # noqa: E501
Gets the phone_number_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The phone_number_tabs of this TemplateTabs. # noqa: E501
Gets the poly_line_overlay_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The poly_line_overlay_tabs of this TemplateTabs. # noqa: E501
Gets the prefill_tabs of this TemplateTabs. # noqa: E501
Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields # noqa: E501
Returns
The prefill_tabs of this TemplateTabs. # noqa: E501
Gets the radio_group_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document. # noqa: E501
Returns
The radio_group_tabs of this TemplateTabs. # noqa: E501
Gets the signer_attachment_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document when you want the recipient to add supporting documents to an envelope. # noqa: E501
Returns
The signer_attachment_tabs of this TemplateTabs. # noqa: E501
Gets the sign_here_tabs of this TemplateTabs. # noqa: E501
A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The "optional" parameter sets if the signature is required or optional. # noqa: E501
Returns
The sign_here_tabs of this TemplateTabs. # noqa: E501
Gets the smart_section_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The smart_section_tabs of this TemplateTabs. # noqa: E501
Gets the ssn_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The ssn_tabs of this TemplateTabs. # noqa: E501
Gets the tab_groups of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The tab_groups of this TemplateTabs. # noqa: E501
Gets the text_tabs of this TemplateTabs. # noqa: E501
Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The text_tabs of this TemplateTabs. # noqa: E501
Gets the title_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The title_tabs of this TemplateTabs. # noqa: E501
Gets the view_tabs of this TemplateTabs. # noqa: E501
# noqa: E501
Returns
The view_tabs of this TemplateTabs. # noqa: E501
Gets the zip_tabs of this TemplateTabs. # noqa: E501
Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response. # noqa: E501
Returns
The zip_tabs of this TemplateTabs. # noqa: E501
1104 def to_dict(self): 1105 """Returns the model properties as a dict""" 1106 result = {} 1107 1108 for attr, _ in six.iteritems(self.swagger_types): 1109 value = getattr(self, attr) 1110 if isinstance(value, list): 1111 result[attr] = list(map( 1112 lambda x: x.to_dict() if hasattr(x, "to_dict") else x, 1113 value 1114 )) 1115 elif hasattr(value, "to_dict"): 1116 result[attr] = value.to_dict() 1117 elif isinstance(value, dict): 1118 result[attr] = dict(map( 1119 lambda item: (item[0], item[1].to_dict()) 1120 if hasattr(item[1], "to_dict") else item, 1121 value.items() 1122 )) 1123 else: 1124 result[attr] = value 1125 if issubclass(TemplateTabs, dict): 1126 for key, value in self.items(): 1127 result[key] = value 1128 1129 return result
Returns the model properties as a dict