Class: DocuSign_eSign::InitialHere
- Inherits:
-
Object
- Object
- DocuSign_eSign::InitialHere
- Defined in:
- lib/docusign_esign/models/initial_here.rb
Overview
A tab that allows the recipient to initial the document. May be optional.
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
Metadata that indicates whether the ‘anchorAllowWhiteSpaceInCharacters` property is editable.
-
#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
Metadata that indicates whether the ‘anchorCaseSensitive` property is editable.
-
#anchor_horizontal_alignment ⇒ Object
Specifies the alignment of anchor tabs with anchor strings.
-
#anchor_horizontal_alignment_metadata ⇒ Object
Metadata that indicates whether the ‘anchorHorizontalAlignment` property is editable.
-
#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
Metadata that indicates whether the ‘anchorIgnoreIfNotPresent` property is editable.
-
#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
Metadata that indicates whether the ‘anchorMatchWholeWord` property is editable.
-
#anchor_string ⇒ Object
Anchor text information for a radio button.
-
#anchor_string_metadata ⇒ Object
Metadata that indicates whether the ‘anchorString` property is editable.
-
#anchor_tab_processor_version ⇒ Object
Returns the value of attribute anchor_tab_processor_version.
-
#anchor_tab_processor_version_metadata ⇒ Object
Reserved for DocuSign.
-
#anchor_units ⇒ Object
Specifies units of the X and Y offset.
-
#anchor_units_metadata ⇒ Object
Metadata that indicates whether the ‘anchorUnits` property is editable.
-
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
-
#anchor_x_offset_metadata ⇒ Object
Metadata that indicates whether the ‘anchorXOffset` property is editable.
-
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
-
#anchor_y_offset_metadata ⇒ Object
Metadata that indicates whether the ‘anchorYOffset` property is editable.
-
#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
Metadata that indicates whether the ‘conditionalParentLabel` property is editable.
-
#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
Metadata that indicates whether the ‘conditionalParentValue` property is editable.
-
#custom_tab_id ⇒ Object
The DocuSign generated custom tab ID for the custom tab to be applied.
-
#custom_tab_id_metadata ⇒ Object
Metadata that indicates whether the ‘customTabId` property is editable.
-
#document_id ⇒ Object
Specifies the document ID number that the tab is placed on.
-
#document_id_metadata ⇒ Object
Metadata that indicates whether the ‘documentId` property is editable.
-
#error_details ⇒ Object
This object describes errors that occur.
-
#form_order ⇒ Object
Returns the value of attribute form_order.
-
#form_order_metadata ⇒ Object
Metadata that indicates whether the ‘formOrder` property is editable.
-
#form_page_label ⇒ Object
Returns the value of attribute form_page_label.
-
#form_page_label_metadata ⇒ Object
Metadata that indicates whether the ‘formPageLabel` property is editable.
-
#form_page_number ⇒ Object
Returns the value of attribute form_page_number.
-
#form_page_number_metadata ⇒ Object
Metadata that indicates whether the ‘fromPageNumber` property is editable.
-
#hand_draw_required ⇒ Object
Returns the value of attribute hand_draw_required.
-
#height ⇒ Object
Height of the tab in pixels.
-
#height_metadata ⇒ Object
Metadata that indicates whether the ‘height` property is editable.
-
#merge_field ⇒ Object
Contains the information necessary to map the tab to a field in SalesForce.
-
#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
Metadata that indicates whether the ‘name` property is editable.
-
#optional ⇒ Object
Returns the value of attribute optional.
-
#optional_metadata ⇒ Object
Metadata that indicates whether the ‘optional` property is editable.
-
#page_number ⇒ Object
Specifies the page number on which the tab is located.
-
#page_number_metadata ⇒ Object
Metadata that indicates whether the ‘pageNumber` property is editable.
-
#recipient_id ⇒ Object
Unique for the recipient.
-
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
-
#recipient_id_guid_metadata ⇒ Object
Metadata that indicates whether the ‘recipientIdGuid` property is editable.
-
#recipient_id_metadata ⇒ Object
Metadata that indicates whether the ‘recipientId` property is editable.
-
#scale_value ⇒ Object
Sets the size for the InitialHere tab.
-
#scale_value_metadata ⇒ Object
Metadata that indicates whether the ‘scaleValue` property is editable.
-
#smart_contract_information ⇒ Object
Reserved for DocuSign.
-
#source ⇒ Object
Returns the value of attribute source.
-
#status ⇒ Object
Indicates the envelope status.
-
#status_metadata ⇒ Object
Metadata that indicates whether the ‘status` property is editable.
-
#tab_group_labels ⇒ Object
Returns the value of attribute tab_group_labels.
-
#tab_group_labels_metadata ⇒ Object
Metadata that indicates whether the ‘tabGroupLabels` property is editable.
-
#tab_id ⇒ Object
The unique identifier for the tab.
-
#tab_id_metadata ⇒ Object
Metadata that indicates whether the ‘tabId` property is editable.
-
#tab_label ⇒ Object
The label string associated with the tab.
-
#tab_label_metadata ⇒ Object
Metadata that indicates whether the ‘tabLabel` property is editable.
-
#tab_order ⇒ Object
Returns the value of attribute tab_order.
-
#tab_order_metadata ⇒ Object
Metadata that indicates whether the ‘tabOrder` property is editable.
-
#tab_type ⇒ Object
Returns the value of attribute tab_type.
-
#tab_type_metadata ⇒ Object
Metadata that indicates whether the ‘tabType` property is editable.
-
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient.
-
#template_locked_metadata ⇒ Object
Metadata that indicates whether the ‘templateLocked` property is editable.
-
#template_required ⇒ Object
When set to true, the sender may not remove the recipient.
-
#template_required_metadata ⇒ Object
Metadata that indicates whether the ‘templateRequired` property is editable.
-
#tool_tip_metadata ⇒ Object
Metadata that indicates whether the ‘toolTip` property is editable.
-
#tooltip ⇒ Object
Returns the value of attribute tooltip.
-
#width ⇒ Object
Width of the tab in pixels.
-
#width_metadata ⇒ Object
Metadata that indicates whether the ‘width` property is editable.
-
#x_position ⇒ Object
This indicates the horizontal offset of the object on the page.
-
#x_position_metadata ⇒ Object
Metadata that indicates whether the ‘xPosition` property is editable.
-
#y_position ⇒ Object
This indicates the vertical offset of the object on the page.
-
#y_position_metadata ⇒ Object
Metadata that indicates whether the ‘yPosition` property is editable.
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 = {}) ⇒ InitialHere
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 = {}) ⇒ InitialHere
Initializes the object
430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 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 |
# File 'lib/docusign_esign/models/initial_here.rb', line 430 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?(:'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?(:'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?(:'handDrawRequired') self.hand_draw_required = attributes[:'handDrawRequired'] end if attributes.has_key?(:'height') self.height = attributes[:'height'] end if attributes.has_key?(:'heightMetadata') self. = attributes[:'heightMetadata'] 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?(:'optional') self.optional = attributes[:'optional'] end if attributes.has_key?(:'optionalMetadata') self. = attributes[:'optionalMetadata'] 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?(:'scaleValue') self.scale_value = attributes[:'scaleValue'] end if attributes.has_key?(:'scaleValueMetadata') self. = attributes[:'scaleValueMetadata'] 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?(:'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.
18 19 20 |
# File 'lib/docusign_esign/models/initial_here.rb', line 18 def anchor_allow_white_space_in_characters @anchor_allow_white_space_in_characters end |
#anchor_allow_white_space_in_characters_metadata ⇒ Object
Metadata that indicates whether the ‘anchorAllowWhiteSpaceInCharacters` property is editable.
21 22 23 |
# File 'lib/docusign_esign/models/initial_here.rb', line 21 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.
24 25 26 |
# File 'lib/docusign_esign/models/initial_here.rb', line 24 def anchor_case_sensitive @anchor_case_sensitive end |
#anchor_case_sensitive_metadata ⇒ Object
Metadata that indicates whether the ‘anchorCaseSensitive` property is editable.
27 28 29 |
# File 'lib/docusign_esign/models/initial_here.rb', line 27 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.
30 31 32 |
# File 'lib/docusign_esign/models/initial_here.rb', line 30 def anchor_horizontal_alignment @anchor_horizontal_alignment end |
#anchor_horizontal_alignment_metadata ⇒ Object
Metadata that indicates whether the ‘anchorHorizontalAlignment` property is editable.
33 34 35 |
# File 'lib/docusign_esign/models/initial_here.rb', line 33 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.
36 37 38 |
# File 'lib/docusign_esign/models/initial_here.rb', line 36 def anchor_ignore_if_not_present @anchor_ignore_if_not_present end |
#anchor_ignore_if_not_present_metadata ⇒ Object
Metadata that indicates whether the ‘anchorIgnoreIfNotPresent` property is editable.
39 40 41 |
# File 'lib/docusign_esign/models/initial_here.rb', line 39 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.
42 43 44 |
# File 'lib/docusign_esign/models/initial_here.rb', line 42 def anchor_match_whole_word @anchor_match_whole_word end |
#anchor_match_whole_word_metadata ⇒ Object
Metadata that indicates whether the ‘anchorMatchWholeWord` property is editable.
45 46 47 |
# File 'lib/docusign_esign/models/initial_here.rb', line 45 def @anchor_match_whole_word_metadata end |
#anchor_string ⇒ Object
Anchor text information for a radio button.
48 49 50 |
# File 'lib/docusign_esign/models/initial_here.rb', line 48 def anchor_string @anchor_string end |
#anchor_string_metadata ⇒ Object
Metadata that indicates whether the ‘anchorString` property is editable.
51 52 53 |
# File 'lib/docusign_esign/models/initial_here.rb', line 51 def @anchor_string_metadata end |
#anchor_tab_processor_version ⇒ Object
Returns the value of attribute anchor_tab_processor_version.
54 55 56 |
# File 'lib/docusign_esign/models/initial_here.rb', line 54 def anchor_tab_processor_version @anchor_tab_processor_version end |
#anchor_tab_processor_version_metadata ⇒ Object
Reserved for DocuSign.
57 58 59 |
# File 'lib/docusign_esign/models/initial_here.rb', line 57 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.
60 61 62 |
# File 'lib/docusign_esign/models/initial_here.rb', line 60 def anchor_units @anchor_units end |
#anchor_units_metadata ⇒ Object
Metadata that indicates whether the ‘anchorUnits` property is editable.
63 64 65 |
# File 'lib/docusign_esign/models/initial_here.rb', line 63 def @anchor_units_metadata end |
#anchor_x_offset ⇒ Object
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
66 67 68 |
# File 'lib/docusign_esign/models/initial_here.rb', line 66 def anchor_x_offset @anchor_x_offset end |
#anchor_x_offset_metadata ⇒ Object
Metadata that indicates whether the ‘anchorXOffset` property is editable.
69 70 71 |
# File 'lib/docusign_esign/models/initial_here.rb', line 69 def @anchor_x_offset_metadata end |
#anchor_y_offset ⇒ Object
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
72 73 74 |
# File 'lib/docusign_esign/models/initial_here.rb', line 72 def anchor_y_offset @anchor_y_offset end |
#anchor_y_offset_metadata ⇒ Object
Metadata that indicates whether the ‘anchorYOffset` property is editable.
75 76 77 |
# File 'lib/docusign_esign/models/initial_here.rb', line 75 def @anchor_y_offset_metadata end |
#caption ⇒ Object
Returns the value of attribute caption.
78 79 80 |
# File 'lib/docusign_esign/models/initial_here.rb', line 78 def @caption end |
#caption_metadata ⇒ Object
Returns the value of attribute caption_metadata.
80 81 82 |
# File 'lib/docusign_esign/models/initial_here.rb', line 80 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.
83 84 85 |
# File 'lib/docusign_esign/models/initial_here.rb', line 83 def conditional_parent_label @conditional_parent_label end |
#conditional_parent_label_metadata ⇒ Object
Metadata that indicates whether the ‘conditionalParentLabel` property is editable.
86 87 88 |
# File 'lib/docusign_esign/models/initial_here.rb', line 86 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.
89 90 91 |
# File 'lib/docusign_esign/models/initial_here.rb', line 89 def conditional_parent_value @conditional_parent_value end |
#conditional_parent_value_metadata ⇒ Object
Metadata that indicates whether the ‘conditionalParentValue` property is editable.
92 93 94 |
# File 'lib/docusign_esign/models/initial_here.rb', line 92 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.
95 96 97 |
# File 'lib/docusign_esign/models/initial_here.rb', line 95 def custom_tab_id @custom_tab_id end |
#custom_tab_id_metadata ⇒ Object
Metadata that indicates whether the ‘customTabId` property is editable.
98 99 100 |
# File 'lib/docusign_esign/models/initial_here.rb', line 98 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.
101 102 103 |
# File 'lib/docusign_esign/models/initial_here.rb', line 101 def document_id @document_id end |
#document_id_metadata ⇒ Object
Metadata that indicates whether the ‘documentId` property is editable.
104 105 106 |
# File 'lib/docusign_esign/models/initial_here.rb', line 104 def @document_id_metadata end |
#error_details ⇒ Object
This object describes errors that occur. It is only valid for responses and ignored in requests.
107 108 109 |
# File 'lib/docusign_esign/models/initial_here.rb', line 107 def error_details @error_details end |
#form_order ⇒ Object
Returns the value of attribute form_order.
110 111 112 |
# File 'lib/docusign_esign/models/initial_here.rb', line 110 def form_order @form_order end |
#form_order_metadata ⇒ Object
Metadata that indicates whether the ‘formOrder` property is editable.
113 114 115 |
# File 'lib/docusign_esign/models/initial_here.rb', line 113 def @form_order_metadata end |
#form_page_label ⇒ Object
Returns the value of attribute form_page_label.
116 117 118 |
# File 'lib/docusign_esign/models/initial_here.rb', line 116 def form_page_label @form_page_label end |
#form_page_label_metadata ⇒ Object
Metadata that indicates whether the ‘formPageLabel` property is editable.
119 120 121 |
# File 'lib/docusign_esign/models/initial_here.rb', line 119 def @form_page_label_metadata end |
#form_page_number ⇒ Object
Returns the value of attribute form_page_number.
122 123 124 |
# File 'lib/docusign_esign/models/initial_here.rb', line 122 def form_page_number @form_page_number end |
#form_page_number_metadata ⇒ Object
Metadata that indicates whether the ‘fromPageNumber` property is editable.
125 126 127 |
# File 'lib/docusign_esign/models/initial_here.rb', line 125 def @form_page_number_metadata end |
#hand_draw_required ⇒ Object
Returns the value of attribute hand_draw_required.
128 129 130 |
# File 'lib/docusign_esign/models/initial_here.rb', line 128 def hand_draw_required @hand_draw_required end |
#height ⇒ Object
Height of the tab in pixels.
131 132 133 |
# File 'lib/docusign_esign/models/initial_here.rb', line 131 def height @height end |
#height_metadata ⇒ Object
Metadata that indicates whether the ‘height` property is editable.
134 135 136 |
# File 'lib/docusign_esign/models/initial_here.rb', line 134 def @height_metadata end |
#merge_field ⇒ Object
Contains the information necessary to map the tab to a field in SalesForce.
137 138 139 |
# File 'lib/docusign_esign/models/initial_here.rb', line 137 def merge_field @merge_field end |
#merge_field_xml ⇒ Object
Returns the value of attribute merge_field_xml.
140 141 142 |
# File 'lib/docusign_esign/models/initial_here.rb', line 140 def merge_field_xml @merge_field_xml end |
#name ⇒ Object
Specifies the tool tip text for the tab.
143 144 145 |
# File 'lib/docusign_esign/models/initial_here.rb', line 143 def name @name end |
#name_metadata ⇒ Object
Metadata that indicates whether the ‘name` property is editable. This property is read-only.
146 147 148 |
# File 'lib/docusign_esign/models/initial_here.rb', line 146 def @name_metadata end |
#optional ⇒ Object
Returns the value of attribute optional.
149 150 151 |
# File 'lib/docusign_esign/models/initial_here.rb', line 149 def optional @optional end |
#optional_metadata ⇒ Object
Metadata that indicates whether the ‘optional` property is editable.
152 153 154 |
# File 'lib/docusign_esign/models/initial_here.rb', line 152 def @optional_metadata end |
#page_number ⇒ Object
Specifies the page number on which the tab is located.
155 156 157 |
# File 'lib/docusign_esign/models/initial_here.rb', line 155 def page_number @page_number end |
#page_number_metadata ⇒ Object
Metadata that indicates whether the ‘pageNumber` property is editable.
158 159 160 |
# File 'lib/docusign_esign/models/initial_here.rb', line 158 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.
161 162 163 |
# File 'lib/docusign_esign/models/initial_here.rb', line 161 def recipient_id @recipient_id end |
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
164 165 166 |
# File 'lib/docusign_esign/models/initial_here.rb', line 164 def recipient_id_guid @recipient_id_guid end |
#recipient_id_guid_metadata ⇒ Object
Metadata that indicates whether the ‘recipientIdGuid` property is editable.
167 168 169 |
# File 'lib/docusign_esign/models/initial_here.rb', line 167 def @recipient_id_guid_metadata end |
#recipient_id_metadata ⇒ Object
Metadata that indicates whether the ‘recipientId` property is editable.
170 171 172 |
# File 'lib/docusign_esign/models/initial_here.rb', line 170 def @recipient_id_metadata end |
#scale_value ⇒ Object
Sets the size for the InitialHere tab. It can be value from 0.5 to 1.0, where 1.0 represents full size and 0.5 is 50% size.
173 174 175 |
# File 'lib/docusign_esign/models/initial_here.rb', line 173 def scale_value @scale_value end |
#scale_value_metadata ⇒ Object
Metadata that indicates whether the ‘scaleValue` property is editable.
176 177 178 |
# File 'lib/docusign_esign/models/initial_here.rb', line 176 def @scale_value_metadata end |
#smart_contract_information ⇒ Object
Reserved for DocuSign.
179 180 181 |
# File 'lib/docusign_esign/models/initial_here.rb', line 179 def smart_contract_information @smart_contract_information end |
#source ⇒ Object
Returns the value of attribute source.
182 183 184 |
# File 'lib/docusign_esign/models/initial_here.rb', line 182 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.
185 186 187 |
# File 'lib/docusign_esign/models/initial_here.rb', line 185 def status @status end |
#status_metadata ⇒ Object
Metadata that indicates whether the ‘status` property is editable.
188 189 190 |
# File 'lib/docusign_esign/models/initial_here.rb', line 188 def @status_metadata end |
#tab_group_labels ⇒ Object
Returns the value of attribute tab_group_labels.
191 192 193 |
# File 'lib/docusign_esign/models/initial_here.rb', line 191 def tab_group_labels @tab_group_labels end |
#tab_group_labels_metadata ⇒ Object
Metadata that indicates whether the ‘tabGroupLabels` property is editable.
194 195 196 |
# File 'lib/docusign_esign/models/initial_here.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/initial_here.rb', line 197 def tab_id @tab_id end |
#tab_id_metadata ⇒ Object
Metadata that indicates whether the ‘tabId` property is editable.
200 201 202 |
# File 'lib/docusign_esign/models/initial_here.rb', line 200 def @tab_id_metadata end |
#tab_label ⇒ Object
The label string associated with the tab.
203 204 205 |
# File 'lib/docusign_esign/models/initial_here.rb', line 203 def tab_label @tab_label end |
#tab_label_metadata ⇒ Object
Metadata that indicates whether the ‘tabLabel` property is editable.
206 207 208 |
# File 'lib/docusign_esign/models/initial_here.rb', line 206 def @tab_label_metadata end |
#tab_order ⇒ Object
Returns the value of attribute tab_order.
209 210 211 |
# File 'lib/docusign_esign/models/initial_here.rb', line 209 def tab_order @tab_order end |
#tab_order_metadata ⇒ Object
Metadata that indicates whether the ‘tabOrder` property is editable.
212 213 214 |
# File 'lib/docusign_esign/models/initial_here.rb', line 212 def @tab_order_metadata end |
#tab_type ⇒ Object
Returns the value of attribute tab_type.
215 216 217 |
# File 'lib/docusign_esign/models/initial_here.rb', line 215 def tab_type @tab_type end |
#tab_type_metadata ⇒ Object
Metadata that indicates whether the ‘tabType` property is editable.
218 219 220 |
# File 'lib/docusign_esign/models/initial_here.rb', line 218 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.
221 222 223 |
# File 'lib/docusign_esign/models/initial_here.rb', line 221 def template_locked @template_locked end |
#template_locked_metadata ⇒ Object
Metadata that indicates whether the ‘templateLocked` property is editable.
224 225 226 |
# File 'lib/docusign_esign/models/initial_here.rb', line 224 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.
227 228 229 |
# File 'lib/docusign_esign/models/initial_here.rb', line 227 def template_required @template_required end |
#template_required_metadata ⇒ Object
Metadata that indicates whether the ‘templateRequired` property is editable.
230 231 232 |
# File 'lib/docusign_esign/models/initial_here.rb', line 230 def @template_required_metadata end |
#tool_tip_metadata ⇒ Object
Metadata that indicates whether the ‘toolTip` property is editable.
236 237 238 |
# File 'lib/docusign_esign/models/initial_here.rb', line 236 def @tool_tip_metadata end |
#tooltip ⇒ Object
Returns the value of attribute tooltip.
233 234 235 |
# File 'lib/docusign_esign/models/initial_here.rb', line 233 def tooltip @tooltip end |
#width ⇒ Object
Width of the tab in pixels.
239 240 241 |
# File 'lib/docusign_esign/models/initial_here.rb', line 239 def width @width end |
#width_metadata ⇒ Object
Metadata that indicates whether the ‘width` property is editable.
242 243 244 |
# File 'lib/docusign_esign/models/initial_here.rb', line 242 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.
245 246 247 |
# File 'lib/docusign_esign/models/initial_here.rb', line 245 def x_position @x_position end |
#x_position_metadata ⇒ Object
Metadata that indicates whether the ‘xPosition` property is editable.
248 249 250 |
# File 'lib/docusign_esign/models/initial_here.rb', line 248 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.
251 252 253 |
# File 'lib/docusign_esign/models/initial_here.rb', line 251 def y_position @y_position end |
#y_position_metadata ⇒ Object
Metadata that indicates whether the ‘yPosition` property is editable.
254 255 256 |
# File 'lib/docusign_esign/models/initial_here.rb', line 254 def @y_position_metadata end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 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 |
# File 'lib/docusign_esign/models/initial_here.rb', line 257 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', :'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', :'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', :'hand_draw_required' => :'handDrawRequired', :'height' => :'height', :'height_metadata' => :'heightMetadata', :'merge_field' => :'mergeField', :'merge_field_xml' => :'mergeFieldXml', :'name' => :'name', :'name_metadata' => :'nameMetadata', :'optional' => :'optional', :'optional_metadata' => :'optionalMetadata', :'page_number' => :'pageNumber', :'page_number_metadata' => :'pageNumberMetadata', :'recipient_id' => :'recipientId', :'recipient_id_guid' => :'recipientIdGuid', :'recipient_id_guid_metadata' => :'recipientIdGuidMetadata', :'recipient_id_metadata' => :'recipientIdMetadata', :'scale_value' => :'scaleValue', :'scale_value_metadata' => :'scaleValueMetadata', :'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', :'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.
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 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 |
# File 'lib/docusign_esign/models/initial_here.rb', line 343 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', :'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', :'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', :'hand_draw_required' => :'String', :'height' => :'String', :'height_metadata' => :'PropertyMetadata', :'merge_field' => :'MergeField', :'merge_field_xml' => :'String', :'name' => :'String', :'name_metadata' => :'PropertyMetadata', :'optional' => :'String', :'optional_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', :'scale_value' => :'String', :'scale_value_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', :'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.
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 |
# File 'lib/docusign_esign/models/initial_here.rb', line 774 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. && == 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 && form_order == o.form_order && == o. && form_page_label == o.form_page_label && == o. && form_page_number == o.form_page_number && == o. && hand_draw_required == o.hand_draw_required && height == o.height && == o. && merge_field == o.merge_field && merge_field_xml == o.merge_field_xml && name == o.name && == o. && optional == o.optional && == o. && page_number == o.page_number && == o. && recipient_id == o.recipient_id && recipient_id_guid == o.recipient_id_guid && == o. && == o. && scale_value == o.scale_value && == 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. && 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
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 |
# File 'lib/docusign_esign/models/initial_here.rb', line 895 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
961 962 963 964 965 966 967 968 969 970 971 972 973 |
# File 'lib/docusign_esign/models/initial_here.rb', line 961 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
874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 |
# File 'lib/docusign_esign/models/initial_here.rb', line 874 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
861 862 863 |
# File 'lib/docusign_esign/models/initial_here.rb', line 861 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
867 868 869 |
# File 'lib/docusign_esign/models/initial_here.rb', line 867 def hash [anchor_allow_white_space_in_characters, , anchor_case_sensitive, , anchor_horizontal_alignment, , anchor_ignore_if_not_present, , anchor_match_whole_word, , anchor_string, , anchor_tab_processor_version, , anchor_units, , anchor_x_offset, , anchor_y_offset, , , , conditional_parent_label, , conditional_parent_value, , custom_tab_id, , document_id, , error_details, form_order, , form_page_label, , form_page_number, , hand_draw_required, height, , merge_field, merge_field_xml, name, , optional, , page_number, , recipient_id, recipient_id_guid, , , scale_value, , smart_contract_information, source, status, , tab_group_labels, , tab_id, , tab_label, , tab_order, , tab_type, , template_locked, , template_required, , tooltip, , width, , x_position, , y_position, ].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
761 762 763 764 |
# File 'lib/docusign_esign/models/initial_here.rb', line 761 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
941 942 943 |
# File 'lib/docusign_esign/models/initial_here.rb', line 941 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
947 948 949 950 951 952 953 954 955 |
# File 'lib/docusign_esign/models/initial_here.rb', line 947 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
935 936 937 |
# File 'lib/docusign_esign/models/initial_here.rb', line 935 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
768 769 770 |
# File 'lib/docusign_esign/models/initial_here.rb', line 768 def valid? true end |