Class: DocuSign_eSign::Company
- Inherits:
-
Object
- Object
- DocuSign_eSign::Company
- Defined in:
- lib/docusign_esign/models/company.rb
Instance Attribute Summary collapse
-
#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.
-
#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.
-
#conceal_value_on_document_metadata ⇒ Object
Returns the value of attribute conceal_value_on_document_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.
-
#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.
-
#disable_auto_size_metadata ⇒ Object
Returns the value of attribute disable_auto_size_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.
-
#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.
-
#max_length ⇒ Object
An optional value that describes the maximum length of the property when the property is a string.
-
#max_length_metadata ⇒ Object
Returns the value of attribute max_length_metadata.
-
#merge_field ⇒ Object
Returns the value of attribute merge_field.
-
#merge_field_xml ⇒ Object
Returns the value of attribute merge_field_xml.
-
#name ⇒ Object
Specifies the tool tip text for the tab.
-
#name_metadata ⇒ Object
Returns the value of attribute name_metadata.
-
#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.
-
#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.
-
#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
Specifies the value of the tab.
-
#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 = {}) ⇒ Company
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 = {}) ⇒ Company
Initializes the object
463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 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 |
# File 'lib/docusign_esign/models/company.rb', line 463 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?(:'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?(:'concealValueOnDocument') self.conceal_value_on_document = attributes[:'concealValueOnDocument'] end if attributes.has_key?(:'concealValueOnDocumentMetadata') self. = attributes[:'concealValueOnDocumentMetadata'] 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?(:'disableAutoSize') self.disable_auto_size = attributes[:'disableAutoSize'] end if attributes.has_key?(:'disableAutoSizeMetadata') self. = attributes[:'disableAutoSizeMetadata'] 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?(:'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?(:'maxLength') self.max_length = attributes[:'maxLength'] end if attributes.has_key?(:'maxLengthMetadata') self. = 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. = attributes[:'nameMetadata'] 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?(:'required') self.required = attributes[:'required'] end if attributes.has_key?(:'requiredMetadata') self. = attributes[:'requiredMetadata'] 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_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.
18 19 20 |
# File 'lib/docusign_esign/models/company.rb', line 18 def anchor_case_sensitive @anchor_case_sensitive end |
#anchor_case_sensitive_metadata ⇒ Object
Returns the value of attribute anchor_case_sensitive_metadata.
20 21 22 |
# File 'lib/docusign_esign/models/company.rb', line 20 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.
23 24 25 |
# File 'lib/docusign_esign/models/company.rb', line 23 def anchor_horizontal_alignment @anchor_horizontal_alignment end |
#anchor_horizontal_alignment_metadata ⇒ Object
Returns the value of attribute anchor_horizontal_alignment_metadata.
25 26 27 |
# File 'lib/docusign_esign/models/company.rb', line 25 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.
28 29 30 |
# File 'lib/docusign_esign/models/company.rb', line 28 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.
30 31 32 |
# File 'lib/docusign_esign/models/company.rb', line 30 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.
33 34 35 |
# File 'lib/docusign_esign/models/company.rb', line 33 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.
35 36 37 |
# File 'lib/docusign_esign/models/company.rb', line 35 def @anchor_match_whole_word_metadata end |
#anchor_string ⇒ Object
Anchor text information for a radio button.
38 39 40 |
# File 'lib/docusign_esign/models/company.rb', line 38 def anchor_string @anchor_string end |
#anchor_string_metadata ⇒ Object
Returns the value of attribute anchor_string_metadata.
40 41 42 |
# File 'lib/docusign_esign/models/company.rb', line 40 def @anchor_string_metadata end |
#anchor_tab_processor_version ⇒ Object
Returns the value of attribute anchor_tab_processor_version.
43 44 45 |
# File 'lib/docusign_esign/models/company.rb', line 43 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.
45 46 47 |
# File 'lib/docusign_esign/models/company.rb', line 45 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.
48 49 50 |
# File 'lib/docusign_esign/models/company.rb', line 48 def anchor_units @anchor_units end |
#anchor_units_metadata ⇒ Object
Returns the value of attribute anchor_units_metadata.
50 51 52 |
# File 'lib/docusign_esign/models/company.rb', line 50 def @anchor_units_metadata end |
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
53 54 55 |
# File 'lib/docusign_esign/models/company.rb', line 53 def anchor_x_offset @anchor_x_offset end |
#anchor_x_offset_metadata ⇒ Object
Returns the value of attribute anchor_x_offset_metadata.
55 56 57 |
# File 'lib/docusign_esign/models/company.rb', line 55 def @anchor_x_offset_metadata end |
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
58 59 60 |
# File 'lib/docusign_esign/models/company.rb', line 58 def anchor_y_offset @anchor_y_offset end |
#anchor_y_offset_metadata ⇒ Object
Returns the value of attribute anchor_y_offset_metadata.
60 61 62 |
# File 'lib/docusign_esign/models/company.rb', line 60 def @anchor_y_offset_metadata end |
#bold ⇒ Object
When set to true, the information in the tab is bold.
63 64 65 |
# File 'lib/docusign_esign/models/company.rb', line 63 def bold @bold end |
#bold_metadata ⇒ Object
Returns the value of attribute bold_metadata.
65 66 67 |
# File 'lib/docusign_esign/models/company.rb', line 65 def @bold_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.
68 69 70 |
# File 'lib/docusign_esign/models/company.rb', line 68 def conceal_value_on_document @conceal_value_on_document end |
#conceal_value_on_document_metadata ⇒ Object
Returns the value of attribute conceal_value_on_document_metadata.
70 71 72 |
# File 'lib/docusign_esign/models/company.rb', line 70 def @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.
73 74 75 |
# File 'lib/docusign_esign/models/company.rb', line 73 def conditional_parent_label @conditional_parent_label end |
#conditional_parent_label_metadata ⇒ Object
Returns the value of attribute conditional_parent_label_metadata.
75 76 77 |
# File 'lib/docusign_esign/models/company.rb', line 75 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.
78 79 80 |
# File 'lib/docusign_esign/models/company.rb', line 78 def conditional_parent_value @conditional_parent_value end |
#conditional_parent_value_metadata ⇒ Object
Returns the value of attribute conditional_parent_value_metadata.
80 81 82 |
# File 'lib/docusign_esign/models/company.rb', line 80 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.
83 84 85 |
# File 'lib/docusign_esign/models/company.rb', line 83 def custom_tab_id @custom_tab_id end |
#custom_tab_id_metadata ⇒ Object
Returns the value of attribute custom_tab_id_metadata.
85 86 87 |
# File 'lib/docusign_esign/models/company.rb', line 85 def @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.
88 89 90 |
# File 'lib/docusign_esign/models/company.rb', line 88 def disable_auto_size @disable_auto_size end |
#disable_auto_size_metadata ⇒ Object
Returns the value of attribute disable_auto_size_metadata.
90 91 92 |
# File 'lib/docusign_esign/models/company.rb', line 90 def @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.
93 94 95 |
# File 'lib/docusign_esign/models/company.rb', line 93 def document_id @document_id end |
#document_id_metadata ⇒ Object
Returns the value of attribute document_id_metadata.
95 96 97 |
# File 'lib/docusign_esign/models/company.rb', line 95 def @document_id_metadata end |
#error_details ⇒ Object
Returns the value of attribute error_details.
97 98 99 |
# File 'lib/docusign_esign/models/company.rb', line 97 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.
100 101 102 |
# File 'lib/docusign_esign/models/company.rb', line 100 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.
103 104 105 |
# File 'lib/docusign_esign/models/company.rb', line 103 def font_color @font_color end |
#font_color_metadata ⇒ Object
Returns the value of attribute font_color_metadata.
105 106 107 |
# File 'lib/docusign_esign/models/company.rb', line 105 def @font_color_metadata end |
#font_metadata ⇒ Object
Returns the value of attribute font_metadata.
107 108 109 |
# File 'lib/docusign_esign/models/company.rb', line 107 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.
110 111 112 |
# File 'lib/docusign_esign/models/company.rb', line 110 def font_size @font_size end |
#font_size_metadata ⇒ Object
Returns the value of attribute font_size_metadata.
112 113 114 |
# File 'lib/docusign_esign/models/company.rb', line 112 def @font_size_metadata end |
#form_order ⇒ Object
Returns the value of attribute form_order.
115 116 117 |
# File 'lib/docusign_esign/models/company.rb', line 115 def form_order @form_order end |
#form_order_metadata ⇒ Object
Returns the value of attribute form_order_metadata.
117 118 119 |
# File 'lib/docusign_esign/models/company.rb', line 117 def @form_order_metadata end |
#form_page_label ⇒ Object
Returns the value of attribute form_page_label.
120 121 122 |
# File 'lib/docusign_esign/models/company.rb', line 120 def form_page_label @form_page_label end |
#form_page_label_metadata ⇒ Object
Returns the value of attribute form_page_label_metadata.
122 123 124 |
# File 'lib/docusign_esign/models/company.rb', line 122 def @form_page_label_metadata end |
#form_page_number ⇒ Object
Returns the value of attribute form_page_number.
125 126 127 |
# File 'lib/docusign_esign/models/company.rb', line 125 def form_page_number @form_page_number end |
#form_page_number_metadata ⇒ Object
Returns the value of attribute form_page_number_metadata.
127 128 129 |
# File 'lib/docusign_esign/models/company.rb', line 127 def @form_page_number_metadata end |
#height ⇒ Object
Height of the tab in pixels.
130 131 132 |
# File 'lib/docusign_esign/models/company.rb', line 130 def height @height end |
#height_metadata ⇒ Object
Returns the value of attribute height_metadata.
132 133 134 |
# File 'lib/docusign_esign/models/company.rb', line 132 def @height_metadata end |
#italic ⇒ Object
When set to true, the information in the tab is italic.
135 136 137 |
# File 'lib/docusign_esign/models/company.rb', line 135 def italic @italic end |
#italic_metadata ⇒ Object
Returns the value of attribute italic_metadata.
137 138 139 |
# File 'lib/docusign_esign/models/company.rb', line 137 def @italic_metadata end |
#locale_policy ⇒ Object
Returns the value of attribute locale_policy.
139 140 141 |
# File 'lib/docusign_esign/models/company.rb', line 139 def locale_policy @locale_policy end |
#locked ⇒ Object
When set to true, the signer cannot change the data of the custom tab.
142 143 144 |
# File 'lib/docusign_esign/models/company.rb', line 142 def locked @locked end |
#locked_metadata ⇒ Object
Returns the value of attribute locked_metadata.
144 145 146 |
# File 'lib/docusign_esign/models/company.rb', line 144 def @locked_metadata end |
#max_length ⇒ Object
An optional value that describes the maximum length of the property when the property is a string.
147 148 149 |
# File 'lib/docusign_esign/models/company.rb', line 147 def max_length @max_length end |
#max_length_metadata ⇒ Object
Returns the value of attribute max_length_metadata.
149 150 151 |
# File 'lib/docusign_esign/models/company.rb', line 149 def @max_length_metadata end |
#merge_field ⇒ Object
Returns the value of attribute merge_field.
151 152 153 |
# File 'lib/docusign_esign/models/company.rb', line 151 def merge_field @merge_field end |
#merge_field_xml ⇒ Object
Returns the value of attribute merge_field_xml.
154 155 156 |
# File 'lib/docusign_esign/models/company.rb', line 154 def merge_field_xml @merge_field_xml end |
#name ⇒ Object
Specifies the tool tip text for the tab.
157 158 159 |
# File 'lib/docusign_esign/models/company.rb', line 157 def name @name end |
#name_metadata ⇒ Object
Returns the value of attribute name_metadata.
159 160 161 |
# File 'lib/docusign_esign/models/company.rb', line 159 def @name_metadata end |
#original_value ⇒ Object
The initial value of the tab when it was sent to the recipient.
162 163 164 |
# File 'lib/docusign_esign/models/company.rb', line 162 def original_value @original_value end |
#original_value_metadata ⇒ Object
Returns the value of attribute original_value_metadata.
164 165 166 |
# File 'lib/docusign_esign/models/company.rb', line 164 def @original_value_metadata end |
#page_number ⇒ Object
Specifies the page number on which the tab is located.
167 168 169 |
# File 'lib/docusign_esign/models/company.rb', line 167 def page_number @page_number end |
#page_number_metadata ⇒ Object
Returns the value of attribute page_number_metadata.
169 170 171 |
# File 'lib/docusign_esign/models/company.rb', line 169 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.
172 173 174 |
# File 'lib/docusign_esign/models/company.rb', line 172 def recipient_id @recipient_id end |
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
175 176 177 |
# File 'lib/docusign_esign/models/company.rb', line 175 def recipient_id_guid @recipient_id_guid end |
#recipient_id_guid_metadata ⇒ Object
Returns the value of attribute recipient_id_guid_metadata.
177 178 179 |
# File 'lib/docusign_esign/models/company.rb', line 177 def @recipient_id_guid_metadata end |
#recipient_id_metadata ⇒ Object
Returns the value of attribute recipient_id_metadata.
179 180 181 |
# File 'lib/docusign_esign/models/company.rb', line 179 def @recipient_id_metadata end |
#required ⇒ Object
When set to true, the signer is required to fill out this tab
182 183 184 |
# File 'lib/docusign_esign/models/company.rb', line 182 def required @required end |
#required_metadata ⇒ Object
Returns the value of attribute required_metadata.
184 185 186 |
# File 'lib/docusign_esign/models/company.rb', line 184 def @required_metadata 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.
187 188 189 |
# File 'lib/docusign_esign/models/company.rb', line 187 def status @status end |
#status_metadata ⇒ Object
Returns the value of attribute status_metadata.
189 190 191 |
# File 'lib/docusign_esign/models/company.rb', line 189 def @status_metadata end |
#tab_group_labels ⇒ Object
Returns the value of attribute tab_group_labels.
192 193 194 |
# File 'lib/docusign_esign/models/company.rb', line 192 def tab_group_labels @tab_group_labels end |
#tab_group_labels_metadata ⇒ Object
Returns the value of attribute tab_group_labels_metadata.
194 195 196 |
# File 'lib/docusign_esign/models/company.rb', line 194 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].
197 198 199 |
# File 'lib/docusign_esign/models/company.rb', line 197 def tab_id @tab_id end |
#tab_id_metadata ⇒ Object
Returns the value of attribute tab_id_metadata.
199 200 201 |
# File 'lib/docusign_esign/models/company.rb', line 199 def @tab_id_metadata end |
#tab_label ⇒ Object
The label string associated with the tab.
202 203 204 |
# File 'lib/docusign_esign/models/company.rb', line 202 def tab_label @tab_label end |
#tab_label_metadata ⇒ Object
Returns the value of attribute tab_label_metadata.
204 205 206 |
# File 'lib/docusign_esign/models/company.rb', line 204 def @tab_label_metadata end |
#tab_order ⇒ Object
Returns the value of attribute tab_order.
207 208 209 |
# File 'lib/docusign_esign/models/company.rb', line 207 def tab_order @tab_order end |
#tab_order_metadata ⇒ Object
Returns the value of attribute tab_order_metadata.
209 210 211 |
# File 'lib/docusign_esign/models/company.rb', line 209 def @tab_order_metadata end |
#tab_type ⇒ Object
Returns the value of attribute tab_type.
212 213 214 |
# File 'lib/docusign_esign/models/company.rb', line 212 def tab_type @tab_type end |
#tab_type_metadata ⇒ Object
Returns the value of attribute tab_type_metadata.
214 215 216 |
# File 'lib/docusign_esign/models/company.rb', line 214 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.
217 218 219 |
# File 'lib/docusign_esign/models/company.rb', line 217 def template_locked @template_locked end |
#template_locked_metadata ⇒ Object
Returns the value of attribute template_locked_metadata.
219 220 221 |
# File 'lib/docusign_esign/models/company.rb', line 219 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.
222 223 224 |
# File 'lib/docusign_esign/models/company.rb', line 222 def template_required @template_required end |
#template_required_metadata ⇒ Object
Returns the value of attribute template_required_metadata.
224 225 226 |
# File 'lib/docusign_esign/models/company.rb', line 224 def @template_required_metadata end |
#tool_tip_metadata ⇒ Object
Returns the value of attribute tool_tip_metadata.
229 230 231 |
# File 'lib/docusign_esign/models/company.rb', line 229 def @tool_tip_metadata end |
#tooltip ⇒ Object
Returns the value of attribute tooltip.
227 228 229 |
# File 'lib/docusign_esign/models/company.rb', line 227 def tooltip @tooltip end |
#underline ⇒ Object
When set to true, the information in the tab is underlined.
232 233 234 |
# File 'lib/docusign_esign/models/company.rb', line 232 def underline @underline end |
#underline_metadata ⇒ Object
Returns the value of attribute underline_metadata.
234 235 236 |
# File 'lib/docusign_esign/models/company.rb', line 234 def @underline_metadata end |
#value ⇒ Object
Specifies the value of the tab.
237 238 239 |
# File 'lib/docusign_esign/models/company.rb', line 237 def value @value end |
#value_metadata ⇒ Object
Returns the value of attribute value_metadata.
239 240 241 |
# File 'lib/docusign_esign/models/company.rb', line 239 def @value_metadata end |
#width ⇒ Object
Width of the tab in pixels.
242 243 244 |
# File 'lib/docusign_esign/models/company.rb', line 242 def width @width end |
#width_metadata ⇒ Object
Returns the value of attribute width_metadata.
244 245 246 |
# File 'lib/docusign_esign/models/company.rb', line 244 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.
247 248 249 |
# File 'lib/docusign_esign/models/company.rb', line 247 def x_position @x_position end |
#x_position_metadata ⇒ Object
Returns the value of attribute x_position_metadata.
249 250 251 |
# File 'lib/docusign_esign/models/company.rb', line 249 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.
252 253 254 |
# File 'lib/docusign_esign/models/company.rb', line 252 def y_position @y_position end |
#y_position_metadata ⇒ Object
Returns the value of attribute y_position_metadata.
254 255 256 |
# File 'lib/docusign_esign/models/company.rb', line 254 def @y_position_metadata end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 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 |
# File 'lib/docusign_esign/models/company.rb', line 258 def self.attribute_map { :'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', :'conceal_value_on_document' => :'concealValueOnDocument', :'conceal_value_on_document_metadata' => :'concealValueOnDocumentMetadata', :'conditional_parent_label' => :'conditionalParentLabel', :'conditional_parent_label_metadata' => :'conditionalParentLabelMetadata', :'conditional_parent_value' => :'conditionalParentValue', :'conditional_parent_value_metadata' => :'conditionalParentValueMetadata', :'custom_tab_id' => :'customTabId', :'custom_tab_id_metadata' => :'customTabIdMetadata', :'disable_auto_size' => :'disableAutoSize', :'disable_auto_size_metadata' => :'disableAutoSizeMetadata', :'document_id' => :'documentId', :'document_id_metadata' => :'documentIdMetadata', :'error_details' => :'errorDetails', :'font' => :'font', :'font_color' => :'fontColor', :'font_color_metadata' => :'fontColorMetadata', :'font_metadata' => :'fontMetadata', :'font_size' => :'fontSize', :'font_size_metadata' => :'fontSizeMetadata', :'form_order' => :'formOrder', :'form_order_metadata' => :'formOrderMetadata', :'form_page_label' => :'formPageLabel', :'form_page_label_metadata' => :'formPageLabelMetadata', :'form_page_number' => :'formPageNumber', :'form_page_number_metadata' => :'formPageNumberMetadata', :'height' => :'height', :'height_metadata' => :'heightMetadata', :'italic' => :'italic', :'italic_metadata' => :'italicMetadata', :'locale_policy' => :'localePolicy', :'locked' => :'locked', :'locked_metadata' => :'lockedMetadata', :'max_length' => :'maxLength', :'max_length_metadata' => :'maxLengthMetadata', :'merge_field' => :'mergeField', :'merge_field_xml' => :'mergeFieldXml', :'name' => :'name', :'name_metadata' => :'nameMetadata', :'original_value' => :'originalValue', :'original_value_metadata' => :'originalValueMetadata', :'page_number' => :'pageNumber', :'page_number_metadata' => :'pageNumberMetadata', :'recipient_id' => :'recipientId', :'recipient_id_guid' => :'recipientIdGuid', :'recipient_id_guid_metadata' => :'recipientIdGuidMetadata', :'recipient_id_metadata' => :'recipientIdMetadata', :'required' => :'required', :'required_metadata' => :'requiredMetadata', :'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.
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 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 |
# File 'lib/docusign_esign/models/company.rb', line 360 def self.swagger_types { :'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', :'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', :'required' => :'String', :'required_metadata' => :'PropertyMetadata', :'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.
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 |
# File 'lib/docusign_esign/models/company.rb', line 872 def ==(o) return true if self.equal?(o) self.class == o.class && 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. && conceal_value_on_document == o.conceal_value_on_document && == 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. && disable_auto_size == o.disable_auto_size && == 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. && locale_policy == o.locale_policy && locked == o.locked && == o. && max_length == o.max_length && == o. && merge_field == o.merge_field && merge_field_xml == o.merge_field_xml && name == o.name && == o. && 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. && required == o.required && == o. && 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
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 |
# File 'lib/docusign_esign/models/company.rb', line 1009 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
1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 |
# File 'lib/docusign_esign/models/company.rb', line 1075 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
988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 |
# File 'lib/docusign_esign/models/company.rb', line 988 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 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
975 976 977 |
# File 'lib/docusign_esign/models/company.rb', line 975 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
981 982 983 |
# File 'lib/docusign_esign/models/company.rb', line 981 def hash [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, , conceal_value_on_document, , conditional_parent_label, , conditional_parent_value, , custom_tab_id, , disable_auto_size, , document_id, , error_details, font, font_color, , , font_size, , form_order, , form_page_label, , form_page_number, , height, , italic, , locale_policy, locked, , max_length, , merge_field, merge_field_xml, name, , original_value, , page_number, , recipient_id, recipient_id_guid, , , required, , 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?
859 860 861 862 |
# File 'lib/docusign_esign/models/company.rb', line 859 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
1055 1056 1057 |
# File 'lib/docusign_esign/models/company.rb', line 1055 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
1061 1062 1063 1064 1065 1066 1067 1068 1069 |
# File 'lib/docusign_esign/models/company.rb', line 1061 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
1049 1050 1051 |
# File 'lib/docusign_esign/models/company.rb', line 1049 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
866 867 868 |
# File 'lib/docusign_esign/models/company.rb', line 866 def valid? return true end |