Class: DocuSign_eSign::List
- Inherits:
-
Object
- Object
- DocuSign_eSign::List
- Defined in:
- lib/docusign_esign/models/list.rb
Instance Attribute Summary collapse
-
#anchor_allow_white_space_in_characters ⇒ Object
Returns the value of attribute anchor_allow_white_space_in_characters.
-
#anchor_allow_white_space_in_characters_metadata ⇒ Object
Returns the value of attribute anchor_allow_white_space_in_characters_metadata.
-
#anchor_case_sensitive ⇒ Object
When set to true, the anchor string does not consider case when matching strings in the document.
-
#anchor_case_sensitive_metadata ⇒ Object
Returns the value of attribute anchor_case_sensitive_metadata.
-
#anchor_horizontal_alignment ⇒ Object
Specifies the alignment of anchor tabs with anchor strings.
-
#anchor_horizontal_alignment_metadata ⇒ Object
Returns the value of attribute anchor_horizontal_alignment_metadata.
-
#anchor_ignore_if_not_present ⇒ Object
When set to true, this tab is ignored if anchorString is not found in the document.
-
#anchor_ignore_if_not_present_metadata ⇒ Object
Returns the value of attribute anchor_ignore_if_not_present_metadata.
-
#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.
-
#anchor_match_whole_word_metadata ⇒ Object
Returns the value of attribute anchor_match_whole_word_metadata.
-
#anchor_string ⇒ Object
Anchor text information for a radio button.
-
#anchor_string_metadata ⇒ Object
Returns the value of attribute anchor_string_metadata.
-
#anchor_tab_processor_version ⇒ Object
Returns the value of attribute anchor_tab_processor_version.
-
#anchor_tab_processor_version_metadata ⇒ Object
Returns the value of attribute anchor_tab_processor_version_metadata.
-
#anchor_units ⇒ Object
Specifies units of the X and Y offset.
-
#anchor_units_metadata ⇒ Object
Returns the value of attribute anchor_units_metadata.
-
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
-
#anchor_x_offset_metadata ⇒ Object
Returns the value of attribute anchor_x_offset_metadata.
-
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
-
#anchor_y_offset_metadata ⇒ Object
Returns the value of attribute anchor_y_offset_metadata.
-
#bold ⇒ Object
When set to true, the information in the tab is bold.
-
#bold_metadata ⇒ Object
Returns the value of attribute bold_metadata.
-
#caption ⇒ Object
Returns the value of attribute caption.
-
#caption_metadata ⇒ Object
Returns the value of attribute caption_metadata.
-
#conditional_parent_label ⇒ Object
For conditional fields this is the TabLabel of the parent tab that controls this tab’s visibility.
-
#conditional_parent_label_metadata ⇒ Object
Returns the value of attribute conditional_parent_label_metadata.
-
#conditional_parent_value ⇒ Object
For conditional fields, this is the value of the parent tab that controls the tab’s visibility.
-
#conditional_parent_value_metadata ⇒ Object
Returns the value of attribute conditional_parent_value_metadata.
-
#custom_tab_id ⇒ Object
The DocuSign generated custom tab ID for the custom tab to be applied.
-
#custom_tab_id_metadata ⇒ Object
Returns the value of attribute custom_tab_id_metadata.
-
#document_id ⇒ Object
Specifies the document ID number that the tab is placed on.
-
#document_id_metadata ⇒ Object
Returns the value of attribute document_id_metadata.
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#font ⇒ Object
The font to be used for the tab value.
-
#font_color ⇒ Object
The font color used for the information in the tab.
-
#font_color_metadata ⇒ Object
Returns the value of attribute font_color_metadata.
-
#font_metadata ⇒ Object
Returns the value of attribute font_metadata.
-
#font_size ⇒ Object
The font size used for the information in the tab.
-
#font_size_metadata ⇒ Object
Returns the value of attribute font_size_metadata.
-
#form_order ⇒ Object
Returns the value of attribute form_order.
-
#form_order_metadata ⇒ Object
Returns the value of attribute form_order_metadata.
-
#form_page_label ⇒ Object
Returns the value of attribute form_page_label.
-
#form_page_label_metadata ⇒ Object
Returns the value of attribute form_page_label_metadata.
-
#form_page_number ⇒ Object
Returns the value of attribute form_page_number.
-
#form_page_number_metadata ⇒ Object
Returns the value of attribute form_page_number_metadata.
-
#height ⇒ Object
Height of the tab in pixels.
-
#height_metadata ⇒ Object
Returns the value of attribute height_metadata.
-
#italic ⇒ Object
When set to true, the information in the tab is italic.
-
#italic_metadata ⇒ Object
Returns the value of attribute italic_metadata.
-
#list_items ⇒ Object
The list of values that can be selected by senders.
-
#list_selected_value ⇒ Object
Returns the value of attribute list_selected_value.
-
#list_selected_value_metadata ⇒ Object
Returns the value of attribute list_selected_value_metadata.
-
#locale_policy ⇒ Object
Returns the value of attribute locale_policy.
-
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
-
#locked_metadata ⇒ Object
Returns the value of attribute locked_metadata.
-
#merge_field ⇒ Object
Returns the value of attribute merge_field.
-
#merge_field_xml ⇒ Object
Returns the value of attribute merge_field_xml.
-
#original_value ⇒ Object
The initial value of the tab when it was sent to the recipient.
-
#original_value_metadata ⇒ Object
Returns the value of attribute original_value_metadata.
-
#page_number ⇒ Object
Specifies the page number on which the tab is located.
-
#page_number_metadata ⇒ Object
Returns the value of attribute page_number_metadata.
-
#recipient_id ⇒ Object
Unique for the recipient.
-
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
-
#recipient_id_guid_metadata ⇒ Object
Returns the value of attribute recipient_id_guid_metadata.
-
#recipient_id_metadata ⇒ Object
Returns the value of attribute recipient_id_metadata.
-
#require_all ⇒ Object
When set to true and shared is true, information must be entered in this field to complete the envelope.
-
#require_all_metadata ⇒ Object
Returns the value of attribute require_all_metadata.
-
#require_initial_on_shared_change ⇒ Object
Optional element for field markup.
-
#require_initial_on_shared_change_metadata ⇒ Object
Returns the value of attribute require_initial_on_shared_change_metadata.
-
#required ⇒ Object
When set to true, the signer is required to fill out this tab.
-
#required_metadata ⇒ Object
Returns the value of attribute required_metadata.
-
#sender_required ⇒ Object
When set to true, the sender must populate the tab before an envelope can be sent using the template.
-
#sender_required_metadata ⇒ Object
Returns the value of attribute sender_required_metadata.
-
#share_to_recipients ⇒ Object
Returns the value of attribute share_to_recipients.
-
#share_to_recipients_metadata ⇒ Object
Returns the value of attribute share_to_recipients_metadata.
-
#shared ⇒ Object
When set to true, this custom tab is shared.
-
#shared_metadata ⇒ Object
Returns the value of attribute shared_metadata.
-
#smart_contract_information ⇒ Object
Returns the value of attribute smart_contract_information.
-
#source ⇒ Object
Returns the value of attribute source.
-
#status ⇒ Object
Indicates the envelope status.
-
#status_metadata ⇒ Object
Returns the value of attribute status_metadata.
-
#tab_group_labels ⇒ Object
Returns the value of attribute tab_group_labels.
-
#tab_group_labels_metadata ⇒ Object
Returns the value of attribute tab_group_labels_metadata.
-
#tab_id ⇒ Object
The unique identifier for the tab.
-
#tab_id_metadata ⇒ Object
Returns the value of attribute tab_id_metadata.
-
#tab_label ⇒ Object
The label string associated with the tab.
-
#tab_label_metadata ⇒ Object
Returns the value of attribute tab_label_metadata.
-
#tab_order ⇒ Object
Returns the value of attribute tab_order.
-
#tab_order_metadata ⇒ Object
Returns the value of attribute tab_order_metadata.
-
#tab_type ⇒ Object
Returns the value of attribute tab_type.
-
#tab_type_metadata ⇒ Object
Returns the value of attribute tab_type_metadata.
-
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient.
-
#template_locked_metadata ⇒ Object
Returns the value of attribute template_locked_metadata.
-
#template_required ⇒ Object
When set to true, the sender may not remove the recipient.
-
#template_required_metadata ⇒ Object
Returns the value of attribute template_required_metadata.
-
#tool_tip_metadata ⇒ Object
Returns the value of attribute tool_tip_metadata.
-
#tooltip ⇒ Object
Returns the value of attribute tooltip.
-
#underline ⇒ Object
When set to true, the information in the tab is underlined.
-
#underline_metadata ⇒ Object
Returns the value of attribute underline_metadata.
-
#value ⇒ Object
The value to use when the item is selected.
-
#value_metadata ⇒ Object
Returns the value of attribute value_metadata.
-
#width ⇒ Object
Width of the tab in pixels.
-
#width_metadata ⇒ Object
Returns the value of attribute width_metadata.
-
#x_position ⇒ Object
This indicates the horizontal offset of the object on the page.
-
#x_position_metadata ⇒ Object
Returns the value of attribute x_position_metadata.
-
#y_position ⇒ Object
This indicates the vertical offset of the object on the page.
-
#y_position_metadata ⇒ Object
Returns the value of attribute y_position_metadata.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ List
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ List
Initializes the object
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 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 |
# File 'lib/docusign_esign/models/list.rb', line 511 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?(:'bold') self.bold = attributes[:'bold'] end if attributes.has_key?(:'boldMetadata') self. = attributes[:'boldMetadata'] end if attributes.has_key?(:'caption') self. = attributes[:'caption'] end if attributes.has_key?(:'captionMetadata') self. = attributes[:'captionMetadata'] 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?(:'font') self.font = attributes[:'font'] end if attributes.has_key?(:'fontColor') self.font_color = attributes[:'fontColor'] end if attributes.has_key?(:'fontColorMetadata') self. = attributes[:'fontColorMetadata'] end if attributes.has_key?(:'fontMetadata') self. = attributes[:'fontMetadata'] end if attributes.has_key?(:'fontSize') self.font_size = attributes[:'fontSize'] end if attributes.has_key?(:'fontSizeMetadata') self. = attributes[:'fontSizeMetadata'] 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?(:'height') self.height = attributes[:'height'] end if attributes.has_key?(:'heightMetadata') self. = attributes[:'heightMetadata'] end if attributes.has_key?(:'italic') self.italic = attributes[:'italic'] end if attributes.has_key?(:'italicMetadata') self. = attributes[:'italicMetadata'] end if attributes.has_key?(:'listItems') if (value = attributes[:'listItems']).is_a?(Array) self.list_items = value end end if attributes.has_key?(:'listSelectedValue') self.list_selected_value = attributes[:'listSelectedValue'] end if attributes.has_key?(:'listSelectedValueMetadata') self. = attributes[:'listSelectedValueMetadata'] 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. = attributes[:'lockedMetadata'] 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?(:'originalValue') self.original_value = attributes[:'originalValue'] end if attributes.has_key?(:'originalValueMetadata') self. = attributes[:'originalValueMetadata'] 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?(:'requireAll') self.require_all = attributes[:'requireAll'] end if attributes.has_key?(:'requireAllMetadata') self. = attributes[:'requireAllMetadata'] end if attributes.has_key?(:'required') self.required = attributes[:'required'] end if attributes.has_key?(:'requiredMetadata') self. = attributes[:'requiredMetadata'] end if attributes.has_key?(:'requireInitialOnSharedChange') self.require_initial_on_shared_change = attributes[:'requireInitialOnSharedChange'] end if attributes.has_key?(:'requireInitialOnSharedChangeMetadata') self. = attributes[:'requireInitialOnSharedChangeMetadata'] end if attributes.has_key?(:'senderRequired') self.sender_required = attributes[:'senderRequired'] end if attributes.has_key?(:'senderRequiredMetadata') self. = attributes[:'senderRequiredMetadata'] end if attributes.has_key?(:'shared') self.shared = attributes[:'shared'] end if attributes.has_key?(:'sharedMetadata') self. = attributes[:'sharedMetadata'] end if attributes.has_key?(:'shareToRecipients') self.share_to_recipients = attributes[:'shareToRecipients'] end if attributes.has_key?(:'shareToRecipientsMetadata') self. = 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. = 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?(:'tabLabel') self.tab_label = attributes[:'tabLabel'] end if attributes.has_key?(:'tabLabelMetadata') self. = attributes[:'tabLabelMetadata'] 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?(:'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?(:'underline') self.underline = attributes[:'underline'] end if attributes.has_key?(:'underlineMetadata') self. = attributes[:'underlineMetadata'] end if attributes.has_key?(:'value') self.value = attributes[:'value'] end if attributes.has_key?(:'valueMetadata') self. = attributes[:'valueMetadata'] 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_characters ⇒ Object
Returns the value of attribute anchor_allow_white_space_in_characters.
17 18 19 |
# File 'lib/docusign_esign/models/list.rb', line 17 def anchor_allow_white_space_in_characters @anchor_allow_white_space_in_characters end |
#anchor_allow_white_space_in_characters_metadata ⇒ Object
Returns the value of attribute anchor_allow_white_space_in_characters_metadata.
19 20 21 |
# File 'lib/docusign_esign/models/list.rb', line 19 def @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.
22 23 24 |
# File 'lib/docusign_esign/models/list.rb', line 22 def anchor_case_sensitive @anchor_case_sensitive end |
#anchor_case_sensitive_metadata ⇒ Object
Returns the value of attribute anchor_case_sensitive_metadata.
24 25 26 |
# File 'lib/docusign_esign/models/list.rb', line 24 def @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.
27 28 29 |
# File 'lib/docusign_esign/models/list.rb', line 27 def anchor_horizontal_alignment @anchor_horizontal_alignment end |
#anchor_horizontal_alignment_metadata ⇒ Object
Returns the value of attribute anchor_horizontal_alignment_metadata.
29 30 31 |
# File 'lib/docusign_esign/models/list.rb', line 29 def @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.
32 33 34 |
# File 'lib/docusign_esign/models/list.rb', line 32 def anchor_ignore_if_not_present @anchor_ignore_if_not_present end |
#anchor_ignore_if_not_present_metadata ⇒ Object
Returns the value of attribute anchor_ignore_if_not_present_metadata.
34 35 36 |
# File 'lib/docusign_esign/models/list.rb', line 34 def @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.
37 38 39 |
# File 'lib/docusign_esign/models/list.rb', line 37 def anchor_match_whole_word @anchor_match_whole_word end |
#anchor_match_whole_word_metadata ⇒ Object
Returns the value of attribute anchor_match_whole_word_metadata.
39 40 41 |
# File 'lib/docusign_esign/models/list.rb', line 39 def @anchor_match_whole_word_metadata end |
#anchor_string ⇒ Object
Anchor text information for a radio button.
42 43 44 |
# File 'lib/docusign_esign/models/list.rb', line 42 def anchor_string @anchor_string end |
#anchor_string_metadata ⇒ Object
Returns the value of attribute anchor_string_metadata.
44 45 46 |
# File 'lib/docusign_esign/models/list.rb', line 44 def @anchor_string_metadata end |
#anchor_tab_processor_version ⇒ Object
Returns the value of attribute anchor_tab_processor_version.
47 48 49 |
# File 'lib/docusign_esign/models/list.rb', line 47 def anchor_tab_processor_version @anchor_tab_processor_version end |
#anchor_tab_processor_version_metadata ⇒ Object
Returns the value of attribute anchor_tab_processor_version_metadata.
49 50 51 |
# File 'lib/docusign_esign/models/list.rb', line 49 def @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.
52 53 54 |
# File 'lib/docusign_esign/models/list.rb', line 52 def anchor_units @anchor_units end |
#anchor_units_metadata ⇒ Object
Returns the value of attribute anchor_units_metadata.
54 55 56 |
# File 'lib/docusign_esign/models/list.rb', line 54 def @anchor_units_metadata end |
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
57 58 59 |
# File 'lib/docusign_esign/models/list.rb', line 57 def anchor_x_offset @anchor_x_offset end |
#anchor_x_offset_metadata ⇒ Object
Returns the value of attribute anchor_x_offset_metadata.
59 60 61 |
# File 'lib/docusign_esign/models/list.rb', line 59 def @anchor_x_offset_metadata end |
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
62 63 64 |
# File 'lib/docusign_esign/models/list.rb', line 62 def anchor_y_offset @anchor_y_offset end |
#anchor_y_offset_metadata ⇒ Object
Returns the value of attribute anchor_y_offset_metadata.
64 65 66 |
# File 'lib/docusign_esign/models/list.rb', line 64 def @anchor_y_offset_metadata end |
#bold ⇒ Object
When set to true, the information in the tab is bold.
67 68 69 |
# File 'lib/docusign_esign/models/list.rb', line 67 def bold @bold end |
#bold_metadata ⇒ Object
Returns the value of attribute bold_metadata.
69 70 71 |
# File 'lib/docusign_esign/models/list.rb', line 69 def @bold_metadata end |
#caption ⇒ Object
Returns the value of attribute caption.
72 73 74 |
# File 'lib/docusign_esign/models/list.rb', line 72 def @caption end |
#caption_metadata ⇒ Object
Returns the value of attribute caption_metadata.
74 75 76 |
# File 'lib/docusign_esign/models/list.rb', line 74 def @caption_metadata end |
#conditional_parent_label ⇒ Object
For conditional fields this is the TabLabel of the parent tab that controls this tab’s visibility.
77 78 79 |
# File 'lib/docusign_esign/models/list.rb', line 77 def conditional_parent_label @conditional_parent_label end |
#conditional_parent_label_metadata ⇒ Object
Returns the value of attribute conditional_parent_label_metadata.
79 80 81 |
# File 'lib/docusign_esign/models/list.rb', line 79 def @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.
82 83 84 |
# File 'lib/docusign_esign/models/list.rb', line 82 def conditional_parent_value @conditional_parent_value end |
#conditional_parent_value_metadata ⇒ Object
Returns the value of attribute conditional_parent_value_metadata.
84 85 86 |
# File 'lib/docusign_esign/models/list.rb', line 84 def @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.
87 88 89 |
# File 'lib/docusign_esign/models/list.rb', line 87 def custom_tab_id @custom_tab_id end |
#custom_tab_id_metadata ⇒ Object
Returns the value of attribute custom_tab_id_metadata.
89 90 91 |
# File 'lib/docusign_esign/models/list.rb', line 89 def @custom_tab_id_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.
92 93 94 |
# File 'lib/docusign_esign/models/list.rb', line 92 def document_id @document_id end |
#document_id_metadata ⇒ Object
Returns the value of attribute document_id_metadata.
94 95 96 |
# File 'lib/docusign_esign/models/list.rb', line 94 def @document_id_metadata end |
#error_details ⇒ Object
Returns the value of attribute error_details.
96 97 98 |
# File 'lib/docusign_esign/models/list.rb', line 96 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.
99 100 101 |
# File 'lib/docusign_esign/models/list.rb', line 99 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.
102 103 104 |
# File 'lib/docusign_esign/models/list.rb', line 102 def font_color @font_color end |
#font_color_metadata ⇒ Object
Returns the value of attribute font_color_metadata.
104 105 106 |
# File 'lib/docusign_esign/models/list.rb', line 104 def @font_color_metadata end |
#font_metadata ⇒ Object
Returns the value of attribute font_metadata.
106 107 108 |
# File 'lib/docusign_esign/models/list.rb', line 106 def @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.
109 110 111 |
# File 'lib/docusign_esign/models/list.rb', line 109 def font_size @font_size end |
#font_size_metadata ⇒ Object
Returns the value of attribute font_size_metadata.
111 112 113 |
# File 'lib/docusign_esign/models/list.rb', line 111 def @font_size_metadata end |
#form_order ⇒ Object
Returns the value of attribute form_order.
114 115 116 |
# File 'lib/docusign_esign/models/list.rb', line 114 def form_order @form_order end |
#form_order_metadata ⇒ Object
Returns the value of attribute form_order_metadata.
116 117 118 |
# File 'lib/docusign_esign/models/list.rb', line 116 def @form_order_metadata end |
#form_page_label ⇒ Object
Returns the value of attribute form_page_label.
119 120 121 |
# File 'lib/docusign_esign/models/list.rb', line 119 def form_page_label @form_page_label end |
#form_page_label_metadata ⇒ Object
Returns the value of attribute form_page_label_metadata.
121 122 123 |
# File 'lib/docusign_esign/models/list.rb', line 121 def @form_page_label_metadata end |
#form_page_number ⇒ Object
Returns the value of attribute form_page_number.
124 125 126 |
# File 'lib/docusign_esign/models/list.rb', line 124 def form_page_number @form_page_number end |
#form_page_number_metadata ⇒ Object
Returns the value of attribute form_page_number_metadata.
126 127 128 |
# File 'lib/docusign_esign/models/list.rb', line 126 def @form_page_number_metadata end |
#height ⇒ Object
Height of the tab in pixels.
129 130 131 |
# File 'lib/docusign_esign/models/list.rb', line 129 def height @height end |
#height_metadata ⇒ Object
Returns the value of attribute height_metadata.
131 132 133 |
# File 'lib/docusign_esign/models/list.rb', line 131 def @height_metadata end |
#italic ⇒ Object
When set to true, the information in the tab is italic.
134 135 136 |
# File 'lib/docusign_esign/models/list.rb', line 134 def italic @italic end |
#italic_metadata ⇒ Object
Returns the value of attribute italic_metadata.
136 137 138 |
# File 'lib/docusign_esign/models/list.rb', line 136 def @italic_metadata end |
#list_items ⇒ Object
The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters.
139 140 141 |
# File 'lib/docusign_esign/models/list.rb', line 139 def list_items @list_items end |
#list_selected_value ⇒ Object
Returns the value of attribute list_selected_value.
142 143 144 |
# File 'lib/docusign_esign/models/list.rb', line 142 def list_selected_value @list_selected_value end |
#list_selected_value_metadata ⇒ Object
Returns the value of attribute list_selected_value_metadata.
144 145 146 |
# File 'lib/docusign_esign/models/list.rb', line 144 def @list_selected_value_metadata end |
#locale_policy ⇒ Object
Returns the value of attribute locale_policy.
146 147 148 |
# File 'lib/docusign_esign/models/list.rb', line 146 def locale_policy @locale_policy end |
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
149 150 151 |
# File 'lib/docusign_esign/models/list.rb', line 149 def locked @locked end |
#locked_metadata ⇒ Object
Returns the value of attribute locked_metadata.
151 152 153 |
# File 'lib/docusign_esign/models/list.rb', line 151 def @locked_metadata end |
#merge_field ⇒ Object
Returns the value of attribute merge_field.
153 154 155 |
# File 'lib/docusign_esign/models/list.rb', line 153 def merge_field @merge_field end |
#merge_field_xml ⇒ Object
Returns the value of attribute merge_field_xml.
156 157 158 |
# File 'lib/docusign_esign/models/list.rb', line 156 def merge_field_xml @merge_field_xml end |
#original_value ⇒ Object
The initial value of the tab when it was sent to the recipient.
159 160 161 |
# File 'lib/docusign_esign/models/list.rb', line 159 def original_value @original_value end |
#original_value_metadata ⇒ Object
Returns the value of attribute original_value_metadata.
161 162 163 |
# File 'lib/docusign_esign/models/list.rb', line 161 def @original_value_metadata end |
#page_number ⇒ Object
Specifies the page number on which the tab is located.
164 165 166 |
# File 'lib/docusign_esign/models/list.rb', line 164 def page_number @page_number end |
#page_number_metadata ⇒ Object
Returns the value of attribute page_number_metadata.
166 167 168 |
# File 'lib/docusign_esign/models/list.rb', line 166 def @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.
169 170 171 |
# File 'lib/docusign_esign/models/list.rb', line 169 def recipient_id @recipient_id end |
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
172 173 174 |
# File 'lib/docusign_esign/models/list.rb', line 172 def recipient_id_guid @recipient_id_guid end |
#recipient_id_guid_metadata ⇒ Object
Returns the value of attribute recipient_id_guid_metadata.
174 175 176 |
# File 'lib/docusign_esign/models/list.rb', line 174 def @recipient_id_guid_metadata end |
#recipient_id_metadata ⇒ Object
Returns the value of attribute recipient_id_metadata.
176 177 178 |
# File 'lib/docusign_esign/models/list.rb', line 176 def @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.
179 180 181 |
# File 'lib/docusign_esign/models/list.rb', line 179 def require_all @require_all end |
#require_all_metadata ⇒ Object
Returns the value of attribute require_all_metadata.
181 182 183 |
# File 'lib/docusign_esign/models/list.rb', line 181 def @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.
189 190 191 |
# File 'lib/docusign_esign/models/list.rb', line 189 def require_initial_on_shared_change @require_initial_on_shared_change end |
#require_initial_on_shared_change_metadata ⇒ Object
Returns the value of attribute require_initial_on_shared_change_metadata.
191 192 193 |
# File 'lib/docusign_esign/models/list.rb', line 191 def @require_initial_on_shared_change_metadata end |
#required ⇒ Object
When set to true, the signer is required to fill out this tab
184 185 186 |
# File 'lib/docusign_esign/models/list.rb', line 184 def required @required end |
#required_metadata ⇒ Object
Returns the value of attribute required_metadata.
186 187 188 |
# File 'lib/docusign_esign/models/list.rb', line 186 def @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.
194 195 196 |
# File 'lib/docusign_esign/models/list.rb', line 194 def sender_required @sender_required end |
#sender_required_metadata ⇒ Object
Returns the value of attribute sender_required_metadata.
196 197 198 |
# File 'lib/docusign_esign/models/list.rb', line 196 def @sender_required_metadata end |
#share_to_recipients ⇒ Object
Returns the value of attribute share_to_recipients.
204 205 206 |
# File 'lib/docusign_esign/models/list.rb', line 204 def share_to_recipients @share_to_recipients end |
#share_to_recipients_metadata ⇒ Object
Returns the value of attribute share_to_recipients_metadata.
206 207 208 |
# File 'lib/docusign_esign/models/list.rb', line 206 def @share_to_recipients_metadata end |
#shared ⇒ Object
When set to true, this custom tab is shared.
199 200 201 |
# File 'lib/docusign_esign/models/list.rb', line 199 def shared @shared end |
#shared_metadata ⇒ Object
Returns the value of attribute shared_metadata.
201 202 203 |
# File 'lib/docusign_esign/models/list.rb', line 201 def @shared_metadata end |
#smart_contract_information ⇒ Object
Returns the value of attribute smart_contract_information.
208 209 210 |
# File 'lib/docusign_esign/models/list.rb', line 208 def smart_contract_information @smart_contract_information end |
#source ⇒ Object
Returns the value of attribute source.
211 212 213 |
# File 'lib/docusign_esign/models/list.rb', line 211 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.
214 215 216 |
# File 'lib/docusign_esign/models/list.rb', line 214 def status @status end |
#status_metadata ⇒ Object
Returns the value of attribute status_metadata.
216 217 218 |
# File 'lib/docusign_esign/models/list.rb', line 216 def @status_metadata end |
#tab_group_labels ⇒ Object
Returns the value of attribute tab_group_labels.
219 220 221 |
# File 'lib/docusign_esign/models/list.rb', line 219 def tab_group_labels @tab_group_labels end |
#tab_group_labels_metadata ⇒ Object
Returns the value of attribute tab_group_labels_metadata.
221 222 223 |
# File 'lib/docusign_esign/models/list.rb', line 221 def @tab_group_labels_metadata end |
#tab_id ⇒ Object
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
224 225 226 |
# File 'lib/docusign_esign/models/list.rb', line 224 def tab_id @tab_id end |
#tab_id_metadata ⇒ Object
Returns the value of attribute tab_id_metadata.
226 227 228 |
# File 'lib/docusign_esign/models/list.rb', line 226 def @tab_id_metadata end |
#tab_label ⇒ Object
The label string associated with the tab.
229 230 231 |
# File 'lib/docusign_esign/models/list.rb', line 229 def tab_label @tab_label end |
#tab_label_metadata ⇒ Object
Returns the value of attribute tab_label_metadata.
231 232 233 |
# File 'lib/docusign_esign/models/list.rb', line 231 def @tab_label_metadata end |
#tab_order ⇒ Object
Returns the value of attribute tab_order.
234 235 236 |
# File 'lib/docusign_esign/models/list.rb', line 234 def tab_order @tab_order end |
#tab_order_metadata ⇒ Object
Returns the value of attribute tab_order_metadata.
236 237 238 |
# File 'lib/docusign_esign/models/list.rb', line 236 def @tab_order_metadata end |
#tab_type ⇒ Object
Returns the value of attribute tab_type.
239 240 241 |
# File 'lib/docusign_esign/models/list.rb', line 239 def tab_type @tab_type end |
#tab_type_metadata ⇒ Object
Returns the value of attribute tab_type_metadata.
241 242 243 |
# File 'lib/docusign_esign/models/list.rb', line 241 def @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.
244 245 246 |
# File 'lib/docusign_esign/models/list.rb', line 244 def template_locked @template_locked end |
#template_locked_metadata ⇒ Object
Returns the value of attribute template_locked_metadata.
246 247 248 |
# File 'lib/docusign_esign/models/list.rb', line 246 def @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.
249 250 251 |
# File 'lib/docusign_esign/models/list.rb', line 249 def template_required @template_required end |
#template_required_metadata ⇒ Object
Returns the value of attribute template_required_metadata.
251 252 253 |
# File 'lib/docusign_esign/models/list.rb', line 251 def @template_required_metadata end |
#tool_tip_metadata ⇒ Object
Returns the value of attribute tool_tip_metadata.
256 257 258 |
# File 'lib/docusign_esign/models/list.rb', line 256 def @tool_tip_metadata end |
#tooltip ⇒ Object
Returns the value of attribute tooltip.
254 255 256 |
# File 'lib/docusign_esign/models/list.rb', line 254 def tooltip @tooltip end |
#underline ⇒ Object
When set to true, the information in the tab is underlined.
259 260 261 |
# File 'lib/docusign_esign/models/list.rb', line 259 def underline @underline end |
#underline_metadata ⇒ Object
Returns the value of attribute underline_metadata.
261 262 263 |
# File 'lib/docusign_esign/models/list.rb', line 261 def @underline_metadata end |
#value ⇒ Object
The value to use when the item is selected.
264 265 266 |
# File 'lib/docusign_esign/models/list.rb', line 264 def value @value end |
#value_metadata ⇒ Object
Returns the value of attribute value_metadata.
266 267 268 |
# File 'lib/docusign_esign/models/list.rb', line 266 def @value_metadata end |
#width ⇒ Object
Width of the tab in pixels.
269 270 271 |
# File 'lib/docusign_esign/models/list.rb', line 269 def width @width end |
#width_metadata ⇒ Object
Returns the value of attribute width_metadata.
271 272 273 |
# File 'lib/docusign_esign/models/list.rb', line 271 def @width_metadata end |
#x_position ⇒ Object
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.
274 275 276 |
# File 'lib/docusign_esign/models/list.rb', line 274 def x_position @x_position end |
#x_position_metadata ⇒ Object
Returns the value of attribute x_position_metadata.
276 277 278 |
# File 'lib/docusign_esign/models/list.rb', line 276 def @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.
279 280 281 |
# File 'lib/docusign_esign/models/list.rb', line 279 def y_position @y_position end |
#y_position_metadata ⇒ Object
Returns the value of attribute y_position_metadata.
281 282 283 |
# File 'lib/docusign_esign/models/list.rb', line 281 def @y_position_metadata end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 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 387 388 389 390 391 392 393 394 |
# File 'lib/docusign_esign/models/list.rb', line 284 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', :'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', :'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', :'list_items' => :'listItems', :'list_selected_value' => :'listSelectedValue', :'list_selected_value_metadata' => :'listSelectedValueMetadata', :'locale_policy' => :'localePolicy', :'locked' => :'locked', :'locked_metadata' => :'lockedMetadata', :'merge_field' => :'mergeField', :'merge_field_xml' => :'mergeFieldXml', :'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', :'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.
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 |
# File 'lib/docusign_esign/models/list.rb', line 397 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', :'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', :'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', :'list_items' => :'Array<ListItem>', :'list_selected_value' => :'String', :'list_selected_value_metadata' => :'PropertyMetadata', :'locale_policy' => :'LocalePolicyTab', :'locked' => :'String', :'locked_metadata' => :'PropertyMetadata', :'merge_field' => :'MergeField', :'merge_field_xml' => :'String', :'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', :'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.
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 |
# File 'lib/docusign_esign/models/list.rb', line 965 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. && bold == o.bold && == o. && == o. && == 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 && font == o.font && font_color == o.font_color && == o. && == o. && font_size == o.font_size && == o. && form_order == o.form_order && == o. && form_page_label == o.form_page_label && == o. && form_page_number == o.form_page_number && == o. && height == o.height && == o. && italic == o.italic && == o. && list_items == o.list_items && list_selected_value == o.list_selected_value && == o. && locale_policy == o.locale_policy && locked == o.locked && == o. && merge_field == o.merge_field && merge_field_xml == o.merge_field_xml && original_value == o.original_value && == o. && page_number == o.page_number && == o. && recipient_id == o.recipient_id && recipient_id_guid == o.recipient_id_guid && == o. && == o. && require_all == o.require_all && == o. && required == o.required && == o. && require_initial_on_shared_change == o.require_initial_on_shared_change && == o. && sender_required == o.sender_required && == o. && shared == o.shared && == o. && share_to_recipients == o.share_to_recipients && == o. && smart_contract_information == o.smart_contract_information && source == o.source && status == o.status && == o. && tab_group_labels == o.tab_group_labels && == o. && tab_id == o.tab_id && == o. && tab_label == o.tab_label && == o. && tab_order == o.tab_order && == o. && tab_type == o.tab_type && == o. && template_locked == o.template_locked && == o. && template_required == o.template_required && == o. && tooltip == o.tooltip && == o. && underline == o.underline && == o. && value == o.value && == 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
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 |
# File 'lib/docusign_esign/models/list.rb', line 1113 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
1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 |
# File 'lib/docusign_esign/models/list.rb', line 1179 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
1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 |
# File 'lib/docusign_esign/models/list.rb', line 1092 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
1079 1080 1081 |
# File 'lib/docusign_esign/models/list.rb', line 1079 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
1085 1086 1087 |
# File 'lib/docusign_esign/models/list.rb', line 1085 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, , bold, , , , conditional_parent_label, , conditional_parent_value, , custom_tab_id, , document_id, , error_details, font, font_color, , , font_size, , form_order, , form_page_label, , form_page_number, , height, , italic, , list_items, list_selected_value, , locale_policy, locked, , merge_field, merge_field_xml, original_value, , page_number, , recipient_id, recipient_id_guid, , , require_all, , required, , require_initial_on_shared_change, , sender_required, , shared, , share_to_recipients, , smart_contract_information, source, status, , tab_group_labels, , tab_id, , tab_label, , tab_order, , tab_type, , template_locked, , template_required, , tooltip, , underline, , value, , width, , x_position, , y_position, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
952 953 954 955 |
# File 'lib/docusign_esign/models/list.rb', line 952 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
1159 1160 1161 |
# File 'lib/docusign_esign/models/list.rb', line 1159 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
1165 1166 1167 1168 1169 1170 1171 1172 1173 |
# File 'lib/docusign_esign/models/list.rb', line 1165 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
1153 1154 1155 |
# File 'lib/docusign_esign/models/list.rb', line 1153 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
959 960 961 |
# File 'lib/docusign_esign/models/list.rb', line 959 def valid? true end |