Class: DocuSign_eSign::TabGroup

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/tab_group.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ TabGroup

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {})

    Model attributes in the form of hash


390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
# File 'lib/docusign_esign/models/tab_group.rb', line 390

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'anchorAllowWhiteSpaceInCharacters')
    self.anchor_allow_white_space_in_characters = attributes[:'anchorAllowWhiteSpaceInCharacters']
  end

  if attributes.has_key?(:'anchorAllowWhiteSpaceInCharactersMetadata')
    self. = attributes[:'anchorAllowWhiteSpaceInCharactersMetadata']
  end

  if attributes.has_key?(:'anchorCaseSensitive')
    self.anchor_case_sensitive = attributes[:'anchorCaseSensitive']
  end

  if attributes.has_key?(:'anchorCaseSensitiveMetadata')
    self. = attributes[:'anchorCaseSensitiveMetadata']
  end

  if attributes.has_key?(:'anchorHorizontalAlignment')
    self.anchor_horizontal_alignment = attributes[:'anchorHorizontalAlignment']
  end

  if attributes.has_key?(:'anchorHorizontalAlignmentMetadata')
    self. = attributes[:'anchorHorizontalAlignmentMetadata']
  end

  if attributes.has_key?(:'anchorIgnoreIfNotPresent')
    self.anchor_ignore_if_not_present = attributes[:'anchorIgnoreIfNotPresent']
  end

  if attributes.has_key?(:'anchorIgnoreIfNotPresentMetadata')
    self. = attributes[:'anchorIgnoreIfNotPresentMetadata']
  end

  if attributes.has_key?(:'anchorMatchWholeWord')
    self.anchor_match_whole_word = attributes[:'anchorMatchWholeWord']
  end

  if attributes.has_key?(:'anchorMatchWholeWordMetadata')
    self. = attributes[:'anchorMatchWholeWordMetadata']
  end

  if attributes.has_key?(:'anchorString')
    self.anchor_string = attributes[:'anchorString']
  end

  if attributes.has_key?(:'anchorStringMetadata')
    self. = attributes[:'anchorStringMetadata']
  end

  if attributes.has_key?(:'anchorTabProcessorVersion')
    self.anchor_tab_processor_version = attributes[:'anchorTabProcessorVersion']
  end

  if attributes.has_key?(:'anchorTabProcessorVersionMetadata')
    self. = attributes[:'anchorTabProcessorVersionMetadata']
  end

  if attributes.has_key?(:'anchorUnits')
    self.anchor_units = attributes[:'anchorUnits']
  end

  if attributes.has_key?(:'anchorUnitsMetadata')
    self. = attributes[:'anchorUnitsMetadata']
  end

  if attributes.has_key?(:'anchorXOffset')
    self.anchor_x_offset = attributes[:'anchorXOffset']
  end

  if attributes.has_key?(:'anchorXOffsetMetadata')
    self. = attributes[:'anchorXOffsetMetadata']
  end

  if attributes.has_key?(:'anchorYOffset')
    self.anchor_y_offset = attributes[:'anchorYOffset']
  end

  if attributes.has_key?(:'anchorYOffsetMetadata')
    self. = attributes[:'anchorYOffsetMetadata']
  end

  if attributes.has_key?(:'conditionalParentLabel')
    self.conditional_parent_label = attributes[:'conditionalParentLabel']
  end

  if attributes.has_key?(:'conditionalParentLabelMetadata')
    self. = attributes[:'conditionalParentLabelMetadata']
  end

  if attributes.has_key?(:'conditionalParentValue')
    self.conditional_parent_value = attributes[:'conditionalParentValue']
  end

  if attributes.has_key?(:'conditionalParentValueMetadata')
    self. = attributes[:'conditionalParentValueMetadata']
  end

  if attributes.has_key?(:'customTabId')
    self.custom_tab_id = attributes[:'customTabId']
  end

  if attributes.has_key?(:'customTabIdMetadata')
    self. = attributes[:'customTabIdMetadata']
  end

  if attributes.has_key?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

  if attributes.has_key?(:'documentIdMetadata')
    self. = attributes[:'documentIdMetadata']
  end

  if attributes.has_key?(:'errorDetails')
    self.error_details = attributes[:'errorDetails']
  end

  if attributes.has_key?(:'formOrder')
    self.form_order = attributes[:'formOrder']
  end

  if attributes.has_key?(:'formOrderMetadata')
    self. = attributes[:'formOrderMetadata']
  end

  if attributes.has_key?(:'formPageLabel')
    self.form_page_label = attributes[:'formPageLabel']
  end

  if attributes.has_key?(:'formPageLabelMetadata')
    self. = attributes[:'formPageLabelMetadata']
  end

  if attributes.has_key?(:'formPageNumber')
    self.form_page_number = attributes[:'formPageNumber']
  end

  if attributes.has_key?(:'formPageNumberMetadata')
    self. = attributes[:'formPageNumberMetadata']
  end

  if attributes.has_key?(:'groupLabel')
    self.group_label = attributes[:'groupLabel']
  end

  if attributes.has_key?(:'groupLabelMetadata')
    self. = attributes[:'groupLabelMetadata']
  end

  if attributes.has_key?(:'groupRule')
    self.group_rule = attributes[:'groupRule']
  end

  if attributes.has_key?(:'groupRuleMetadata')
    self. = attributes[:'groupRuleMetadata']
  end

  if attributes.has_key?(:'height')
    self.height = attributes[:'height']
  end

  if attributes.has_key?(:'heightMetadata')
    self. = attributes[:'heightMetadata']
  end

  if attributes.has_key?(:'maximumAllowed')
    self.maximum_allowed = attributes[:'maximumAllowed']
  end

  if attributes.has_key?(:'maximumAllowedMetadata')
    self. = attributes[:'maximumAllowedMetadata']
  end

  if attributes.has_key?(:'mergeField')
    self.merge_field = attributes[:'mergeField']
  end

  if attributes.has_key?(:'mergeFieldXml')
    self.merge_field_xml = attributes[:'mergeFieldXml']
  end

  if attributes.has_key?(:'minimumRequired')
    self.minimum_required = attributes[:'minimumRequired']
  end

  if attributes.has_key?(:'minimumRequiredMetadata')
    self. = attributes[:'minimumRequiredMetadata']
  end

  if attributes.has_key?(:'pageNumber')
    self.page_number = attributes[:'pageNumber']
  end

  if attributes.has_key?(:'pageNumberMetadata')
    self. = attributes[:'pageNumberMetadata']
  end

  if attributes.has_key?(:'recipientId')
    self.recipient_id = attributes[:'recipientId']
  end

  if attributes.has_key?(:'recipientIdGuid')
    self.recipient_id_guid = attributes[:'recipientIdGuid']
  end

  if attributes.has_key?(:'recipientIdGuidMetadata')
    self. = attributes[:'recipientIdGuidMetadata']
  end

  if attributes.has_key?(:'recipientIdMetadata')
    self. = attributes[:'recipientIdMetadata']
  end

  if attributes.has_key?(:'smartContractInformation')
    self.smart_contract_information = attributes[:'smartContractInformation']
  end

  if attributes.has_key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.has_key?(:'statusMetadata')
    self. = attributes[:'statusMetadata']
  end

  if attributes.has_key?(:'tabGroupLabels')
    if (value = attributes[:'tabGroupLabels']).is_a?(Array)
      self.tab_group_labels = value
    end
  end

  if attributes.has_key?(:'tabGroupLabelsMetadata')
    self. = attributes[:'tabGroupLabelsMetadata']
  end

  if attributes.has_key?(:'tabId')
    self.tab_id = attributes[:'tabId']
  end

  if attributes.has_key?(:'tabIdMetadata')
    self. = attributes[:'tabIdMetadata']
  end

  if attributes.has_key?(:'tabOrder')
    self.tab_order = attributes[:'tabOrder']
  end

  if attributes.has_key?(:'tabOrderMetadata')
    self. = attributes[:'tabOrderMetadata']
  end

  if attributes.has_key?(:'tabScope')
    self.tab_scope = attributes[:'tabScope']
  end

  if attributes.has_key?(:'tabScopeMetadata')
    self. = attributes[:'tabScopeMetadata']
  end

  if attributes.has_key?(:'tabType')
    self.tab_type = attributes[:'tabType']
  end

  if attributes.has_key?(:'tabTypeMetadata')
    self. = attributes[:'tabTypeMetadata']
  end

  if attributes.has_key?(:'templateLocked')
    self.template_locked = attributes[:'templateLocked']
  end

  if attributes.has_key?(:'templateLockedMetadata')
    self. = attributes[:'templateLockedMetadata']
  end

  if attributes.has_key?(:'templateRequired')
    self.template_required = attributes[:'templateRequired']
  end

  if attributes.has_key?(:'templateRequiredMetadata')
    self. = attributes[:'templateRequiredMetadata']
  end

  if attributes.has_key?(:'tooltip')
    self.tooltip = attributes[:'tooltip']
  end

  if attributes.has_key?(:'toolTipMetadata')
    self. = attributes[:'toolTipMetadata']
  end

  if attributes.has_key?(:'validationMessage')
    self.validation_message = attributes[:'validationMessage']
  end

  if attributes.has_key?(:'validationMessageMetadata')
    self. = attributes[:'validationMessageMetadata']
  end

  if attributes.has_key?(:'width')
    self.width = attributes[:'width']
  end

  if attributes.has_key?(:'widthMetadata')
    self. = attributes[:'widthMetadata']
  end

  if attributes.has_key?(:'xPosition')
    self.x_position = attributes[:'xPosition']
  end

  if attributes.has_key?(:'xPositionMetadata')
    self. = attributes[:'xPositionMetadata']
  end

  if attributes.has_key?(:'yPosition')
    self.y_position = attributes[:'yPosition']
  end

  if attributes.has_key?(:'yPositionMetadata')
    self. = attributes[:'yPositionMetadata']
  end
end

Instance Attribute Details

#anchor_allow_white_space_in_charactersObject

Returns the value of attribute anchor_allow_white_space_in_characters


18
19
20
# File 'lib/docusign_esign/models/tab_group.rb', line 18

def anchor_allow_white_space_in_characters
  @anchor_allow_white_space_in_characters
end

#anchor_allow_white_space_in_characters_metadataObject

Returns the value of attribute anchor_allow_white_space_in_characters_metadata


20
21
22
# File 'lib/docusign_esign/models/tab_group.rb', line 20

def 
  @anchor_allow_white_space_in_characters_metadata
end

#anchor_case_sensitiveObject

When set to *true*, the anchor string does not consider case when matching strings in the document. The default value is *true*.


23
24
25
# File 'lib/docusign_esign/models/tab_group.rb', line 23

def anchor_case_sensitive
  @anchor_case_sensitive
end

#anchor_case_sensitive_metadataObject

Returns the value of attribute anchor_case_sensitive_metadata


25
26
27
# File 'lib/docusign_esign/models/tab_group.rb', line 25

def 
  @anchor_case_sensitive_metadata
end

#anchor_horizontal_alignmentObject

Specifies the alignment of anchor tabs with anchor strings. Possible values are *left* or *right*. The default value is *left*.


28
29
30
# File 'lib/docusign_esign/models/tab_group.rb', line 28

def anchor_horizontal_alignment
  @anchor_horizontal_alignment
end

#anchor_horizontal_alignment_metadataObject

Returns the value of attribute anchor_horizontal_alignment_metadata


30
31
32
# File 'lib/docusign_esign/models/tab_group.rb', line 30

def 
  @anchor_horizontal_alignment_metadata
end

#anchor_ignore_if_not_presentObject

When set to *true*, this tab is ignored if anchorString is not found in the document.


33
34
35
# File 'lib/docusign_esign/models/tab_group.rb', line 33

def anchor_ignore_if_not_present
  @anchor_ignore_if_not_present
end

#anchor_ignore_if_not_present_metadataObject

Returns the value of attribute anchor_ignore_if_not_present_metadata


35
36
37
# File 'lib/docusign_esign/models/tab_group.rb', line 35

def 
  @anchor_ignore_if_not_present_metadata
end

#anchor_match_whole_wordObject

When set to *true*, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is *true*.


38
39
40
# File 'lib/docusign_esign/models/tab_group.rb', line 38

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_match_whole_word_metadataObject

Returns the value of attribute anchor_match_whole_word_metadata


40
41
42
# File 'lib/docusign_esign/models/tab_group.rb', line 40

def 
  @anchor_match_whole_word_metadata
end

#anchor_stringObject

Anchor text information for a radio button.


43
44
45
# File 'lib/docusign_esign/models/tab_group.rb', line 43

def anchor_string
  @anchor_string
end

#anchor_string_metadataObject

Returns the value of attribute anchor_string_metadata


45
46
47
# File 'lib/docusign_esign/models/tab_group.rb', line 45

def 
  @anchor_string_metadata
end

#anchor_tab_processor_versionObject

Returns the value of attribute anchor_tab_processor_version


48
49
50
# File 'lib/docusign_esign/models/tab_group.rb', line 48

def anchor_tab_processor_version
  @anchor_tab_processor_version
end

#anchor_tab_processor_version_metadataObject

Returns the value of attribute anchor_tab_processor_version_metadata


50
51
52
# File 'lib/docusign_esign/models/tab_group.rb', line 50

def 
  @anchor_tab_processor_version_metadata
end

#anchor_unitsObject

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.


53
54
55
# File 'lib/docusign_esign/models/tab_group.rb', line 53

def anchor_units
  @anchor_units
end

#anchor_units_metadataObject

Returns the value of attribute anchor_units_metadata


55
56
57
# File 'lib/docusign_esign/models/tab_group.rb', line 55

def 
  @anchor_units_metadata
end

#anchor_x_offsetObject

Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.


58
59
60
# File 'lib/docusign_esign/models/tab_group.rb', line 58

def anchor_x_offset
  @anchor_x_offset
end

#anchor_x_offset_metadataObject

Returns the value of attribute anchor_x_offset_metadata


60
61
62
# File 'lib/docusign_esign/models/tab_group.rb', line 60

def 
  @anchor_x_offset_metadata
end

#anchor_y_offsetObject

Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.


63
64
65
# File 'lib/docusign_esign/models/tab_group.rb', line 63

def anchor_y_offset
  @anchor_y_offset
end

#anchor_y_offset_metadataObject

Returns the value of attribute anchor_y_offset_metadata


65
66
67
# File 'lib/docusign_esign/models/tab_group.rb', line 65

def 
  @anchor_y_offset_metadata
end

#conditional_parent_labelObject

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.


68
69
70
# File 'lib/docusign_esign/models/tab_group.rb', line 68

def conditional_parent_label
  @conditional_parent_label
end

#conditional_parent_label_metadataObject

Returns the value of attribute conditional_parent_label_metadata


70
71
72
# File 'lib/docusign_esign/models/tab_group.rb', line 70

def 
  @conditional_parent_label_metadata
end

#conditional_parent_valueObject

For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.


73
74
75
# File 'lib/docusign_esign/models/tab_group.rb', line 73

def conditional_parent_value
  @conditional_parent_value
end

#conditional_parent_value_metadataObject

Returns the value of attribute conditional_parent_value_metadata


75
76
77
# File 'lib/docusign_esign/models/tab_group.rb', line 75

def 
  @conditional_parent_value_metadata
end

#custom_tab_idObject

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.


78
79
80
# File 'lib/docusign_esign/models/tab_group.rb', line 78

def custom_tab_id
  @custom_tab_id
end

#custom_tab_id_metadataObject

Returns the value of attribute custom_tab_id_metadata


80
81
82
# File 'lib/docusign_esign/models/tab_group.rb', line 80

def 
  @custom_tab_id_metadata
end

#document_idObject

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.


83
84
85
# File 'lib/docusign_esign/models/tab_group.rb', line 83

def document_id
  @document_id
end

#document_id_metadataObject

Returns the value of attribute document_id_metadata


85
86
87
# File 'lib/docusign_esign/models/tab_group.rb', line 85

def 
  @document_id_metadata
end

#error_detailsObject

Returns the value of attribute error_details


87
88
89
# File 'lib/docusign_esign/models/tab_group.rb', line 87

def error_details
  @error_details
end

#form_orderObject

Returns the value of attribute form_order


90
91
92
# File 'lib/docusign_esign/models/tab_group.rb', line 90

def form_order
  @form_order
end

#form_order_metadataObject

Returns the value of attribute form_order_metadata


92
93
94
# File 'lib/docusign_esign/models/tab_group.rb', line 92

def 
  @form_order_metadata
end

#form_page_labelObject

Returns the value of attribute form_page_label


95
96
97
# File 'lib/docusign_esign/models/tab_group.rb', line 95

def form_page_label
  @form_page_label
end

#form_page_label_metadataObject

Returns the value of attribute form_page_label_metadata


97
98
99
# File 'lib/docusign_esign/models/tab_group.rb', line 97

def 
  @form_page_label_metadata
end

#form_page_numberObject

Returns the value of attribute form_page_number


100
101
102
# File 'lib/docusign_esign/models/tab_group.rb', line 100

def form_page_number
  @form_page_number
end

#form_page_number_metadataObject

Returns the value of attribute form_page_number_metadata


102
103
104
# File 'lib/docusign_esign/models/tab_group.rb', line 102

def 
  @form_page_number_metadata
end

#group_labelObject

Returns the value of attribute group_label


105
106
107
# File 'lib/docusign_esign/models/tab_group.rb', line 105

def group_label
  @group_label
end

#group_label_metadataObject

Returns the value of attribute group_label_metadata


107
108
109
# File 'lib/docusign_esign/models/tab_group.rb', line 107

def 
  @group_label_metadata
end

#group_ruleObject

Returns the value of attribute group_rule


110
111
112
# File 'lib/docusign_esign/models/tab_group.rb', line 110

def group_rule
  @group_rule
end

#group_rule_metadataObject

Returns the value of attribute group_rule_metadata


112
113
114
# File 'lib/docusign_esign/models/tab_group.rb', line 112

def 
  @group_rule_metadata
end

#heightObject

Height of the tab in pixels.


115
116
117
# File 'lib/docusign_esign/models/tab_group.rb', line 115

def height
  @height
end

#height_metadataObject

Returns the value of attribute height_metadata


117
118
119
# File 'lib/docusign_esign/models/tab_group.rb', line 117

def 
  @height_metadata
end

#maximum_allowedObject

Returns the value of attribute maximum_allowed


120
121
122
# File 'lib/docusign_esign/models/tab_group.rb', line 120

def maximum_allowed
  @maximum_allowed
end

#maximum_allowed_metadataObject

Returns the value of attribute maximum_allowed_metadata


122
123
124
# File 'lib/docusign_esign/models/tab_group.rb', line 122

def 
  @maximum_allowed_metadata
end

#merge_fieldObject

Returns the value of attribute merge_field


124
125
126
# File 'lib/docusign_esign/models/tab_group.rb', line 124

def merge_field
  @merge_field
end

#merge_field_xmlObject

Returns the value of attribute merge_field_xml


127
128
129
# File 'lib/docusign_esign/models/tab_group.rb', line 127

def merge_field_xml
  @merge_field_xml
end

#minimum_requiredObject

Returns the value of attribute minimum_required


130
131
132
# File 'lib/docusign_esign/models/tab_group.rb', line 130

def minimum_required
  @minimum_required
end

#minimum_required_metadataObject

Returns the value of attribute minimum_required_metadata


132
133
134
# File 'lib/docusign_esign/models/tab_group.rb', line 132

def 
  @minimum_required_metadata
end

#page_numberObject

Specifies the page number on which the tab is located.


135
136
137
# File 'lib/docusign_esign/models/tab_group.rb', line 135

def page_number
  @page_number
end

#page_number_metadataObject

Returns the value of attribute page_number_metadata


137
138
139
# File 'lib/docusign_esign/models/tab_group.rb', line 137

def 
  @page_number_metadata
end

#recipient_idObject

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.


140
141
142
# File 'lib/docusign_esign/models/tab_group.rb', line 140

def recipient_id
  @recipient_id
end

#recipient_id_guidObject

Returns the value of attribute recipient_id_guid


143
144
145
# File 'lib/docusign_esign/models/tab_group.rb', line 143

def recipient_id_guid
  @recipient_id_guid
end

#recipient_id_guid_metadataObject

Returns the value of attribute recipient_id_guid_metadata


145
146
147
# File 'lib/docusign_esign/models/tab_group.rb', line 145

def 
  @recipient_id_guid_metadata
end

#recipient_id_metadataObject

Returns the value of attribute recipient_id_metadata


147
148
149
# File 'lib/docusign_esign/models/tab_group.rb', line 147

def 
  @recipient_id_metadata
end

#smart_contract_informationObject

Returns the value of attribute smart_contract_information


149
150
151
# File 'lib/docusign_esign/models/tab_group.rb', line 149

def smart_contract_information
  @smart_contract_information
end

#statusObject

Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later.


152
153
154
# File 'lib/docusign_esign/models/tab_group.rb', line 152

def status
  @status
end

#status_metadataObject

Returns the value of attribute status_metadata


154
155
156
# File 'lib/docusign_esign/models/tab_group.rb', line 154

def 
  @status_metadata
end

#tab_group_labelsObject

Returns the value of attribute tab_group_labels


157
158
159
# File 'lib/docusign_esign/models/tab_group.rb', line 157

def tab_group_labels
  @tab_group_labels
end

#tab_group_labels_metadataObject

Returns the value of attribute tab_group_labels_metadata


159
160
161
# File 'lib/docusign_esign/models/tab_group.rb', line 159

def 
  @tab_group_labels_metadata
end

#tab_idObject

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].


162
163
164
# File 'lib/docusign_esign/models/tab_group.rb', line 162

def tab_id
  @tab_id
end

#tab_id_metadataObject

Returns the value of attribute tab_id_metadata


164
165
166
# File 'lib/docusign_esign/models/tab_group.rb', line 164

def 
  @tab_id_metadata
end

#tab_orderObject

Returns the value of attribute tab_order


167
168
169
# File 'lib/docusign_esign/models/tab_group.rb', line 167

def tab_order
  @tab_order
end

#tab_order_metadataObject

Returns the value of attribute tab_order_metadata


169
170
171
# File 'lib/docusign_esign/models/tab_group.rb', line 169

def 
  @tab_order_metadata
end

#tab_scopeObject

Returns the value of attribute tab_scope


172
173
174
# File 'lib/docusign_esign/models/tab_group.rb', line 172

def tab_scope
  @tab_scope
end

#tab_scope_metadataObject

Returns the value of attribute tab_scope_metadata


174
175
176
# File 'lib/docusign_esign/models/tab_group.rb', line 174

def 
  @tab_scope_metadata
end

#tab_typeObject

Returns the value of attribute tab_type


177
178
179
# File 'lib/docusign_esign/models/tab_group.rb', line 177

def tab_type
  @tab_type
end

#tab_type_metadataObject

Returns the value of attribute tab_type_metadata


179
180
181
# File 'lib/docusign_esign/models/tab_group.rb', line 179

def 
  @tab_type_metadata
end

#template_lockedObject

When set to *true*, the sender cannot change any attributes of the recipient. Used only when working with template recipients.


182
183
184
# File 'lib/docusign_esign/models/tab_group.rb', line 182

def template_locked
  @template_locked
end

#template_locked_metadataObject

Returns the value of attribute template_locked_metadata


184
185
186
# File 'lib/docusign_esign/models/tab_group.rb', line 184

def 
  @template_locked_metadata
end

#template_requiredObject

When set to *true*, the sender may not remove the recipient. Used only when working with template recipients.


187
188
189
# File 'lib/docusign_esign/models/tab_group.rb', line 187

def template_required
  @template_required
end

#template_required_metadataObject

Returns the value of attribute template_required_metadata


189
190
191
# File 'lib/docusign_esign/models/tab_group.rb', line 189

def 
  @template_required_metadata
end

#tool_tip_metadataObject

Returns the value of attribute tool_tip_metadata


194
195
196
# File 'lib/docusign_esign/models/tab_group.rb', line 194

def 
  @tool_tip_metadata
end

#tooltipObject

Returns the value of attribute tooltip


192
193
194
# File 'lib/docusign_esign/models/tab_group.rb', line 192

def tooltip
  @tooltip
end

#validation_messageObject

The message displayed if the custom tab fails input validation (either custom of embedded).


197
198
199
# File 'lib/docusign_esign/models/tab_group.rb', line 197

def validation_message
  @validation_message
end

#validation_message_metadataObject

Returns the value of attribute validation_message_metadata


199
200
201
# File 'lib/docusign_esign/models/tab_group.rb', line 199

def 
  @validation_message_metadata
end

#widthObject

Width of the tab in pixels.


202
203
204
# File 'lib/docusign_esign/models/tab_group.rb', line 202

def width
  @width
end

#width_metadataObject

Returns the value of attribute width_metadata


204
205
206
# File 'lib/docusign_esign/models/tab_group.rb', line 204

def 
  @width_metadata
end

#x_positionObject

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.


207
208
209
# File 'lib/docusign_esign/models/tab_group.rb', line 207

def x_position
  @x_position
end

#x_position_metadataObject

Returns the value of attribute x_position_metadata


209
210
211
# File 'lib/docusign_esign/models/tab_group.rb', line 209

def 
  @x_position_metadata
end

#y_positionObject

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.


212
213
214
# File 'lib/docusign_esign/models/tab_group.rb', line 212

def y_position
  @y_position
end

#y_position_metadataObject

Returns the value of attribute y_position_metadata


214
215
216
# File 'lib/docusign_esign/models/tab_group.rb', line 214

def 
  @y_position_metadata
end

Class Method Details

.attribute_mapObject

Attribute mapping from ruby-style variable name to JSON key.


217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
# File 'lib/docusign_esign/models/tab_group.rb', line 217

def self.attribute_map
  {
    :'anchor_allow_white_space_in_characters' => :'anchorAllowWhiteSpaceInCharacters',
    :'anchor_allow_white_space_in_characters_metadata' => :'anchorAllowWhiteSpaceInCharactersMetadata',
    :'anchor_case_sensitive' => :'anchorCaseSensitive',
    :'anchor_case_sensitive_metadata' => :'anchorCaseSensitiveMetadata',
    :'anchor_horizontal_alignment' => :'anchorHorizontalAlignment',
    :'anchor_horizontal_alignment_metadata' => :'anchorHorizontalAlignmentMetadata',
    :'anchor_ignore_if_not_present' => :'anchorIgnoreIfNotPresent',
    :'anchor_ignore_if_not_present_metadata' => :'anchorIgnoreIfNotPresentMetadata',
    :'anchor_match_whole_word' => :'anchorMatchWholeWord',
    :'anchor_match_whole_word_metadata' => :'anchorMatchWholeWordMetadata',
    :'anchor_string' => :'anchorString',
    :'anchor_string_metadata' => :'anchorStringMetadata',
    :'anchor_tab_processor_version' => :'anchorTabProcessorVersion',
    :'anchor_tab_processor_version_metadata' => :'anchorTabProcessorVersionMetadata',
    :'anchor_units' => :'anchorUnits',
    :'anchor_units_metadata' => :'anchorUnitsMetadata',
    :'anchor_x_offset' => :'anchorXOffset',
    :'anchor_x_offset_metadata' => :'anchorXOffsetMetadata',
    :'anchor_y_offset' => :'anchorYOffset',
    :'anchor_y_offset_metadata' => :'anchorYOffsetMetadata',
    :'conditional_parent_label' => :'conditionalParentLabel',
    :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
    :'conditional_parent_value' => :'conditionalParentValue',
    :'conditional_parent_value_metadata' => :'conditionalParentValueMetadata',
    :'custom_tab_id' => :'customTabId',
    :'custom_tab_id_metadata' => :'customTabIdMetadata',
    :'document_id' => :'documentId',
    :'document_id_metadata' => :'documentIdMetadata',
    :'error_details' => :'errorDetails',
    :'form_order' => :'formOrder',
    :'form_order_metadata' => :'formOrderMetadata',
    :'form_page_label' => :'formPageLabel',
    :'form_page_label_metadata' => :'formPageLabelMetadata',
    :'form_page_number' => :'formPageNumber',
    :'form_page_number_metadata' => :'formPageNumberMetadata',
    :'group_label' => :'groupLabel',
    :'group_label_metadata' => :'groupLabelMetadata',
    :'group_rule' => :'groupRule',
    :'group_rule_metadata' => :'groupRuleMetadata',
    :'height' => :'height',
    :'height_metadata' => :'heightMetadata',
    :'maximum_allowed' => :'maximumAllowed',
    :'maximum_allowed_metadata' => :'maximumAllowedMetadata',
    :'merge_field' => :'mergeField',
    :'merge_field_xml' => :'mergeFieldXml',
    :'minimum_required' => :'minimumRequired',
    :'minimum_required_metadata' => :'minimumRequiredMetadata',
    :'page_number' => :'pageNumber',
    :'page_number_metadata' => :'pageNumberMetadata',
    :'recipient_id' => :'recipientId',
    :'recipient_id_guid' => :'recipientIdGuid',
    :'recipient_id_guid_metadata' => :'recipientIdGuidMetadata',
    :'recipient_id_metadata' => :'recipientIdMetadata',
    :'smart_contract_information' => :'smartContractInformation',
    :'status' => :'status',
    :'status_metadata' => :'statusMetadata',
    :'tab_group_labels' => :'tabGroupLabels',
    :'tab_group_labels_metadata' => :'tabGroupLabelsMetadata',
    :'tab_id' => :'tabId',
    :'tab_id_metadata' => :'tabIdMetadata',
    :'tab_order' => :'tabOrder',
    :'tab_order_metadata' => :'tabOrderMetadata',
    :'tab_scope' => :'tabScope',
    :'tab_scope_metadata' => :'tabScopeMetadata',
    :'tab_type' => :'tabType',
    :'tab_type_metadata' => :'tabTypeMetadata',
    :'template_locked' => :'templateLocked',
    :'template_locked_metadata' => :'templateLockedMetadata',
    :'template_required' => :'templateRequired',
    :'template_required_metadata' => :'templateRequiredMetadata',
    :'tooltip' => :'tooltip',
    :'tool_tip_metadata' => :'toolTipMetadata',
    :'validation_message' => :'validationMessage',
    :'validation_message_metadata' => :'validationMessageMetadata',
    :'width' => :'width',
    :'width_metadata' => :'widthMetadata',
    :'x_position' => :'xPosition',
    :'x_position_metadata' => :'xPositionMetadata',
    :'y_position' => :'yPosition',
    :'y_position_metadata' => :'yPositionMetadata'
  }
end

.swagger_typesObject

Attribute type mapping.


303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
# File 'lib/docusign_esign/models/tab_group.rb', line 303

def self.swagger_types
  {
    :'anchor_allow_white_space_in_characters' => :'String',
    :'anchor_allow_white_space_in_characters_metadata' => :'PropertyMetadata',
    :'anchor_case_sensitive' => :'String',
    :'anchor_case_sensitive_metadata' => :'PropertyMetadata',
    :'anchor_horizontal_alignment' => :'String',
    :'anchor_horizontal_alignment_metadata' => :'PropertyMetadata',
    :'anchor_ignore_if_not_present' => :'String',
    :'anchor_ignore_if_not_present_metadata' => :'PropertyMetadata',
    :'anchor_match_whole_word' => :'String',
    :'anchor_match_whole_word_metadata' => :'PropertyMetadata',
    :'anchor_string' => :'String',
    :'anchor_string_metadata' => :'PropertyMetadata',
    :'anchor_tab_processor_version' => :'String',
    :'anchor_tab_processor_version_metadata' => :'PropertyMetadata',
    :'anchor_units' => :'String',
    :'anchor_units_metadata' => :'PropertyMetadata',
    :'anchor_x_offset' => :'String',
    :'anchor_x_offset_metadata' => :'PropertyMetadata',
    :'anchor_y_offset' => :'String',
    :'anchor_y_offset_metadata' => :'PropertyMetadata',
    :'conditional_parent_label' => :'String',
    :'conditional_parent_label_metadata' => :'PropertyMetadata',
    :'conditional_parent_value' => :'String',
    :'conditional_parent_value_metadata' => :'PropertyMetadata',
    :'custom_tab_id' => :'String',
    :'custom_tab_id_metadata' => :'PropertyMetadata',
    :'document_id' => :'String',
    :'document_id_metadata' => :'PropertyMetadata',
    :'error_details' => :'ErrorDetails',
    :'form_order' => :'String',
    :'form_order_metadata' => :'PropertyMetadata',
    :'form_page_label' => :'String',
    :'form_page_label_metadata' => :'PropertyMetadata',
    :'form_page_number' => :'String',
    :'form_page_number_metadata' => :'PropertyMetadata',
    :'group_label' => :'String',
    :'group_label_metadata' => :'PropertyMetadata',
    :'group_rule' => :'String',
    :'group_rule_metadata' => :'PropertyMetadata',
    :'height' => :'String',
    :'height_metadata' => :'PropertyMetadata',
    :'maximum_allowed' => :'String',
    :'maximum_allowed_metadata' => :'PropertyMetadata',
    :'merge_field' => :'MergeField',
    :'merge_field_xml' => :'String',
    :'minimum_required' => :'String',
    :'minimum_required_metadata' => :'PropertyMetadata',
    :'page_number' => :'String',
    :'page_number_metadata' => :'PropertyMetadata',
    :'recipient_id' => :'String',
    :'recipient_id_guid' => :'String',
    :'recipient_id_guid_metadata' => :'PropertyMetadata',
    :'recipient_id_metadata' => :'PropertyMetadata',
    :'smart_contract_information' => :'SmartContractInformation',
    :'status' => :'String',
    :'status_metadata' => :'PropertyMetadata',
    :'tab_group_labels' => :'Array<String>',
    :'tab_group_labels_metadata' => :'PropertyMetadata',
    :'tab_id' => :'String',
    :'tab_id_metadata' => :'PropertyMetadata',
    :'tab_order' => :'String',
    :'tab_order_metadata' => :'PropertyMetadata',
    :'tab_scope' => :'String',
    :'tab_scope_metadata' => :'PropertyMetadata',
    :'tab_type' => :'String',
    :'tab_type_metadata' => :'PropertyMetadata',
    :'template_locked' => :'String',
    :'template_locked_metadata' => :'PropertyMetadata',
    :'template_required' => :'String',
    :'template_required_metadata' => :'PropertyMetadata',
    :'tooltip' => :'String',
    :'tool_tip_metadata' => :'PropertyMetadata',
    :'validation_message' => :'String',
    :'validation_message_metadata' => :'PropertyMetadata',
    :'width' => :'String',
    :'width_metadata' => :'PropertyMetadata',
    :'x_position' => :'String',
    :'x_position_metadata' => :'PropertyMetadata',
    :'y_position' => :'String',
    :'y_position_metadata' => :'PropertyMetadata'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
# File 'lib/docusign_esign/models/tab_group.rb', line 734

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      anchor_allow_white_space_in_characters == o.anchor_allow_white_space_in_characters &&
       == o. &&
      anchor_case_sensitive == o.anchor_case_sensitive &&
       == o. &&
      anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
       == o. &&
      anchor_ignore_if_not_present == o.anchor_ignore_if_not_present &&
       == o. &&
      anchor_match_whole_word == o.anchor_match_whole_word &&
       == o. &&
      anchor_string == o.anchor_string &&
       == o. &&
      anchor_tab_processor_version == o.anchor_tab_processor_version &&
       == o. &&
      anchor_units == o.anchor_units &&
       == o. &&
      anchor_x_offset == o.anchor_x_offset &&
       == o. &&
      anchor_y_offset == o.anchor_y_offset &&
       == o. &&
      conditional_parent_label == o.conditional_parent_label &&
       == o. &&
      conditional_parent_value == o.conditional_parent_value &&
       == o. &&
      custom_tab_id == o.custom_tab_id &&
       == o. &&
      document_id == o.document_id &&
       == o. &&
      error_details == o.error_details &&
      form_order == o.form_order &&
       == o. &&
      form_page_label == o.form_page_label &&
       == o. &&
      form_page_number == o.form_page_number &&
       == o. &&
      group_label == o.group_label &&
       == o. &&
      group_rule == o.group_rule &&
       == o. &&
      height == o.height &&
       == o. &&
      maximum_allowed == o.maximum_allowed &&
       == o. &&
      merge_field == o.merge_field &&
      merge_field_xml == o.merge_field_xml &&
      minimum_required == o.minimum_required &&
       == o. &&
      page_number == o.page_number &&
       == o. &&
      recipient_id == o.recipient_id &&
      recipient_id_guid == o.recipient_id_guid &&
       == o. &&
       == o. &&
      smart_contract_information == o.smart_contract_information &&
      status == o.status &&
       == o. &&
      tab_group_labels == o.tab_group_labels &&
       == o. &&
      tab_id == o.tab_id &&
       == o. &&
      tab_order == o.tab_order &&
       == o. &&
      tab_scope == o.tab_scope &&
       == o. &&
      tab_type == o.tab_type &&
       == o. &&
      template_locked == o.template_locked &&
       == o. &&
      template_required == o.template_required &&
       == o. &&
      tooltip == o.tooltip &&
       == o. &&
      validation_message == o.validation_message &&
       == o. &&
      width == o.width &&
       == o. &&
      x_position == o.x_position &&
       == o. &&
      y_position == o.y_position &&
       == o.
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
# File 'lib/docusign_esign/models/tab_group.rb', line 855

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


921
922
923
924
925
926
927
928
929
930
931
932
933
# File 'lib/docusign_esign/models/tab_group.rb', line 921

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
# File 'lib/docusign_esign/models/tab_group.rb', line 834

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

821
822
823
# File 'lib/docusign_esign/models/tab_group.rb', line 821

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


827
828
829
# File 'lib/docusign_esign/models/tab_group.rb', line 827

def hash
  [anchor_allow_white_space_in_characters, , anchor_case_sensitive, , anchor_horizontal_alignment, , anchor_ignore_if_not_present, , anchor_match_whole_word, , anchor_string, , anchor_tab_processor_version, , anchor_units, , anchor_x_offset, , anchor_y_offset, , conditional_parent_label, , conditional_parent_value, , custom_tab_id, , document_id, , error_details, form_order, , form_page_label, , form_page_number, , group_label, , group_rule, , height, , maximum_allowed, , merge_field, merge_field_xml, minimum_required, , page_number, , recipient_id, recipient_id_guid, , , smart_contract_information, status, , tab_group_labels, , tab_id, , tab_order, , tab_scope, , tab_type, , template_locked, , template_required, , tooltip, , validation_message, , width, , x_position, , y_position, ].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons


721
722
723
724
# File 'lib/docusign_esign/models/tab_group.rb', line 721

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


901
902
903
# File 'lib/docusign_esign/models/tab_group.rb', line 901

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


907
908
909
910
911
912
913
914
915
# File 'lib/docusign_esign/models/tab_group.rb', line 907

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


895
896
897
# File 'lib/docusign_esign/models/tab_group.rb', line 895

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


728
729
730
# File 'lib/docusign_esign/models/tab_group.rb', line 728

def valid?
  true
end