Class: DocuSign_eSign::Email

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

Overview

A tab that allows the recipient to enter an email address. This is a one-line field that checks that a valid email address is entered. 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.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Email

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
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
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
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
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
 
# File 'lib/docusign_esign/models/email.rb', line 611

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.anchor_allow_white_space_in_characters_metadata = attributes[:'anchorAllowWhiteSpaceInCharactersMetadata']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'maxLengthMetadata')
    self.max_length_metadata = attributes[:'maxLengthMetadata']
  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?(:'name')
    self.name = attributes[:'name']
  end

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

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

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

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

  if attributes.has_key?(:'pageNumberMetadata')
    self.page_number_metadata = 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.recipient_id_guid_metadata = attributes[:'recipientIdGuidMetadata']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'statusMetadata')
    self.status_metadata = 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.tab_group_labels_metadata = attributes[:'tabGroupLabelsMetadata']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#anchor_allow_white_space_in_characters ⇒ Object

Returns the value of attribute anchor_allow_white_space_in_characters.



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

def anchor_allow_white_space_in_characters
  @anchor_allow_white_space_in_characters
end

#anchor_allow_white_space_in_characters_metadata ⇒ Object

Metadata that indicates whether the ‘anchorAllowWhiteSpaceInCharacters` property is editable.



21
22
23
 
# File 'lib/docusign_esign/models/email.rb', line 21

def anchor_allow_white_space_in_characters_metadata
  @anchor_allow_white_space_in_characters_metadata
end

#anchor_case_sensitive ⇒ Object

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



24
25
26
 
# File 'lib/docusign_esign/models/email.rb', line 24

def anchor_case_sensitive
  @anchor_case_sensitive
end

#anchor_case_sensitive_metadata ⇒ Object

Metadata that indicates whether the ‘anchorCaseSensitive` property is editable.



27
28
29
 
# File 'lib/docusign_esign/models/email.rb', line 27

def anchor_case_sensitive_metadata
  @anchor_case_sensitive_metadata
end

#anchor_horizontal_alignment ⇒ Object

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



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

def anchor_horizontal_alignment
  @anchor_horizontal_alignment
end

#anchor_horizontal_alignment_metadata ⇒ Object

Metadata that indicates whether the ‘anchorHorizontalAlignment` property is editable.



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

def anchor_horizontal_alignment_metadata
  @anchor_horizontal_alignment_metadata
end

#anchor_ignore_if_not_present ⇒ Object

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



36
37
38
 
# File 'lib/docusign_esign/models/email.rb', line 36

def anchor_ignore_if_not_present
  @anchor_ignore_if_not_present
end

#anchor_ignore_if_not_present_metadata ⇒ Object

Metadata that indicates whether the ‘anchorIgnoreIfNotPresent` property is editable.



39
40
41
 
# File 'lib/docusign_esign/models/email.rb', line 39

def anchor_ignore_if_not_present_metadata
  @anchor_ignore_if_not_present_metadata
end

#anchor_match_whole_word ⇒ Object

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.



42
43
44
 
# File 'lib/docusign_esign/models/email.rb', line 42

def anchor_match_whole_word
  @anchor_match_whole_word
end

#anchor_match_whole_word_metadata ⇒ Object

Metadata that indicates whether the ‘anchorMatchWholeWord` property is editable.



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

def anchor_match_whole_word_metadata
  @anchor_match_whole_word_metadata
end

#anchor_string ⇒ Object

Anchor text information for a radio button.



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

def anchor_string
  @anchor_string
end

#anchor_string_metadata ⇒ Object

Metadata that indicates whether the ‘anchorString` property is editable.



51
52
53
 
# File 'lib/docusign_esign/models/email.rb', line 51

def anchor_string_metadata
  @anchor_string_metadata
end

#anchor_tab_processor_version ⇒ Object

Returns the value of attribute anchor_tab_processor_version.



54
55
56
 
# File 'lib/docusign_esign/models/email.rb', line 54

def anchor_tab_processor_version
  @anchor_tab_processor_version
end

#anchor_tab_processor_version_metadata ⇒ Object

Reserved for DocuSign.



57
58
59
 
# File 'lib/docusign_esign/models/email.rb', line 57

def anchor_tab_processor_version_metadata
  @anchor_tab_processor_version_metadata
end

#anchor_units ⇒ Object

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



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

def anchor_units
  @anchor_units
end

#anchor_units_metadata ⇒ Object

Metadata that indicates whether the ‘anchorUnits` property is editable.



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

def anchor_units_metadata
  @anchor_units_metadata
end

#anchor_x_offset ⇒ Object

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



66
67
68
 
# File 'lib/docusign_esign/models/email.rb', line 66

def anchor_x_offset
  @anchor_x_offset
end

#anchor_x_offset_metadata ⇒ Object

Metadata that indicates whether the ‘anchorXOffset` property is editable.



69
70
71
 
# File 'lib/docusign_esign/models/email.rb', line 69

def anchor_x_offset_metadata
  @anchor_x_offset_metadata
end

#anchor_y_offset ⇒ Object

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



72
73
74
 
# File 'lib/docusign_esign/models/email.rb', line 72

def anchor_y_offset
  @anchor_y_offset
end

#anchor_y_offset_metadata ⇒ Object

Metadata that indicates whether the ‘anchorYOffset` property is editable.



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

def anchor_y_offset_metadata
  @anchor_y_offset_metadata
end

#bold ⇒ Object

When set to true, the information in the tab is bold.



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

def bold
  @bold
end

#bold_metadata ⇒ Object

Metadata that indicates whether the ‘bold` property is editable.



81
82
83
 
# File 'lib/docusign_esign/models/email.rb', line 81

def bold_metadata
  @bold_metadata
end

#caption ⇒ Object

Returns the value of attribute caption.



84
85
86
 
# File 'lib/docusign_esign/models/email.rb', line 84

def caption
  @caption
end

#caption_metadata ⇒ Object

Returns the value of attribute caption_metadata.



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

def caption_metadata
  @caption_metadata
end

#conceal_value_on_document ⇒ Object

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.



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

def conceal_value_on_document
  @conceal_value_on_document
end

#conceal_value_on_document_metadata ⇒ Object

Metadata that indicates whether the ‘concealValueOnDocument` property is editable.



93
94
95
 
# File 'lib/docusign_esign/models/email.rb', line 93

def conceal_value_on_document_metadata
  @conceal_value_on_document_metadata
end

#conditional_parent_label ⇒ Object

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



96
97
98
 
# File 'lib/docusign_esign/models/email.rb', line 96

def conditional_parent_label
  @conditional_parent_label
end

#conditional_parent_label_metadata ⇒ Object

Metadata that indicates whether the ‘conditionalParentLabel` property is editable.



99
100
101
 
# File 'lib/docusign_esign/models/email.rb', line 99

def conditional_parent_label_metadata
  @conditional_parent_label_metadata
end

#conditional_parent_value ⇒ Object

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.



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

def conditional_parent_value
  @conditional_parent_value
end

#conditional_parent_value_metadata ⇒ Object

Metadata that indicates whether the ‘conditionalParentValue` property is editable.



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

def conditional_parent_value_metadata
  @conditional_parent_value_metadata
end

#custom_tab_id ⇒ Object

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.



108
109
110
 
# File 'lib/docusign_esign/models/email.rb', line 108

def custom_tab_id
  @custom_tab_id
end

#custom_tab_id_metadata ⇒ Object

Metadata that indicates whether the ‘customTabId` property is editable.



111
112
113
 
# File 'lib/docusign_esign/models/email.rb', line 111

def custom_tab_id_metadata
  @custom_tab_id_metadata
end

#disable_auto_size ⇒ Object

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.



114
115
116
 
# File 'lib/docusign_esign/models/email.rb', line 114

def disable_auto_size
  @disable_auto_size
end

#disable_auto_size_metadata ⇒ Object

Metadata that indicates whether the ‘disableAutoSize` property is editable.



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

def disable_auto_size_metadata
  @disable_auto_size_metadata
end

#document_id ⇒ Object

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



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

def document_id
  @document_id
end

#document_id_metadata ⇒ Object

Metadata that indicates whether the ‘documentId` property is editable.



123
124
125
 
# File 'lib/docusign_esign/models/email.rb', line 123

def document_id_metadata
  @document_id_metadata
end

#error_details ⇒ Object

Array or errors.



126
127
128
 
# File 'lib/docusign_esign/models/email.rb', line 126

def error_details
  @error_details
end

#font ⇒ Object

The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default.



129
130
131
 
# File 'lib/docusign_esign/models/email.rb', line 129

def font
  @font
end

#font_color ⇒ Object

The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.



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

def font_color
  @font_color
end

#font_color_metadata ⇒ Object

Metadata that indicates whether the ‘fontColor` property is editable.



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

def font_color_metadata
  @font_color_metadata
end

#font_metadata ⇒ Object

Metadata that indicates whether the ‘font` property is editable.



138
139
140
 
# File 'lib/docusign_esign/models/email.rb', line 138

def font_metadata
  @font_metadata
end

#font_size ⇒ Object

The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.



141
142
143
 
# File 'lib/docusign_esign/models/email.rb', line 141

def font_size
  @font_size
end

#font_size_metadata ⇒ Object

Metadata that indicates whether the ‘fontSize` property is editable.



144
145
146
 
# File 'lib/docusign_esign/models/email.rb', line 144

def font_size_metadata
  @font_size_metadata
end

#form_order ⇒ Object

Returns the value of attribute form_order.



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

def form_order
  @form_order
end

#form_order_metadata ⇒ Object

Metadata that indicates whether the ‘formOrder` property is editable.



150
151
152
 
# File 'lib/docusign_esign/models/email.rb', line 150

def form_order_metadata
  @form_order_metadata
end

#form_page_label ⇒ Object

Returns the value of attribute form_page_label.



153
154
155
 
# File 'lib/docusign_esign/models/email.rb', line 153

def form_page_label
  @form_page_label
end

#form_page_label_metadata ⇒ Object

Metadata that indicates whether the ‘formPageLabel` property is editable.



156
157
158
 
# File 'lib/docusign_esign/models/email.rb', line 156

def form_page_label_metadata
  @form_page_label_metadata
end

#form_page_number ⇒ Object

Returns the value of attribute form_page_number.



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

def form_page_number
  @form_page_number
end

#form_page_number_metadata ⇒ Object

Metadata that indicates whether the ‘fromPageNumber` property is editable.



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

def form_page_number_metadata
  @form_page_number_metadata
end

#height ⇒ Object

Height of the tab in pixels.



165
166
167
 
# File 'lib/docusign_esign/models/email.rb', line 165

def height
  @height
end

#height_metadata ⇒ Object

Metadata that indicates whether the ‘height` property is editable.



168
169
170
 
# File 'lib/docusign_esign/models/email.rb', line 168

def height_metadata
  @height_metadata
end

#italic ⇒ Object

When set to true, the information in the tab is italic.



171
172
173
 
# File 'lib/docusign_esign/models/email.rb', line 171

def italic
  @italic
end

#italic_metadata ⇒ Object

Metadata that indicates whether the ‘italic` property is editable.



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

def italic_metadata
  @italic_metadata
end

#locale_policy ⇒ Object

Reserved for DocuSign.



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

def locale_policy
  @locale_policy
end

#locked ⇒ Object

When set to true, the signer cannot change the data of the custom tab.



180
181
182
 
# File 'lib/docusign_esign/models/email.rb', line 180

def locked
  @locked
end

#locked_metadata ⇒ Object

Metadata that indicates whether the ‘locked` property is editable.



183
184
185
 
# File 'lib/docusign_esign/models/email.rb', line 183

def locked_metadata
  @locked_metadata
end

#max_length ⇒ Object

An optional value that describes the maximum length of the property when the property is a string.



186
187
188
 
# File 'lib/docusign_esign/models/email.rb', line 186

def max_length
  @max_length
end

#max_length_metadata ⇒ Object

Metadata that indicates whether the ‘maxLength` property is editable.



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

def max_length_metadata
  @max_length_metadata
end

#merge_field ⇒ Object

Contains the information necessary to map the tab to a field in SalesForce.



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

def merge_field
  @merge_field
end

#merge_field_xml ⇒ Object

Returns the value of attribute merge_field_xml.



195
196
197
 
# File 'lib/docusign_esign/models/email.rb', line 195

def merge_field_xml
  @merge_field_xml
end

#name ⇒ Object

Returns the value of attribute name.



198
199
200
 
# File 'lib/docusign_esign/models/email.rb', line 198

def name
  @name
end

#name_metadata ⇒ Object

Metadata that indicates whether the ‘name` property is editable. This property is read-only.



201
202
203
 
# File 'lib/docusign_esign/models/email.rb', line 201

def name_metadata
  @name_metadata
end

#original_value ⇒ Object

The initial value of the tab when it was sent to the recipient.



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

def original_value
  @original_value
end

#original_value_metadata ⇒ Object

Metadata that indicates whether the ‘originalValue` property is editable.



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

def original_value_metadata
  @original_value_metadata
end

#page_number ⇒ Object

Specifies the page number on which the tab is located.



210
211
212
 
# File 'lib/docusign_esign/models/email.rb', line 210

def page_number
  @page_number
end

#page_number_metadata ⇒ Object

Metadata that indicates whether the ‘pageNumber` property is editable.



213
214
215
 
# File 'lib/docusign_esign/models/email.rb', line 213

def page_number_metadata
  @page_number_metadata
end

#recipient_id ⇒ Object

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



216
217
218
 
# File 'lib/docusign_esign/models/email.rb', line 216

def recipient_id
  @recipient_id
end

#recipient_id_guid ⇒ Object

Returns the value of attribute recipient_id_guid.



219
220
221
 
# File 'lib/docusign_esign/models/email.rb', line 219

def recipient_id_guid
  @recipient_id_guid
end

#recipient_id_guid_metadata ⇒ Object

Metadata that indicates whether the ‘recipientIdGuid` property is editable.



222
223
224
 
# File 'lib/docusign_esign/models/email.rb', line 222

def recipient_id_guid_metadata
  @recipient_id_guid_metadata
end

#recipient_id_metadata ⇒ Object

Metadata that indicates whether the ‘recipientId` property is editable.



225
226
227
 
# File 'lib/docusign_esign/models/email.rb', line 225

def recipient_id_metadata
  @recipient_id_metadata
end

#require_all ⇒ Object

When set to true and shared is true, information must be entered in this field to complete the envelope.



228
229
230
 
# File 'lib/docusign_esign/models/email.rb', line 228

def require_all
  @require_all
end

#require_all_metadata ⇒ Object

Metadata that indicates whether the ‘requireAll` property is editable.



231
232
233
 
# File 'lib/docusign_esign/models/email.rb', line 231

def require_all_metadata
  @require_all_metadata
end

#require_initial_on_shared_change ⇒ Object

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.



240
241
242
 
# File 'lib/docusign_esign/models/email.rb', line 240

def require_initial_on_shared_change
  @require_initial_on_shared_change
end

#require_initial_on_shared_change_metadata ⇒ Object

Metadata that indicates whether the ‘requireInitialOnSharedChange` property is editable.



243
244
245
 
# File 'lib/docusign_esign/models/email.rb', line 243

def require_initial_on_shared_change_metadata
  @require_initial_on_shared_change_metadata
end

#required ⇒ Object

When set to true, the signer is required to fill out this tab



234
235
236
 
# File 'lib/docusign_esign/models/email.rb', line 234

def required
  @required
end

#required_metadata ⇒ Object

Metadata that indicates whether the ‘required` property is editable.



237
238
239
 
# File 'lib/docusign_esign/models/email.rb', line 237

def required_metadata
  @required_metadata
end

#sender_required ⇒ Object

When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a ‘senderRequired` value of true cannot be deleted from an envelope.



246
247
248
 
# File 'lib/docusign_esign/models/email.rb', line 246

def sender_required
  @sender_required
end

#sender_required_metadata ⇒ Object

Metadata that indicates whether the ‘senderRequired` property is editable.



249
250
251
 
# File 'lib/docusign_esign/models/email.rb', line 249

def sender_required_metadata
  @sender_required_metadata
end

#share_to_recipients ⇒ Object

Returns the value of attribute share_to_recipients.



258
259
260
 
# File 'lib/docusign_esign/models/email.rb', line 258

def share_to_recipients
  @share_to_recipients
end

#share_to_recipients_metadata ⇒ Object

Reserved for DocuSign.



261
262
263
 
# File 'lib/docusign_esign/models/email.rb', line 261

def share_to_recipients_metadata
  @share_to_recipients_metadata
end

#shared ⇒ Object

When set to true, this custom tab is shared.



252
253
254
 
# File 'lib/docusign_esign/models/email.rb', line 252

def shared
  @shared
end

#shared_metadata ⇒ Object

Metadata that indicates whether the ‘shared` property is editable.



255
256
257
 
# File 'lib/docusign_esign/models/email.rb', line 255

def shared_metadata
  @shared_metadata
end

#smart_contract_information ⇒ Object

Reserved for DocuSign.



264
265
266
 
# File 'lib/docusign_esign/models/email.rb', line 264

def smart_contract_information
  @smart_contract_information
end

#source ⇒ Object

Returns the value of attribute source.



267
268
269
 
# File 'lib/docusign_esign/models/email.rb', line 267

def source
  @source
end

#status ⇒ Object

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.



270
271
272
 
# File 'lib/docusign_esign/models/email.rb', line 270

def status
  @status
end

#status_metadata ⇒ Object

Metadata that indicates whether the ‘status` property is editable.



273
274
275
 
# File 'lib/docusign_esign/models/email.rb', line 273

def status_metadata
  @status_metadata
end

#tab_group_labels ⇒ Object

Returns the value of attribute tab_group_labels.



276
277
278
 
# File 'lib/docusign_esign/models/email.rb', line 276

def tab_group_labels
  @tab_group_labels
end

#tab_group_labels_metadata ⇒ Object

Metadata that indicates whether the ‘tabGroupLabels` property is editable.



279
280
281
 
# File 'lib/docusign_esign/models/email.rb', line 279

def tab_group_labels_metadata
  @tab_group_labels_metadata
end

#tab_id ⇒ Object

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



282
283
284
 
# File 'lib/docusign_esign/models/email.rb', line 282

def tab_id
  @tab_id
end

#tab_id_metadata ⇒ Object

Metadata that indicates whether the ‘tabId` property is editable.



285
286
287
 
# File 'lib/docusign_esign/models/email.rb', line 285

def tab_id_metadata
  @tab_id_metadata
end

#tab_label ⇒ Object

The label string associated with the tab.



288
289
290
 
# File 'lib/docusign_esign/models/email.rb', line 288

def tab_label
  @tab_label
end

#tab_label_metadata ⇒ Object

Metadata that indicates whether the ‘tabLabel` property is editable.



291
292
293
 
# File 'lib/docusign_esign/models/email.rb', line 291

def tab_label_metadata
  @tab_label_metadata
end

#tab_order ⇒ Object

Returns the value of attribute tab_order.



294
295
296
 
# File 'lib/docusign_esign/models/email.rb', line 294

def tab_order
  @tab_order
end

#tab_order_metadata ⇒ Object

Metadata that indicates whether the ‘tabOrder` property is editable.



297
298
299
 
# File 'lib/docusign_esign/models/email.rb', line 297

def tab_order_metadata
  @tab_order_metadata
end

#tab_type ⇒ Object

Returns the value of attribute tab_type.



300
301
302
 
# File 'lib/docusign_esign/models/email.rb', line 300

def tab_type
  @tab_type
end

#tab_type_metadata ⇒ Object

Metadata that indicates whether the ‘tabType` property is editable.



303
304
305
 
# File 'lib/docusign_esign/models/email.rb', line 303

def tab_type_metadata
  @tab_type_metadata
end

#template_locked ⇒ Object

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



306
307
308
 
# File 'lib/docusign_esign/models/email.rb', line 306

def template_locked
  @template_locked
end

#template_locked_metadata ⇒ Object

Metadata that indicates whether the ‘templateLocked` property is editable.



309
310
311
 
# File 'lib/docusign_esign/models/email.rb', line 309

def template_locked_metadata
  @template_locked_metadata
end

#template_required ⇒ Object

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



312
313
314
 
# File 'lib/docusign_esign/models/email.rb', line 312

def template_required
  @template_required
end

#template_required_metadata ⇒ Object

Metadata that indicates whether the ‘templateRequired` property is editable.



315
316
317
 
# File 'lib/docusign_esign/models/email.rb', line 315

def template_required_metadata
  @template_required_metadata
end

#tool_tip_metadata ⇒ Object

Metadata that indicates whether the ‘toolTip` property is editable.



321
322
323
 
# File 'lib/docusign_esign/models/email.rb', line 321

def tool_tip_metadata
  @tool_tip_metadata
end

#tooltip ⇒ Object

Returns the value of attribute tooltip.



318
319
320
 
# File 'lib/docusign_esign/models/email.rb', line 318

def tooltip
  @tooltip
end

#underline ⇒ Object

When set to true, the information in the tab is underlined.



324
325
326
 
# File 'lib/docusign_esign/models/email.rb', line 324

def underline
  @underline
end

#underline_metadata ⇒ Object

Metadata that indicates whether the ‘underline` property is editable.



327
328
329
 
# File 'lib/docusign_esign/models/email.rb', line 327

def underline_metadata
  @underline_metadata
end

#validation_message ⇒ Object

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



330
331
332
 
# File 'lib/docusign_esign/models/email.rb', line 330

def validation_message
  @validation_message
end

#validation_message_metadata ⇒ Object

Metadata that indicates whether the ‘validationMessage` property is editable.



333
334
335
 
# File 'lib/docusign_esign/models/email.rb', line 333

def validation_message_metadata
  @validation_message_metadata
end

#validation_pattern ⇒ Object

A regular expression used to validate input for the tab.



336
337
338
 
# File 'lib/docusign_esign/models/email.rb', line 336

def validation_pattern
  @validation_pattern
end

#validation_pattern_metadata ⇒ Object

Metadata that indicates whether the ‘validationPattern` property is editable.



339
340
341
 
# File 'lib/docusign_esign/models/email.rb', line 339

def validation_pattern_metadata
  @validation_pattern_metadata
end

#value ⇒ Object

Specifies the value of the tab.



342
343
344
 
# File 'lib/docusign_esign/models/email.rb', line 342

def value
  @value
end

#value_metadata ⇒ Object

Metadata that indicates whether the ‘value` property is editable.



345
346
347
 
# File 'lib/docusign_esign/models/email.rb', line 345

def value_metadata
  @value_metadata
end

#width ⇒ Object

Width of the tab in pixels.



348
349
350
 
# File 'lib/docusign_esign/models/email.rb', line 348

def width
  @width
end

#width_metadata ⇒ Object

Metadata that indicates whether the ‘width` property is editable.



351
352
353
 
# File 'lib/docusign_esign/models/email.rb', line 351

def width_metadata
  @width_metadata
end

#x_position ⇒ Object

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



354
355
356
 
# File 'lib/docusign_esign/models/email.rb', line 354

def x_position
  @x_position
end

#x_position_metadata ⇒ Object

Metadata that indicates whether the ‘xPosition` property is editable.



357
358
359
 
# File 'lib/docusign_esign/models/email.rb', line 357

def x_position_metadata
  @x_position_metadata
end

#y_position ⇒ Object

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



360
361
362
 
# File 'lib/docusign_esign/models/email.rb', line 360

def y_position
  @y_position
end

#y_position_metadata ⇒ Object

Metadata that indicates whether the ‘yPosition` property is editable.



363
364
365
 
# File 'lib/docusign_esign/models/email.rb', line 363

def y_position_metadata
  @y_position_metadata
end

Class Method Details

.attribute_map ⇒ Object

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



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
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
 
# File 'lib/docusign_esign/models/email.rb', line 366

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',
    :'bold' => :'bold',
    :'bold_metadata' => :'boldMetadata',
    :'caption' => :'caption',
    :'caption_metadata' => :'captionMetadata',
    :'conceal_value_on_document' => :'concealValueOnDocument',
    :'conceal_value_on_document_metadata' => :'concealValueOnDocumentMetadata',
    :'conditional_parent_label' => :'conditionalParentLabel',
    :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata',
    :'conditional_parent_value' => :'conditionalParentValue',
    :'conditional_parent_value_metadata' => :'conditionalParentValueMetadata',
    :'custom_tab_id' => :'customTabId',
    :'custom_tab_id_metadata' => :'customTabIdMetadata',
    :'disable_auto_size' => :'disableAutoSize',
    :'disable_auto_size_metadata' => :'disableAutoSizeMetadata',
    :'document_id' => :'documentId',
    :'document_id_metadata' => :'documentIdMetadata',
    :'error_details' => :'errorDetails',
    :'font' => :'font',
    :'font_color' => :'fontColor',
    :'font_color_metadata' => :'fontColorMetadata',
    :'font_metadata' => :'fontMetadata',
    :'font_size' => :'fontSize',
    :'font_size_metadata' => :'fontSizeMetadata',
    :'form_order' => :'formOrder',
    :'form_order_metadata' => :'formOrderMetadata',
    :'form_page_label' => :'formPageLabel',
    :'form_page_label_metadata' => :'formPageLabelMetadata',
    :'form_page_number' => :'formPageNumber',
    :'form_page_number_metadata' => :'formPageNumberMetadata',
    :'height' => :'height',
    :'height_metadata' => :'heightMetadata',
    :'italic' => :'italic',
    :'italic_metadata' => :'italicMetadata',
    :'locale_policy' => :'localePolicy',
    :'locked' => :'locked',
    :'locked_metadata' => :'lockedMetadata',
    :'max_length' => :'maxLength',
    :'max_length_metadata' => :'maxLengthMetadata',
    :'merge_field' => :'mergeField',
    :'merge_field_xml' => :'mergeFieldXml',
    :'name' => :'name',
    :'name_metadata' => :'nameMetadata',
    :'original_value' => :'originalValue',
    :'original_value_metadata' => :'originalValueMetadata',
    :'page_number' => :'pageNumber',
    :'page_number_metadata' => :'pageNumberMetadata',
    :'recipient_id' => :'recipientId',
    :'recipient_id_guid' => :'recipientIdGuid',
    :'recipient_id_guid_metadata' => :'recipientIdGuidMetadata',
    :'recipient_id_metadata' => :'recipientIdMetadata',
    :'require_all' => :'requireAll',
    :'require_all_metadata' => :'requireAllMetadata',
    :'required' => :'required',
    :'required_metadata' => :'requiredMetadata',
    :'require_initial_on_shared_change' => :'requireInitialOnSharedChange',
    :'require_initial_on_shared_change_metadata' => :'requireInitialOnSharedChangeMetadata',
    :'sender_required' => :'senderRequired',
    :'sender_required_metadata' => :'senderRequiredMetadata',
    :'shared' => :'shared',
    :'shared_metadata' => :'sharedMetadata',
    :'share_to_recipients' => :'shareToRecipients',
    :'share_to_recipients_metadata' => :'shareToRecipientsMetadata',
    :'smart_contract_information' => :'smartContractInformation',
    :'source' => :'source',
    :'status' => :'status',
    :'status_metadata' => :'statusMetadata',
    :'tab_group_labels' => :'tabGroupLabels',
    :'tab_group_labels_metadata' => :'tabGroupLabelsMetadata',
    :'tab_id' => :'tabId',
    :'tab_id_metadata' => :'tabIdMetadata',
    :'tab_label' => :'tabLabel',
    :'tab_label_metadata' => :'tabLabelMetadata',
    :'tab_order' => :'tabOrder',
    :'tab_order_metadata' => :'tabOrderMetadata',
    :'tab_type' => :'tabType',
    :'tab_type_metadata' => :'tabTypeMetadata',
    :'template_locked' => :'templateLocked',
    :'template_locked_metadata' => :'templateLockedMetadata',
    :'template_required' => :'templateRequired',
    :'template_required_metadata' => :'templateRequiredMetadata',
    :'tooltip' => :'tooltip',
    :'tool_tip_metadata' => :'toolTipMetadata',
    :'underline' => :'underline',
    :'underline_metadata' => :'underlineMetadata',
    :'validation_message' => :'validationMessage',
    :'validation_message_metadata' => :'validationMessageMetadata',
    :'validation_pattern' => :'validationPattern',
    :'validation_pattern_metadata' => :'validationPatternMetadata',
    :'value' => :'value',
    :'value_metadata' => :'valueMetadata',
    :'width' => :'width',
    :'width_metadata' => :'widthMetadata',
    :'x_position' => :'xPosition',
    :'x_position_metadata' => :'xPositionMetadata',
    :'y_position' => :'yPosition',
    :'y_position_metadata' => :'yPositionMetadata'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/docusign_esign/models/email.rb', line 488

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',
    :'bold' => :'String',
    :'bold_metadata' => :'PropertyMetadata',
    :'caption' => :'String',
    :'caption_metadata' => :'PropertyMetadata',
    :'conceal_value_on_document' => :'String',
    :'conceal_value_on_document_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',
    :'disable_auto_size' => :'String',
    :'disable_auto_size_metadata' => :'PropertyMetadata',
    :'document_id' => :'String',
    :'document_id_metadata' => :'PropertyMetadata',
    :'error_details' => :'ErrorDetails',
    :'font' => :'String',
    :'font_color' => :'String',
    :'font_color_metadata' => :'PropertyMetadata',
    :'font_metadata' => :'PropertyMetadata',
    :'font_size' => :'String',
    :'font_size_metadata' => :'PropertyMetadata',
    :'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',
    :'height' => :'String',
    :'height_metadata' => :'PropertyMetadata',
    :'italic' => :'String',
    :'italic_metadata' => :'PropertyMetadata',
    :'locale_policy' => :'LocalePolicyTab',
    :'locked' => :'String',
    :'locked_metadata' => :'PropertyMetadata',
    :'max_length' => :'String',
    :'max_length_metadata' => :'PropertyMetadata',
    :'merge_field' => :'MergeField',
    :'merge_field_xml' => :'String',
    :'name' => :'String',
    :'name_metadata' => :'PropertyMetadata',
    :'original_value' => :'String',
    :'original_value_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',
    :'require_all' => :'String',
    :'require_all_metadata' => :'PropertyMetadata',
    :'required' => :'String',
    :'required_metadata' => :'PropertyMetadata',
    :'require_initial_on_shared_change' => :'String',
    :'require_initial_on_shared_change_metadata' => :'PropertyMetadata',
    :'sender_required' => :'String',
    :'sender_required_metadata' => :'PropertyMetadata',
    :'shared' => :'String',
    :'shared_metadata' => :'PropertyMetadata',
    :'share_to_recipients' => :'String',
    :'share_to_recipients_metadata' => :'PropertyMetadata',
    :'smart_contract_information' => :'SmartContractInformation',
    :'source' => :'String',
    :'status' => :'String',
    :'status_metadata' => :'PropertyMetadata',
    :'tab_group_labels' => :'Array<String>',
    :'tab_group_labels_metadata' => :'PropertyMetadata',
    :'tab_id' => :'String',
    :'tab_id_metadata' => :'PropertyMetadata',
    :'tab_label' => :'String',
    :'tab_label_metadata' => :'PropertyMetadata',
    :'tab_order' => :'String',
    :'tab_order_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',
    :'underline' => :'String',
    :'underline_metadata' => :'PropertyMetadata',
    :'validation_message' => :'String',
    :'validation_message_metadata' => :'PropertyMetadata',
    :'validation_pattern' => :'String',
    :'validation_pattern_metadata' => :'PropertyMetadata',
    :'value' => :'String',
    :'value_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



1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
 
# File 'lib/docusign_esign/models/email.rb', line 1099

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 &&
      anchor_allow_white_space_in_characters_metadata == o.anchor_allow_white_space_in_characters_metadata &&
      anchor_case_sensitive == o.anchor_case_sensitive &&
      anchor_case_sensitive_metadata == o.anchor_case_sensitive_metadata &&
      anchor_horizontal_alignment == o.anchor_horizontal_alignment &&
      anchor_horizontal_alignment_metadata == o.anchor_horizontal_alignment_metadata &&
      anchor_ignore_if_not_present == o.anchor_ignore_if_not_present &&
      anchor_ignore_if_not_present_metadata == o.anchor_ignore_if_not_present_metadata &&
      anchor_match_whole_word == o.anchor_match_whole_word &&
      anchor_match_whole_word_metadata == o.anchor_match_whole_word_metadata &&
      anchor_string == o.anchor_string &&
      anchor_string_metadata == o.anchor_string_metadata &&
      anchor_tab_processor_version == o.anchor_tab_processor_version &&
      anchor_tab_processor_version_metadata == o.anchor_tab_processor_version_metadata &&
      anchor_units == o.anchor_units &&
      anchor_units_metadata == o.anchor_units_metadata &&
      anchor_x_offset == o.anchor_x_offset &&
      anchor_x_offset_metadata == o.anchor_x_offset_metadata &&
      anchor_y_offset == o.anchor_y_offset &&
      anchor_y_offset_metadata == o.anchor_y_offset_metadata &&
      bold == o.bold &&
      bold_metadata == o.bold_metadata &&
      caption == o.caption &&
      caption_metadata == o.caption_metadata &&
      conceal_value_on_document == o.conceal_value_on_document &&
      conceal_value_on_document_metadata == o.conceal_value_on_document_metadata &&
      conditional_parent_label == o.conditional_parent_label &&
      conditional_parent_label_metadata == o.conditional_parent_label_metadata &&
      conditional_parent_value == o.conditional_parent_value &&
      conditional_parent_value_metadata == o.conditional_parent_value_metadata &&
      custom_tab_id == o.custom_tab_id &&
      custom_tab_id_metadata == o.custom_tab_id_metadata &&
      disable_auto_size == o.disable_auto_size &&
      disable_auto_size_metadata == o.disable_auto_size_metadata &&
      document_id == o.document_id &&
      document_id_metadata == o.document_id_metadata &&
      error_details == o.error_details &&
      font == o.font &&
      font_color == o.font_color &&
      font_color_metadata == o.font_color_metadata &&
      font_metadata == o.font_metadata &&
      font_size == o.font_size &&
      font_size_metadata == o.font_size_metadata &&
      form_order == o.form_order &&
      form_order_metadata == o.form_order_metadata &&
      form_page_label == o.form_page_label &&
      form_page_label_metadata == o.form_page_label_metadata &&
      form_page_number == o.form_page_number &&
      form_page_number_metadata == o.form_page_number_metadata &&
      height == o.height &&
      height_metadata == o.height_metadata &&
      italic == o.italic &&
      italic_metadata == o.italic_metadata &&
      locale_policy == o.locale_policy &&
      locked == o.locked &&
      locked_metadata == o.locked_metadata &&
      max_length == o.max_length &&
      max_length_metadata == o.max_length_metadata &&
      merge_field == o.merge_field &&
      merge_field_xml == o.merge_field_xml &&
      name == o.name &&
      name_metadata == o.name_metadata &&
      original_value == o.original_value &&
      original_value_metadata == o.original_value_metadata &&
      page_number == o.page_number &&
      page_number_metadata == o.page_number_metadata &&
      recipient_id == o.recipient_id &&
      recipient_id_guid == o.recipient_id_guid &&
      recipient_id_guid_metadata == o.recipient_id_guid_metadata &&
      recipient_id_metadata == o.recipient_id_metadata &&
      require_all == o.require_all &&
      require_all_metadata == o.require_all_metadata &&
      required == o.required &&
      required_metadata == o.required_metadata &&
      require_initial_on_shared_change == o.require_initial_on_shared_change &&
      require_initial_on_shared_change_metadata == o.require_initial_on_shared_change_metadata &&
      sender_required == o.sender_required &&
      sender_required_metadata == o.sender_required_metadata &&
      shared == o.shared &&
      shared_metadata == o.shared_metadata &&
      share_to_recipients == o.share_to_recipients &&
      share_to_recipients_metadata == o.share_to_recipients_metadata &&
      smart_contract_information == o.smart_contract_information &&
      source == o.source &&
      status == o.status &&
      status_metadata == o.status_metadata &&
      tab_group_labels == o.tab_group_labels &&
      tab_group_labels_metadata == o.tab_group_labels_metadata &&
      tab_id == o.tab_id &&
      tab_id_metadata == o.tab_id_metadata &&
      tab_label == o.tab_label &&
      tab_label_metadata == o.tab_label_metadata &&
      tab_order == o.tab_order &&
      tab_order_metadata == o.tab_order_metadata &&
      tab_type == o.tab_type &&
      tab_type_metadata == o.tab_type_metadata &&
      template_locked == o.template_locked &&
      template_locked_metadata == o.template_locked_metadata &&
      template_required == o.template_required &&
      template_required_metadata == o.template_required_metadata &&
      tooltip == o.tooltip &&
      tool_tip_metadata == o.tool_tip_metadata &&
      underline == o.underline &&
      underline_metadata == o.underline_metadata &&
      validation_message == o.validation_message &&
      validation_message_metadata == o.validation_message_metadata &&
      validation_pattern == o.validation_pattern &&
      validation_pattern_metadata == o.validation_pattern_metadata &&
      value == o.value &&
      value_metadata == o.value_metadata &&
      width == o.width &&
      width_metadata == o.width_metadata &&
      x_position == o.x_position &&
      x_position_metadata == o.x_position_metadata &&
      y_position == o.y_position &&
      y_position_metadata == o.y_position_metadata
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



1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
 
# File 'lib/docusign_esign/models/email.rb', line 1256

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



1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
 
# File 'lib/docusign_esign/models/email.rb', line 1322

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



1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
 
# File 'lib/docusign_esign/models/email.rb', line 1235

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


1222
1223
1224
 
# File 'lib/docusign_esign/models/email.rb', line 1222

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



1228
1229
1230
 
# File 'lib/docusign_esign/models/email.rb', line 1228

def hash
  [anchor_allow_white_space_in_characters, anchor_allow_white_space_in_characters_metadata, anchor_case_sensitive, anchor_case_sensitive_metadata, anchor_horizontal_alignment, anchor_horizontal_alignment_metadata, anchor_ignore_if_not_present, anchor_ignore_if_not_present_metadata, anchor_match_whole_word, anchor_match_whole_word_metadata, anchor_string, anchor_string_metadata, anchor_tab_processor_version, anchor_tab_processor_version_metadata, anchor_units, anchor_units_metadata, anchor_x_offset, anchor_x_offset_metadata, anchor_y_offset, anchor_y_offset_metadata, bold, bold_metadata, caption, caption_metadata, conceal_value_on_document, conceal_value_on_document_metadata, conditional_parent_label, conditional_parent_label_metadata, conditional_parent_value, conditional_parent_value_metadata, custom_tab_id, custom_tab_id_metadata, disable_auto_size, disable_auto_size_metadata, document_id, document_id_metadata, error_details, font, font_color, font_color_metadata, font_metadata, font_size, font_size_metadata, form_order, form_order_metadata, form_page_label, form_page_label_metadata, form_page_number, form_page_number_metadata, height, height_metadata, italic, italic_metadata, locale_policy, locked, locked_metadata, max_length, max_length_metadata, merge_field, merge_field_xml, name, name_metadata, original_value, original_value_metadata, page_number, page_number_metadata, recipient_id, recipient_id_guid, recipient_id_guid_metadata, recipient_id_metadata, require_all, require_all_metadata, required, required_metadata, require_initial_on_shared_change, require_initial_on_shared_change_metadata, sender_required, sender_required_metadata, shared, shared_metadata, share_to_recipients, share_to_recipients_metadata, smart_contract_information, source, status, status_metadata, tab_group_labels, tab_group_labels_metadata, tab_id, tab_id_metadata, tab_label, tab_label_metadata, tab_order, tab_order_metadata, tab_type, tab_type_metadata, template_locked, template_locked_metadata, template_required, template_required_metadata, tooltip, tool_tip_metadata, underline, underline_metadata, validation_message, validation_message_metadata, validation_pattern, validation_pattern_metadata, value, value_metadata, width, width_metadata, x_position, x_position_metadata, y_position, y_position_metadata].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



1086
1087
1088
1089
 
# File 'lib/docusign_esign/models/email.rb', line 1086

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



1302
1303
1304
 
# File 'lib/docusign_esign/models/email.rb', line 1302

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



1308
1309
1310
1311
1312
1313
1314
1315
1316
 
# File 'lib/docusign_esign/models/email.rb', line 1308

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



1296
1297
1298
 
# File 'lib/docusign_esign/models/email.rb', line 1296

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



1093
1094
1095
 
# File 'lib/docusign_esign/models/email.rb', line 1093

def valid?
  true
end