Class: DocuSign_eSign::Signer
- Inherits:
-
Object
- Object
- DocuSign_eSign::Signer
- Defined in:
- lib/docusign_esign/models/signer.rb
Instance Attribute Summary collapse
-
#access_code ⇒ Object
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope.
-
#access_code_metadata ⇒ Object
Returns the value of attribute access_code_metadata.
-
#add_access_code_to_email ⇒ Object
This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
-
#additional_notifications ⇒ Object
Returns the value of attribute additional_notifications.
-
#agent_can_edit_email ⇒ Object
Returns the value of attribute agent_can_edit_email.
-
#agent_can_edit_name ⇒ Object
Returns the value of attribute agent_can_edit_name.
-
#allow_system_override_for_locked_recipient ⇒ Object
Returns the value of attribute allow_system_override_for_locked_recipient.
-
#auto_navigation ⇒ Object
Returns the value of attribute auto_navigation.
-
#auto_responded_reason ⇒ Object
Returns the value of attribute auto_responded_reason.
-
#bulk_recipients_uri ⇒ Object
Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
-
#can_sign_offline ⇒ Object
When set to true, specifies that the signer can perform the signing ceremony offline.
-
#client_user_id ⇒ Object
Specifies whether the recipient is embedded or remote.
-
#completed_count ⇒ Object
Returns the value of attribute completed_count.
-
#creation_reason ⇒ Object
Returns the value of attribute creation_reason.
-
#custom_fields ⇒ Object
An optional array of strings that allows the sender to provide custom data about the recipient.
-
#declined_date_time ⇒ Object
The date and time the recipient declined the document.
-
#declined_reason ⇒ Object
The reason the recipient declined the document.
-
#default_recipient ⇒ Object
Returns the value of attribute default_recipient.
-
#delegated_by ⇒ Object
Returns the value of attribute delegated_by.
-
#delegated_to ⇒ Object
Returns the value of attribute delegated_to.
-
#delivered_date_time ⇒ Object
Reserved: For DocuSign use only.
-
#delivery_method ⇒ Object
Reserved: For DocuSign use only.
-
#delivery_method_metadata ⇒ Object
Returns the value of attribute delivery_method_metadata.
-
#designator_id ⇒ Object
Returns the value of attribute designator_id.
-
#designator_id_guid ⇒ Object
Returns the value of attribute designator_id_guid.
-
#document_visibility ⇒ Object
Returns the value of attribute document_visibility.
-
#email ⇒ Object
Email id of the recipient.
-
#email_metadata ⇒ Object
Returns the value of attribute email_metadata.
-
#email_notification ⇒ Object
Returns the value of attribute email_notification.
-
#email_recipient_post_signing_url ⇒ Object
Returns the value of attribute email_recipient_post_signing_url.
-
#embedded_recipient_start_url ⇒ Object
Specifies a sender provided valid URL string for redirecting an embedded recipient.
-
#error_details ⇒ Object
Returns the value of attribute error_details.
-
#excluded_documents ⇒ Object
Specifies the documents that are not visible to this recipient.
-
#fax_number ⇒ Object
Reserved:.
-
#fax_number_metadata ⇒ Object
Returns the value of attribute fax_number_metadata.
-
#first_name ⇒ Object
The user’s first name.
-
#first_name_metadata ⇒ Object
Returns the value of attribute first_name_metadata.
-
#full_name ⇒ Object
Returns the value of attribute full_name.
-
#full_name_metadata ⇒ Object
Returns the value of attribute full_name_metadata.
-
#id_check_configuration_name ⇒ Object
Specifies authentication check by name.
-
#id_check_configuration_name_metadata ⇒ Object
Returns the value of attribute id_check_configuration_name_metadata.
-
#id_check_information_input ⇒ Object
Returns the value of attribute id_check_information_input.
-
#identity_verification ⇒ Object
Returns the value of attribute identity_verification.
-
#inherit_email_notification_configuration ⇒ Object
When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient’s account.
-
#is_bulk_recipient ⇒ Object
When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file.
-
#is_bulk_recipient_metadata ⇒ Object
Returns the value of attribute is_bulk_recipient_metadata.
-
#last_name ⇒ Object
Returns the value of attribute last_name.
-
#last_name_metadata ⇒ Object
Returns the value of attribute last_name_metadata.
-
#locked_recipient_phone_auth_editable ⇒ Object
Returns the value of attribute locked_recipient_phone_auth_editable.
-
#locked_recipient_sms_editable ⇒ Object
Returns the value of attribute locked_recipient_sms_editable.
-
#name ⇒ Object
Returns the value of attribute name.
-
#name_metadata ⇒ Object
Returns the value of attribute name_metadata.
-
#notary_id ⇒ Object
Returns the value of attribute notary_id.
-
#notary_signer_email_sent ⇒ Object
Returns the value of attribute notary_signer_email_sent.
-
#note ⇒ Object
Specifies a note that is unique to this recipient.
-
#note_metadata ⇒ Object
Returns the value of attribute note_metadata.
-
#offline_attributes ⇒ Object
Returns the value of attribute offline_attributes.
-
#phone_authentication ⇒ Object
Returns the value of attribute phone_authentication.
-
#phone_number ⇒ Object
Returns the value of attribute phone_number.
-
#proof_file ⇒ Object
Returns the value of attribute proof_file.
-
#recipient_attachments ⇒ Object
Reserved:.
-
#recipient_authentication_status ⇒ Object
Returns the value of attribute recipient_authentication_status.
-
#recipient_feature_metadata ⇒ Object
Returns the value of attribute recipient_feature_metadata.
-
#recipient_id ⇒ Object
Unique for the recipient.
-
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
-
#recipient_signature_providers ⇒ Object
Returns the value of attribute recipient_signature_providers.
-
#recipient_supplies_tabs ⇒ Object
Returns the value of attribute recipient_supplies_tabs.
-
#recipient_type ⇒ Object
Returns the value of attribute recipient_type.
-
#recipient_type_metadata ⇒ Object
Returns the value of attribute recipient_type_metadata.
-
#require_id_lookup ⇒ Object
When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
-
#require_id_lookup_metadata ⇒ Object
Returns the value of attribute require_id_lookup_metadata.
-
#require_sign_on_paper ⇒ Object
When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.
-
#require_signer_certificate ⇒ Object
Sets the type of signer certificate required for signing.
-
#require_upload_signature ⇒ Object
Returns the value of attribute require_upload_signature.
-
#role_name ⇒ Object
Optional element.
-
#routing_order ⇒ Object
Specifies the routing order of the recipient in the envelope.
-
#routing_order_metadata ⇒ Object
Returns the value of attribute routing_order_metadata.
-
#sent_date_time ⇒ Object
The date and time the envelope was sent.
-
#sign_in_each_location ⇒ Object
When set to true, specifies that the signer must sign in all locations.
-
#sign_in_each_location_metadata ⇒ Object
Returns the value of attribute sign_in_each_location_metadata.
-
#signature_info ⇒ Object
Returns the value of attribute signature_info.
-
#signed_date_time ⇒ Object
Reserved: For DocuSign use only.
-
#signing_group_id ⇒ Object
When set to true and the feature is enabled in the sender’s account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
-
#signing_group_id_metadata ⇒ Object
Returns the value of attribute signing_group_id_metadata.
-
#signing_group_name ⇒ Object
The display name for the signing group.
-
#signing_group_users ⇒ Object
A complex type that contains information about users in the signing group.
-
#sms_authentication ⇒ Object
Returns the value of attribute sms_authentication.
-
#social_authentications ⇒ Object
Lists the social ID type that can be used for recipient authentication.
-
#status ⇒ Object
Indicates the envelope status.
-
#status_code ⇒ Object
Returns the value of attribute status_code.
-
#suppress_emails ⇒ Object
Returns the value of attribute suppress_emails.
-
#tabs ⇒ Object
Returns the value of attribute tabs.
-
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient.
-
#template_required ⇒ Object
When set to true, the sender may not remove the recipient.
-
#total_tab_count ⇒ Object
Returns the value of attribute total_tab_count.
-
#user_id ⇒ Object
Returns the value of attribute user_id.
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 = {}) ⇒ Signer
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 = {}) ⇒ Signer
Initializes the object
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 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 |
# File 'lib/docusign_esign/models/signer.rb', line 481 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?(:'accessCode') self.access_code = attributes[:'accessCode'] end if attributes.has_key?(:'accessCodeMetadata') self. = attributes[:'accessCodeMetadata'] end if attributes.has_key?(:'addAccessCodeToEmail') self.add_access_code_to_email = attributes[:'addAccessCodeToEmail'] end if attributes.has_key?(:'additionalNotifications') if (value = attributes[:'additionalNotifications']).is_a?(Array) self.additional_notifications = value end end if attributes.has_key?(:'agentCanEditEmail') self.agent_can_edit_email = attributes[:'agentCanEditEmail'] end if attributes.has_key?(:'agentCanEditName') self.agent_can_edit_name = attributes[:'agentCanEditName'] end if attributes.has_key?(:'allowSystemOverrideForLockedRecipient') self.allow_system_override_for_locked_recipient = attributes[:'allowSystemOverrideForLockedRecipient'] end if attributes.has_key?(:'autoNavigation') self. = attributes[:'autoNavigation'] end if attributes.has_key?(:'autoRespondedReason') self.auto_responded_reason = attributes[:'autoRespondedReason'] end if attributes.has_key?(:'bulkRecipientsUri') self.bulk_recipients_uri = attributes[:'bulkRecipientsUri'] end if attributes.has_key?(:'canSignOffline') self.can_sign_offline = attributes[:'canSignOffline'] end if attributes.has_key?(:'clientUserId') self.client_user_id = attributes[:'clientUserId'] end if attributes.has_key?(:'completedCount') self.completed_count = attributes[:'completedCount'] end if attributes.has_key?(:'creationReason') self.creation_reason = attributes[:'creationReason'] end if attributes.has_key?(:'customFields') if (value = attributes[:'customFields']).is_a?(Array) self.custom_fields = value end end if attributes.has_key?(:'declinedDateTime') self.declined_date_time = attributes[:'declinedDateTime'] end if attributes.has_key?(:'declinedReason') self.declined_reason = attributes[:'declinedReason'] end if attributes.has_key?(:'defaultRecipient') self.default_recipient = attributes[:'defaultRecipient'] end if attributes.has_key?(:'delegatedBy') self.delegated_by = attributes[:'delegatedBy'] end if attributes.has_key?(:'delegatedTo') if (value = attributes[:'delegatedTo']).is_a?(Array) self.delegated_to = value end end if attributes.has_key?(:'deliveredDateTime') self.delivered_date_time = attributes[:'deliveredDateTime'] end if attributes.has_key?(:'deliveryMethod') self.delivery_method = attributes[:'deliveryMethod'] end if attributes.has_key?(:'deliveryMethodMetadata') self. = attributes[:'deliveryMethodMetadata'] end if attributes.has_key?(:'designatorId') self.designator_id = attributes[:'designatorId'] end if attributes.has_key?(:'designatorIdGuid') self.designator_id_guid = attributes[:'designatorIdGuid'] end if attributes.has_key?(:'documentVisibility') if (value = attributes[:'documentVisibility']).is_a?(Array) self.document_visibility = value end end if attributes.has_key?(:'email') self.email = attributes[:'email'] end if attributes.has_key?(:'emailMetadata') self. = attributes[:'emailMetadata'] end if attributes.has_key?(:'emailNotification') self.email_notification = attributes[:'emailNotification'] end if attributes.has_key?(:'emailRecipientPostSigningURL') self.email_recipient_post_signing_url = attributes[:'emailRecipientPostSigningURL'] end if attributes.has_key?(:'embeddedRecipientStartURL') self. = attributes[:'embeddedRecipientStartURL'] end if attributes.has_key?(:'errorDetails') self.error_details = attributes[:'errorDetails'] end if attributes.has_key?(:'excludedDocuments') if (value = attributes[:'excludedDocuments']).is_a?(Array) self.excluded_documents = value end end if attributes.has_key?(:'faxNumber') self.fax_number = attributes[:'faxNumber'] end if attributes.has_key?(:'faxNumberMetadata') self. = attributes[:'faxNumberMetadata'] end if attributes.has_key?(:'firstName') self.first_name = attributes[:'firstName'] end if attributes.has_key?(:'firstNameMetadata') self. = attributes[:'firstNameMetadata'] end if attributes.has_key?(:'fullName') self.full_name = attributes[:'fullName'] end if attributes.has_key?(:'fullNameMetadata') self. = attributes[:'fullNameMetadata'] end if attributes.has_key?(:'idCheckConfigurationName') self.id_check_configuration_name = attributes[:'idCheckConfigurationName'] end if attributes.has_key?(:'idCheckConfigurationNameMetadata') self. = attributes[:'idCheckConfigurationNameMetadata'] end if attributes.has_key?(:'idCheckInformationInput') self.id_check_information_input = attributes[:'idCheckInformationInput'] end if attributes.has_key?(:'identityVerification') self.identity_verification = attributes[:'identityVerification'] end if attributes.has_key?(:'inheritEmailNotificationConfiguration') self.inherit_email_notification_configuration = attributes[:'inheritEmailNotificationConfiguration'] end if attributes.has_key?(:'isBulkRecipient') self.is_bulk_recipient = attributes[:'isBulkRecipient'] end if attributes.has_key?(:'isBulkRecipientMetadata') self. = attributes[:'isBulkRecipientMetadata'] end if attributes.has_key?(:'lastName') self.last_name = attributes[:'lastName'] end if attributes.has_key?(:'lastNameMetadata') self. = attributes[:'lastNameMetadata'] end if attributes.has_key?(:'lockedRecipientPhoneAuthEditable') self.locked_recipient_phone_auth_editable = attributes[:'lockedRecipientPhoneAuthEditable'] end if attributes.has_key?(:'lockedRecipientSmsEditable') self.locked_recipient_sms_editable = attributes[:'lockedRecipientSmsEditable'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] end if attributes.has_key?(:'nameMetadata') self. = attributes[:'nameMetadata'] end if attributes.has_key?(:'notaryId') self.notary_id = attributes[:'notaryId'] end if attributes.has_key?(:'notarySignerEmailSent') self.notary_signer_email_sent = attributes[:'notarySignerEmailSent'] end if attributes.has_key?(:'note') self.note = attributes[:'note'] end if attributes.has_key?(:'noteMetadata') self. = attributes[:'noteMetadata'] end if attributes.has_key?(:'offlineAttributes') self.offline_attributes = attributes[:'offlineAttributes'] end if attributes.has_key?(:'phoneAuthentication') self.phone_authentication = attributes[:'phoneAuthentication'] end if attributes.has_key?(:'phoneNumber') self.phone_number = attributes[:'phoneNumber'] end if attributes.has_key?(:'proofFile') self.proof_file = attributes[:'proofFile'] end if attributes.has_key?(:'recipientAttachments') if (value = attributes[:'recipientAttachments']).is_a?(Array) self. = value end end if attributes.has_key?(:'recipientAuthenticationStatus') self.recipient_authentication_status = attributes[:'recipientAuthenticationStatus'] end if attributes.has_key?(:'recipientFeatureMetadata') if (value = attributes[:'recipientFeatureMetadata']).is_a?(Array) self. = value end 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?(:'recipientSignatureProviders') if (value = attributes[:'recipientSignatureProviders']).is_a?(Array) self.recipient_signature_providers = value end end if attributes.has_key?(:'recipientSuppliesTabs') self.recipient_supplies_tabs = attributes[:'recipientSuppliesTabs'] end if attributes.has_key?(:'recipientType') self.recipient_type = attributes[:'recipientType'] end if attributes.has_key?(:'recipientTypeMetadata') self. = attributes[:'recipientTypeMetadata'] end if attributes.has_key?(:'requireIdLookup') self.require_id_lookup = attributes[:'requireIdLookup'] end if attributes.has_key?(:'requireIdLookupMetadata') self. = attributes[:'requireIdLookupMetadata'] end if attributes.has_key?(:'requireSignerCertificate') self.require_signer_certificate = attributes[:'requireSignerCertificate'] end if attributes.has_key?(:'requireSignOnPaper') self.require_sign_on_paper = attributes[:'requireSignOnPaper'] end if attributes.has_key?(:'requireUploadSignature') self.require_upload_signature = attributes[:'requireUploadSignature'] end if attributes.has_key?(:'roleName') self.role_name = attributes[:'roleName'] end if attributes.has_key?(:'routingOrder') self.routing_order = attributes[:'routingOrder'] end if attributes.has_key?(:'routingOrderMetadata') self. = attributes[:'routingOrderMetadata'] end if attributes.has_key?(:'sentDateTime') self.sent_date_time = attributes[:'sentDateTime'] end if attributes.has_key?(:'signatureInfo') self.signature_info = attributes[:'signatureInfo'] end if attributes.has_key?(:'signedDateTime') self.signed_date_time = attributes[:'signedDateTime'] end if attributes.has_key?(:'signInEachLocation') self.sign_in_each_location = attributes[:'signInEachLocation'] end if attributes.has_key?(:'signInEachLocationMetadata') self. = attributes[:'signInEachLocationMetadata'] end if attributes.has_key?(:'signingGroupId') self.signing_group_id = attributes[:'signingGroupId'] end if attributes.has_key?(:'signingGroupIdMetadata') self. = attributes[:'signingGroupIdMetadata'] end if attributes.has_key?(:'signingGroupName') self.signing_group_name = attributes[:'signingGroupName'] end if attributes.has_key?(:'signingGroupUsers') if (value = attributes[:'signingGroupUsers']).is_a?(Array) self.signing_group_users = value end end if attributes.has_key?(:'smsAuthentication') self.sms_authentication = attributes[:'smsAuthentication'] end if attributes.has_key?(:'socialAuthentications') if (value = attributes[:'socialAuthentications']).is_a?(Array) self. = value end end if attributes.has_key?(:'status') self.status = attributes[:'status'] end if attributes.has_key?(:'statusCode') self.status_code = attributes[:'statusCode'] end if attributes.has_key?(:'suppressEmails') self.suppress_emails = attributes[:'suppressEmails'] end if attributes.has_key?(:'tabs') self.tabs = attributes[:'tabs'] end if attributes.has_key?(:'templateLocked') self.template_locked = attributes[:'templateLocked'] end if attributes.has_key?(:'templateRequired') self.template_required = attributes[:'templateRequired'] end if attributes.has_key?(:'totalTabCount') self.total_tab_count = attributes[:'totalTabCount'] end if attributes.has_key?(:'userId') self.user_id = attributes[:'userId'] end end |
Instance Attribute Details
#access_code ⇒ Object
If a value is provided, the recipient must enter the value as the access code to view and sign the envelope. Maximum Length: 50 characters and it must conform to the account’s access code format setting. If blank, but the signer ‘accessCode` property is set in the envelope, then that value is used. If blank and the signer `accessCode` property is not set, then the access code is not required.
17 18 19 |
# File 'lib/docusign_esign/models/signer.rb', line 17 def access_code @access_code end |
#access_code_metadata ⇒ Object
Returns the value of attribute access_code_metadata.
19 20 21 |
# File 'lib/docusign_esign/models/signer.rb', line 19 def @access_code_metadata end |
#add_access_code_to_email ⇒ Object
This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.
22 23 24 |
# File 'lib/docusign_esign/models/signer.rb', line 22 def add_access_code_to_email @add_access_code_to_email end |
#additional_notifications ⇒ Object
Returns the value of attribute additional_notifications.
25 26 27 |
# File 'lib/docusign_esign/models/signer.rb', line 25 def additional_notifications @additional_notifications end |
#agent_can_edit_email ⇒ Object
Returns the value of attribute agent_can_edit_email.
28 29 30 |
# File 'lib/docusign_esign/models/signer.rb', line 28 def agent_can_edit_email @agent_can_edit_email end |
#agent_can_edit_name ⇒ Object
Returns the value of attribute agent_can_edit_name.
31 32 33 |
# File 'lib/docusign_esign/models/signer.rb', line 31 def agent_can_edit_name @agent_can_edit_name end |
#allow_system_override_for_locked_recipient ⇒ Object
Returns the value of attribute allow_system_override_for_locked_recipient.
34 35 36 |
# File 'lib/docusign_esign/models/signer.rb', line 34 def allow_system_override_for_locked_recipient @allow_system_override_for_locked_recipient end |
#auto_navigation ⇒ Object
Returns the value of attribute auto_navigation.
37 38 39 |
# File 'lib/docusign_esign/models/signer.rb', line 37 def @auto_navigation end |
#auto_responded_reason ⇒ Object
Returns the value of attribute auto_responded_reason.
40 41 42 |
# File 'lib/docusign_esign/models/signer.rb', line 40 def auto_responded_reason @auto_responded_reason end |
#bulk_recipients_uri ⇒ Object
Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.
43 44 45 |
# File 'lib/docusign_esign/models/signer.rb', line 43 def bulk_recipients_uri @bulk_recipients_uri end |
#can_sign_offline ⇒ Object
When set to true, specifies that the signer can perform the signing ceremony offline.
46 47 48 |
# File 'lib/docusign_esign/models/signer.rb', line 46 def can_sign_offline @can_sign_offline end |
#client_user_id ⇒ Object
Specifies whether the recipient is embedded or remote. If the ‘clientUserId` property is not null then the recipient is embedded. Note that if the `ClientUserId` property is set and either `SignerMustHaveAccount` or `SignerMustLoginToSign` property of the account settings is set to true, an error is generated on sending.ng. Maximum length: 100 characters.
49 50 51 |
# File 'lib/docusign_esign/models/signer.rb', line 49 def client_user_id @client_user_id end |
#completed_count ⇒ Object
Returns the value of attribute completed_count.
52 53 54 |
# File 'lib/docusign_esign/models/signer.rb', line 52 def completed_count @completed_count end |
#creation_reason ⇒ Object
Returns the value of attribute creation_reason.
55 56 57 |
# File 'lib/docusign_esign/models/signer.rb', line 55 def creation_reason @creation_reason end |
#custom_fields ⇒ Object
An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.
58 59 60 |
# File 'lib/docusign_esign/models/signer.rb', line 58 def custom_fields @custom_fields end |
#declined_date_time ⇒ Object
The date and time the recipient declined the document.
61 62 63 |
# File 'lib/docusign_esign/models/signer.rb', line 61 def declined_date_time @declined_date_time end |
#declined_reason ⇒ Object
The reason the recipient declined the document.
64 65 66 |
# File 'lib/docusign_esign/models/signer.rb', line 64 def declined_reason @declined_reason end |
#default_recipient ⇒ Object
Returns the value of attribute default_recipient.
67 68 69 |
# File 'lib/docusign_esign/models/signer.rb', line 67 def default_recipient @default_recipient end |
#delegated_by ⇒ Object
Returns the value of attribute delegated_by.
69 70 71 |
# File 'lib/docusign_esign/models/signer.rb', line 69 def delegated_by @delegated_by end |
#delegated_to ⇒ Object
Returns the value of attribute delegated_to.
72 73 74 |
# File 'lib/docusign_esign/models/signer.rb', line 72 def delegated_to @delegated_to end |
#delivered_date_time ⇒ Object
Reserved: For DocuSign use only.
75 76 77 |
# File 'lib/docusign_esign/models/signer.rb', line 75 def delivered_date_time @delivered_date_time end |
#delivery_method ⇒ Object
Reserved: For DocuSign use only.
78 79 80 |
# File 'lib/docusign_esign/models/signer.rb', line 78 def delivery_method @delivery_method end |
#delivery_method_metadata ⇒ Object
Returns the value of attribute delivery_method_metadata.
80 81 82 |
# File 'lib/docusign_esign/models/signer.rb', line 80 def @delivery_method_metadata end |
#designator_id ⇒ Object
Returns the value of attribute designator_id.
83 84 85 |
# File 'lib/docusign_esign/models/signer.rb', line 83 def designator_id @designator_id end |
#designator_id_guid ⇒ Object
Returns the value of attribute designator_id_guid.
86 87 88 |
# File 'lib/docusign_esign/models/signer.rb', line 86 def designator_id_guid @designator_id_guid end |
#document_visibility ⇒ Object
Returns the value of attribute document_visibility.
89 90 91 |
# File 'lib/docusign_esign/models/signer.rb', line 89 def document_visibility @document_visibility end |
#email ⇒ Object
Email id of the recipient. Notification of the document to sign is sent to this email id. Maximum length: 100 characters.
92 93 94 |
# File 'lib/docusign_esign/models/signer.rb', line 92 def email @email end |
#email_metadata ⇒ Object
Returns the value of attribute email_metadata.
94 95 96 |
# File 'lib/docusign_esign/models/signer.rb', line 94 def @email_metadata end |
#email_notification ⇒ Object
Returns the value of attribute email_notification.
96 97 98 |
# File 'lib/docusign_esign/models/signer.rb', line 96 def email_notification @email_notification end |
#email_recipient_post_signing_url ⇒ Object
Returns the value of attribute email_recipient_post_signing_url.
99 100 101 |
# File 'lib/docusign_esign/models/signer.rb', line 99 def email_recipient_post_signing_url @email_recipient_post_signing_url end |
#embedded_recipient_start_url ⇒ Object
Specifies a sender provided valid URL string for redirecting an embedded recipient. When using this option, the embedded recipient still receives an email from DocuSign, just as a remote recipient would. When the document link in the email is clicked the recipient is redirected, through DocuSign, to the supplied URL to complete their actions. When routing to the URL, the sender’s system (the server responding to the URL) must request a recipient token to launch a signing session. If set to ‘SIGN_AT_DOCUSIGN`, the recipient is directed to an embedded signing or viewing process directly at DocuSign. The signing or viewing action is initiated by the DocuSign system and the transaction activity and Certificate of Completion records will reflect this. In all other ways the process is identical to an embedded signing or viewing operation that is launched by any partner. It is important to remember that in a typical embedded workflow the authentication of an embedded recipient is the responsibility of the sending application, DocuSign expects that senders will follow their own process for establishing the recipient’s identity. In this workflow the recipient goes through the sending application before the embedded signing or viewing process in initiated. However, when the sending application sets ‘EmbeddedRecipientStartURL=SIGN_AT_DOCUSIGN`, the recipient goes directly to the embedded signing or viewing process bypassing the sending application and any authentication steps the sending application would use. In this case, DocuSign recommends that you use one of the normal DocuSign authentication features (Access Code, Phone Authentication, SMS Authentication, etc.) to verify the identity of the recipient. If the `clientUserId` property is NOT set, and the `embeddedRecipientStartURL` is set, DocuSign will ignore the redirect URL and launch the standard signing process for the email recipient. Information can be appended to the embedded recipient start URL using merge fields. The available merge fields items are: envelopeId, recipientId, recipientName, recipientEmail, and customFields. The `customFields` property must be set fort the recipient or envelope. The merge fields are enclosed in double brackets. Example: `senderHost/[[mergeField1]]/ beginSigningSession? [[mergeField2]]&[]`
102 103 104 |
# File 'lib/docusign_esign/models/signer.rb', line 102 def @embedded_recipient_start_url end |
#error_details ⇒ Object
Returns the value of attribute error_details.
104 105 106 |
# File 'lib/docusign_esign/models/signer.rb', line 104 def error_details @error_details end |
#excluded_documents ⇒ Object
Specifies the documents that are not visible to this recipient. Document Visibility must be enabled for the account and the ‘enforceSignerVisibility` property must be set to true for the envelope to use this. When enforce signer visibility is enabled, documents with tabs can only be viewed by signers that have a tab on that document. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all the documents in an envelope, unless they are specifically excluded using this setting when an envelope is sent. Documents that do not have tabs are always visible to all recipients, unless they are specifically excluded using this setting when an envelope is sent.
107 108 109 |
# File 'lib/docusign_esign/models/signer.rb', line 107 def excluded_documents @excluded_documents end |
#fax_number ⇒ Object
Reserved:
110 111 112 |
# File 'lib/docusign_esign/models/signer.rb', line 110 def fax_number @fax_number end |
#fax_number_metadata ⇒ Object
Returns the value of attribute fax_number_metadata.
112 113 114 |
# File 'lib/docusign_esign/models/signer.rb', line 112 def @fax_number_metadata end |
#first_name ⇒ Object
The user’s first name. Maximum Length: 50 characters.
115 116 117 |
# File 'lib/docusign_esign/models/signer.rb', line 115 def first_name @first_name end |
#first_name_metadata ⇒ Object
Returns the value of attribute first_name_metadata.
117 118 119 |
# File 'lib/docusign_esign/models/signer.rb', line 117 def @first_name_metadata end |
#full_name ⇒ Object
Returns the value of attribute full_name.
120 121 122 |
# File 'lib/docusign_esign/models/signer.rb', line 120 def full_name @full_name end |
#full_name_metadata ⇒ Object
Returns the value of attribute full_name_metadata.
122 123 124 |
# File 'lib/docusign_esign/models/signer.rb', line 122 def @full_name_metadata end |
#id_check_configuration_name ⇒ Object
Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ‘ID Check $’ and ‘SMS Auth $’. To use ID check in an envelope, the idCheckConfigurationName should be ‘ID Check ’. If you wanted to use SMS, it would be ‘SMS Auth $’ and you would need to add you would need to add phone number information to the ‘smsAuthentication` node.
125 126 127 |
# File 'lib/docusign_esign/models/signer.rb', line 125 def id_check_configuration_name @id_check_configuration_name end |
#id_check_configuration_name_metadata ⇒ Object
Returns the value of attribute id_check_configuration_name_metadata.
127 128 129 |
# File 'lib/docusign_esign/models/signer.rb', line 127 def @id_check_configuration_name_metadata end |
#id_check_information_input ⇒ Object
Returns the value of attribute id_check_information_input.
129 130 131 |
# File 'lib/docusign_esign/models/signer.rb', line 129 def id_check_information_input @id_check_information_input end |
#identity_verification ⇒ Object
Returns the value of attribute identity_verification.
131 132 133 |
# File 'lib/docusign_esign/models/signer.rb', line 131 def identity_verification @identity_verification end |
#inherit_email_notification_configuration ⇒ Object
When set to true and the envelope recipient creates a DocuSign account after signing, the Manage Account Email Notification settings are used as the default settings for the recipient’s account.
134 135 136 |
# File 'lib/docusign_esign/models/signer.rb', line 134 def inherit_email_notification_configuration @inherit_email_notification_configuration end |
#is_bulk_recipient ⇒ Object
When set to true, this signer is a bulk recipient and the recipient information is contained in a bulk recipient file. Note that when this is true the email and name for the recipient becomes [email protected] and "Bulk Recipient". These fields can not be changed for the bulk recipient.
137 138 139 |
# File 'lib/docusign_esign/models/signer.rb', line 137 def is_bulk_recipient @is_bulk_recipient end |
#is_bulk_recipient_metadata ⇒ Object
Returns the value of attribute is_bulk_recipient_metadata.
139 140 141 |
# File 'lib/docusign_esign/models/signer.rb', line 139 def @is_bulk_recipient_metadata end |
#last_name ⇒ Object
Returns the value of attribute last_name.
142 143 144 |
# File 'lib/docusign_esign/models/signer.rb', line 142 def last_name @last_name end |
#last_name_metadata ⇒ Object
Returns the value of attribute last_name_metadata.
144 145 146 |
# File 'lib/docusign_esign/models/signer.rb', line 144 def @last_name_metadata end |
#locked_recipient_phone_auth_editable ⇒ Object
Returns the value of attribute locked_recipient_phone_auth_editable.
147 148 149 |
# File 'lib/docusign_esign/models/signer.rb', line 147 def locked_recipient_phone_auth_editable @locked_recipient_phone_auth_editable end |
#locked_recipient_sms_editable ⇒ Object
Returns the value of attribute locked_recipient_sms_editable.
150 151 152 |
# File 'lib/docusign_esign/models/signer.rb', line 150 def locked_recipient_sms_editable @locked_recipient_sms_editable end |
#name ⇒ Object
Returns the value of attribute name.
153 154 155 |
# File 'lib/docusign_esign/models/signer.rb', line 153 def name @name end |
#name_metadata ⇒ Object
Returns the value of attribute name_metadata.
155 156 157 |
# File 'lib/docusign_esign/models/signer.rb', line 155 def @name_metadata end |
#notary_id ⇒ Object
Returns the value of attribute notary_id.
158 159 160 |
# File 'lib/docusign_esign/models/signer.rb', line 158 def notary_id @notary_id end |
#notary_signer_email_sent ⇒ Object
Returns the value of attribute notary_signer_email_sent.
161 162 163 |
# File 'lib/docusign_esign/models/signer.rb', line 161 def notary_signer_email_sent @notary_signer_email_sent end |
#note ⇒ Object
Specifies a note that is unique to this recipient. This note is sent to the recipient via the signing email. The note displays in the signing UI near the upper left corner of the document on the signing screen. Maximum Length: 1000 characters.
164 165 166 |
# File 'lib/docusign_esign/models/signer.rb', line 164 def note @note end |
#note_metadata ⇒ Object
Returns the value of attribute note_metadata.
166 167 168 |
# File 'lib/docusign_esign/models/signer.rb', line 166 def @note_metadata end |
#offline_attributes ⇒ Object
Returns the value of attribute offline_attributes.
168 169 170 |
# File 'lib/docusign_esign/models/signer.rb', line 168 def offline_attributes @offline_attributes end |
#phone_authentication ⇒ Object
Returns the value of attribute phone_authentication.
170 171 172 |
# File 'lib/docusign_esign/models/signer.rb', line 170 def phone_authentication @phone_authentication end |
#phone_number ⇒ Object
Returns the value of attribute phone_number.
172 173 174 |
# File 'lib/docusign_esign/models/signer.rb', line 172 def phone_number @phone_number end |
#proof_file ⇒ Object
Returns the value of attribute proof_file.
174 175 176 |
# File 'lib/docusign_esign/models/signer.rb', line 174 def proof_file @proof_file end |
#recipient_attachments ⇒ Object
Reserved:
177 178 179 |
# File 'lib/docusign_esign/models/signer.rb', line 177 def @recipient_attachments end |
#recipient_authentication_status ⇒ Object
Returns the value of attribute recipient_authentication_status.
179 180 181 |
# File 'lib/docusign_esign/models/signer.rb', line 179 def recipient_authentication_status @recipient_authentication_status end |
#recipient_feature_metadata ⇒ Object
Returns the value of attribute recipient_feature_metadata.
182 183 184 |
# File 'lib/docusign_esign/models/signer.rb', line 182 def @recipient_feature_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.
185 186 187 |
# File 'lib/docusign_esign/models/signer.rb', line 185 def recipient_id @recipient_id end |
#recipient_id_guid ⇒ Object
Returns the value of attribute recipient_id_guid.
188 189 190 |
# File 'lib/docusign_esign/models/signer.rb', line 188 def recipient_id_guid @recipient_id_guid end |
#recipient_signature_providers ⇒ Object
Returns the value of attribute recipient_signature_providers.
191 192 193 |
# File 'lib/docusign_esign/models/signer.rb', line 191 def recipient_signature_providers @recipient_signature_providers end |
#recipient_supplies_tabs ⇒ Object
Returns the value of attribute recipient_supplies_tabs.
194 195 196 |
# File 'lib/docusign_esign/models/signer.rb', line 194 def recipient_supplies_tabs @recipient_supplies_tabs end |
#recipient_type ⇒ Object
Returns the value of attribute recipient_type.
197 198 199 |
# File 'lib/docusign_esign/models/signer.rb', line 197 def recipient_type @recipient_type end |
#recipient_type_metadata ⇒ Object
Returns the value of attribute recipient_type_metadata.
199 200 201 |
# File 'lib/docusign_esign/models/signer.rb', line 199 def @recipient_type_metadata end |
#require_id_lookup ⇒ Object
When set to true, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.
202 203 204 |
# File 'lib/docusign_esign/models/signer.rb', line 202 def require_id_lookup @require_id_lookup end |
#require_id_lookup_metadata ⇒ Object
Returns the value of attribute require_id_lookup_metadata.
204 205 206 |
# File 'lib/docusign_esign/models/signer.rb', line 204 def @require_id_lookup_metadata end |
#require_sign_on_paper ⇒ Object
When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.
210 211 212 |
# File 'lib/docusign_esign/models/signer.rb', line 210 def require_sign_on_paper @require_sign_on_paper end |
#require_signer_certificate ⇒ Object
Sets the type of signer certificate required for signing. If left blank, no certificate is required. Only one type of certificate can be set for a signer. The possible values are: * docusign_express - Requires a DocuSign Express certificate. * safe - Requires a SAFE-BioPharma certificate. * open_trust - Requires an OpenTrust certificate. Important: There are certain rules and restrictions that must be followed when requiring OpenTrust digital signatures. See [ML:OpenTrust Rules and Restrictions] for more information.
207 208 209 |
# File 'lib/docusign_esign/models/signer.rb', line 207 def require_signer_certificate @require_signer_certificate end |
#require_upload_signature ⇒ Object
Returns the value of attribute require_upload_signature.
213 214 215 |
# File 'lib/docusign_esign/models/signer.rb', line 213 def require_upload_signature @require_upload_signature end |
#role_name ⇒ Object
Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.
216 217 218 |
# File 'lib/docusign_esign/models/signer.rb', line 216 def role_name @role_name end |
#routing_order ⇒ Object
Specifies the routing order of the recipient in the envelope.
219 220 221 |
# File 'lib/docusign_esign/models/signer.rb', line 219 def routing_order @routing_order end |
#routing_order_metadata ⇒ Object
Returns the value of attribute routing_order_metadata.
221 222 223 |
# File 'lib/docusign_esign/models/signer.rb', line 221 def @routing_order_metadata end |
#sent_date_time ⇒ Object
The date and time the envelope was sent.
224 225 226 |
# File 'lib/docusign_esign/models/signer.rb', line 224 def sent_date_time @sent_date_time end |
#sign_in_each_location ⇒ Object
When set to true, specifies that the signer must sign in all locations.
232 233 234 |
# File 'lib/docusign_esign/models/signer.rb', line 232 def sign_in_each_location @sign_in_each_location end |
#sign_in_each_location_metadata ⇒ Object
Returns the value of attribute sign_in_each_location_metadata.
234 235 236 |
# File 'lib/docusign_esign/models/signer.rb', line 234 def @sign_in_each_location_metadata end |
#signature_info ⇒ Object
Returns the value of attribute signature_info.
226 227 228 |
# File 'lib/docusign_esign/models/signer.rb', line 226 def signature_info @signature_info end |
#signed_date_time ⇒ Object
Reserved: For DocuSign use only.
229 230 231 |
# File 'lib/docusign_esign/models/signer.rb', line 229 def signed_date_time @signed_date_time end |
#signing_group_id ⇒ Object
When set to true and the feature is enabled in the sender’s account, the signing recipient is required to draw signatures and initials at each signature/initial tab ( instead of adopting a signature/initial style or only drawing a signature/initial once).
237 238 239 |
# File 'lib/docusign_esign/models/signer.rb', line 237 def signing_group_id @signing_group_id end |
#signing_group_id_metadata ⇒ Object
Returns the value of attribute signing_group_id_metadata.
239 240 241 |
# File 'lib/docusign_esign/models/signer.rb', line 239 def @signing_group_id_metadata end |
#signing_group_name ⇒ Object
The display name for the signing group. Maximum Length: 100 characters.
242 243 244 |
# File 'lib/docusign_esign/models/signer.rb', line 242 def signing_group_name @signing_group_name end |
#signing_group_users ⇒ Object
A complex type that contains information about users in the signing group.
245 246 247 |
# File 'lib/docusign_esign/models/signer.rb', line 245 def signing_group_users @signing_group_users end |
#sms_authentication ⇒ Object
Returns the value of attribute sms_authentication.
247 248 249 |
# File 'lib/docusign_esign/models/signer.rb', line 247 def sms_authentication @sms_authentication end |
#social_authentications ⇒ Object
Lists the social ID type that can be used for recipient authentication.
250 251 252 |
# File 'lib/docusign_esign/models/signer.rb', line 250 def @social_authentications 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.
253 254 255 |
# File 'lib/docusign_esign/models/signer.rb', line 253 def status @status end |
#status_code ⇒ Object
Returns the value of attribute status_code.
256 257 258 |
# File 'lib/docusign_esign/models/signer.rb', line 256 def status_code @status_code end |
#suppress_emails ⇒ Object
Returns the value of attribute suppress_emails.
259 260 261 |
# File 'lib/docusign_esign/models/signer.rb', line 259 def suppress_emails @suppress_emails end |
#tabs ⇒ Object
Returns the value of attribute tabs.
261 262 263 |
# File 'lib/docusign_esign/models/signer.rb', line 261 def tabs @tabs end |
#template_locked ⇒ Object
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
264 265 266 |
# File 'lib/docusign_esign/models/signer.rb', line 264 def template_locked @template_locked end |
#template_required ⇒ Object
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
267 268 269 |
# File 'lib/docusign_esign/models/signer.rb', line 267 def template_required @template_required end |
#total_tab_count ⇒ Object
Returns the value of attribute total_tab_count.
270 271 272 |
# File 'lib/docusign_esign/models/signer.rb', line 270 def total_tab_count @total_tab_count end |
#user_id ⇒ Object
Returns the value of attribute user_id.
273 274 275 |
# File 'lib/docusign_esign/models/signer.rb', line 273 def user_id @user_id end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
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 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 |
# File 'lib/docusign_esign/models/signer.rb', line 276 def self.attribute_map { :'access_code' => :'accessCode', :'access_code_metadata' => :'accessCodeMetadata', :'add_access_code_to_email' => :'addAccessCodeToEmail', :'additional_notifications' => :'additionalNotifications', :'agent_can_edit_email' => :'agentCanEditEmail', :'agent_can_edit_name' => :'agentCanEditName', :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient', :'auto_navigation' => :'autoNavigation', :'auto_responded_reason' => :'autoRespondedReason', :'bulk_recipients_uri' => :'bulkRecipientsUri', :'can_sign_offline' => :'canSignOffline', :'client_user_id' => :'clientUserId', :'completed_count' => :'completedCount', :'creation_reason' => :'creationReason', :'custom_fields' => :'customFields', :'declined_date_time' => :'declinedDateTime', :'declined_reason' => :'declinedReason', :'default_recipient' => :'defaultRecipient', :'delegated_by' => :'delegatedBy', :'delegated_to' => :'delegatedTo', :'delivered_date_time' => :'deliveredDateTime', :'delivery_method' => :'deliveryMethod', :'delivery_method_metadata' => :'deliveryMethodMetadata', :'designator_id' => :'designatorId', :'designator_id_guid' => :'designatorIdGuid', :'document_visibility' => :'documentVisibility', :'email' => :'email', :'email_metadata' => :'emailMetadata', :'email_notification' => :'emailNotification', :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL', :'embedded_recipient_start_url' => :'embeddedRecipientStartURL', :'error_details' => :'errorDetails', :'excluded_documents' => :'excludedDocuments', :'fax_number' => :'faxNumber', :'fax_number_metadata' => :'faxNumberMetadata', :'first_name' => :'firstName', :'first_name_metadata' => :'firstNameMetadata', :'full_name' => :'fullName', :'full_name_metadata' => :'fullNameMetadata', :'id_check_configuration_name' => :'idCheckConfigurationName', :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata', :'id_check_information_input' => :'idCheckInformationInput', :'identity_verification' => :'identityVerification', :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration', :'is_bulk_recipient' => :'isBulkRecipient', :'is_bulk_recipient_metadata' => :'isBulkRecipientMetadata', :'last_name' => :'lastName', :'last_name_metadata' => :'lastNameMetadata', :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable', :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable', :'name' => :'name', :'name_metadata' => :'nameMetadata', :'notary_id' => :'notaryId', :'notary_signer_email_sent' => :'notarySignerEmailSent', :'note' => :'note', :'note_metadata' => :'noteMetadata', :'offline_attributes' => :'offlineAttributes', :'phone_authentication' => :'phoneAuthentication', :'phone_number' => :'phoneNumber', :'proof_file' => :'proofFile', :'recipient_attachments' => :'recipientAttachments', :'recipient_authentication_status' => :'recipientAuthenticationStatus', :'recipient_feature_metadata' => :'recipientFeatureMetadata', :'recipient_id' => :'recipientId', :'recipient_id_guid' => :'recipientIdGuid', :'recipient_signature_providers' => :'recipientSignatureProviders', :'recipient_supplies_tabs' => :'recipientSuppliesTabs', :'recipient_type' => :'recipientType', :'recipient_type_metadata' => :'recipientTypeMetadata', :'require_id_lookup' => :'requireIdLookup', :'require_id_lookup_metadata' => :'requireIdLookupMetadata', :'require_signer_certificate' => :'requireSignerCertificate', :'require_sign_on_paper' => :'requireSignOnPaper', :'require_upload_signature' => :'requireUploadSignature', :'role_name' => :'roleName', :'routing_order' => :'routingOrder', :'routing_order_metadata' => :'routingOrderMetadata', :'sent_date_time' => :'sentDateTime', :'signature_info' => :'signatureInfo', :'signed_date_time' => :'signedDateTime', :'sign_in_each_location' => :'signInEachLocation', :'sign_in_each_location_metadata' => :'signInEachLocationMetadata', :'signing_group_id' => :'signingGroupId', :'signing_group_id_metadata' => :'signingGroupIdMetadata', :'signing_group_name' => :'signingGroupName', :'signing_group_users' => :'signingGroupUsers', :'sms_authentication' => :'smsAuthentication', :'social_authentications' => :'socialAuthentications', :'status' => :'status', :'status_code' => :'statusCode', :'suppress_emails' => :'suppressEmails', :'tabs' => :'tabs', :'template_locked' => :'templateLocked', :'template_required' => :'templateRequired', :'total_tab_count' => :'totalTabCount', :'user_id' => :'userId' } end |
.swagger_types ⇒ Object
Attribute type mapping.
378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 |
# File 'lib/docusign_esign/models/signer.rb', line 378 def self.swagger_types { :'access_code' => :'String', :'access_code_metadata' => :'PropertyMetadata', :'add_access_code_to_email' => :'String', :'additional_notifications' => :'Array<RecipientAdditionalNotification>', :'agent_can_edit_email' => :'String', :'agent_can_edit_name' => :'String', :'allow_system_override_for_locked_recipient' => :'String', :'auto_navigation' => :'String', :'auto_responded_reason' => :'String', :'bulk_recipients_uri' => :'String', :'can_sign_offline' => :'String', :'client_user_id' => :'String', :'completed_count' => :'String', :'creation_reason' => :'String', :'custom_fields' => :'Array<String>', :'declined_date_time' => :'String', :'declined_reason' => :'String', :'default_recipient' => :'String', :'delegated_by' => :'DelegationInfo', :'delegated_to' => :'Array<DelegationInfo>', :'delivered_date_time' => :'String', :'delivery_method' => :'String', :'delivery_method_metadata' => :'PropertyMetadata', :'designator_id' => :'String', :'designator_id_guid' => :'String', :'document_visibility' => :'Array<DocumentVisibility>', :'email' => :'String', :'email_metadata' => :'PropertyMetadata', :'email_notification' => :'RecipientEmailNotification', :'email_recipient_post_signing_url' => :'String', :'embedded_recipient_start_url' => :'String', :'error_details' => :'ErrorDetails', :'excluded_documents' => :'Array<String>', :'fax_number' => :'String', :'fax_number_metadata' => :'PropertyMetadata', :'first_name' => :'String', :'first_name_metadata' => :'PropertyMetadata', :'full_name' => :'String', :'full_name_metadata' => :'PropertyMetadata', :'id_check_configuration_name' => :'String', :'id_check_configuration_name_metadata' => :'PropertyMetadata', :'id_check_information_input' => :'IdCheckInformationInput', :'identity_verification' => :'RecipientIdentityVerification', :'inherit_email_notification_configuration' => :'String', :'is_bulk_recipient' => :'String', :'is_bulk_recipient_metadata' => :'PropertyMetadata', :'last_name' => :'String', :'last_name_metadata' => :'PropertyMetadata', :'locked_recipient_phone_auth_editable' => :'String', :'locked_recipient_sms_editable' => :'String', :'name' => :'String', :'name_metadata' => :'PropertyMetadata', :'notary_id' => :'String', :'notary_signer_email_sent' => :'String', :'note' => :'String', :'note_metadata' => :'PropertyMetadata', :'offline_attributes' => :'OfflineAttributes', :'phone_authentication' => :'RecipientPhoneAuthentication', :'phone_number' => :'RecipientPhoneNumber', :'proof_file' => :'RecipientProofFile', :'recipient_attachments' => :'Array<RecipientAttachment>', :'recipient_authentication_status' => :'AuthenticationStatus', :'recipient_feature_metadata' => :'Array<FeatureAvailableMetadata>', :'recipient_id' => :'String', :'recipient_id_guid' => :'String', :'recipient_signature_providers' => :'Array<RecipientSignatureProvider>', :'recipient_supplies_tabs' => :'String', :'recipient_type' => :'String', :'recipient_type_metadata' => :'PropertyMetadata', :'require_id_lookup' => :'String', :'require_id_lookup_metadata' => :'PropertyMetadata', :'require_signer_certificate' => :'String', :'require_sign_on_paper' => :'String', :'require_upload_signature' => :'String', :'role_name' => :'String', :'routing_order' => :'String', :'routing_order_metadata' => :'PropertyMetadata', :'sent_date_time' => :'String', :'signature_info' => :'RecipientSignatureInformation', :'signed_date_time' => :'String', :'sign_in_each_location' => :'String', :'sign_in_each_location_metadata' => :'PropertyMetadata', :'signing_group_id' => :'String', :'signing_group_id_metadata' => :'PropertyMetadata', :'signing_group_name' => :'String', :'signing_group_users' => :'Array<UserInfo>', :'sms_authentication' => :'RecipientSMSAuthentication', :'social_authentications' => :'Array<SocialAuthentication>', :'status' => :'String', :'status_code' => :'String', :'suppress_emails' => :'String', :'tabs' => :'Tabs', :'template_locked' => :'String', :'template_required' => :'String', :'total_tab_count' => :'String', :'user_id' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 |
# File 'lib/docusign_esign/models/signer.rb', line 907 def ==(o) return true if self.equal?(o) self.class == o.class && access_code == o.access_code && == o. && add_access_code_to_email == o.add_access_code_to_email && additional_notifications == o.additional_notifications && agent_can_edit_email == o.agent_can_edit_email && agent_can_edit_name == o.agent_can_edit_name && allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient && == o. && auto_responded_reason == o.auto_responded_reason && bulk_recipients_uri == o.bulk_recipients_uri && can_sign_offline == o.can_sign_offline && client_user_id == o.client_user_id && completed_count == o.completed_count && creation_reason == o.creation_reason && custom_fields == o.custom_fields && declined_date_time == o.declined_date_time && declined_reason == o.declined_reason && default_recipient == o.default_recipient && delegated_by == o.delegated_by && delegated_to == o.delegated_to && delivered_date_time == o.delivered_date_time && delivery_method == o.delivery_method && == o. && designator_id == o.designator_id && designator_id_guid == o.designator_id_guid && document_visibility == o.document_visibility && email == o.email && == o. && email_notification == o.email_notification && email_recipient_post_signing_url == o.email_recipient_post_signing_url && == o. && error_details == o.error_details && excluded_documents == o.excluded_documents && fax_number == o.fax_number && == o. && first_name == o.first_name && == o. && full_name == o.full_name && == o. && id_check_configuration_name == o.id_check_configuration_name && == o. && id_check_information_input == o.id_check_information_input && identity_verification == o.identity_verification && inherit_email_notification_configuration == o.inherit_email_notification_configuration && is_bulk_recipient == o.is_bulk_recipient && == o. && last_name == o.last_name && == o. && locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable && locked_recipient_sms_editable == o.locked_recipient_sms_editable && name == o.name && == o. && notary_id == o.notary_id && notary_signer_email_sent == o.notary_signer_email_sent && note == o.note && == o. && offline_attributes == o.offline_attributes && phone_authentication == o.phone_authentication && phone_number == o.phone_number && proof_file == o.proof_file && == o. && recipient_authentication_status == o.recipient_authentication_status && == o. && recipient_id == o.recipient_id && recipient_id_guid == o.recipient_id_guid && recipient_signature_providers == o.recipient_signature_providers && recipient_supplies_tabs == o.recipient_supplies_tabs && recipient_type == o.recipient_type && == o. && require_id_lookup == o.require_id_lookup && == o. && require_signer_certificate == o.require_signer_certificate && require_sign_on_paper == o.require_sign_on_paper && require_upload_signature == o.require_upload_signature && role_name == o.role_name && routing_order == o.routing_order && == o. && sent_date_time == o.sent_date_time && signature_info == o.signature_info && signed_date_time == o.signed_date_time && sign_in_each_location == o.sign_in_each_location && == o. && signing_group_id == o.signing_group_id && == o. && signing_group_name == o.signing_group_name && signing_group_users == o.signing_group_users && sms_authentication == o.sms_authentication && == o. && status == o.status && status_code == o.status_code && suppress_emails == o.suppress_emails && tabs == o.tabs && template_locked == o.template_locked && template_required == o.template_required && total_tab_count == o.total_tab_count && user_id == o.user_id end |
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type
1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 |
# File 'lib/docusign_esign/models/signer.rb', line 1044 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
1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 |
# File 'lib/docusign_esign/models/signer.rb', line 1110 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
1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 |
# File 'lib/docusign_esign/models/signer.rb', line 1023 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
1010 1011 1012 |
# File 'lib/docusign_esign/models/signer.rb', line 1010 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
1016 1017 1018 |
# File 'lib/docusign_esign/models/signer.rb', line 1016 def hash [access_code, , add_access_code_to_email, additional_notifications, agent_can_edit_email, agent_can_edit_name, allow_system_override_for_locked_recipient, , auto_responded_reason, bulk_recipients_uri, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delegated_by, delegated_to, delivered_date_time, delivery_method, , designator_id, designator_id_guid, document_visibility, email, , email_notification, email_recipient_post_signing_url, , error_details, excluded_documents, fax_number, , first_name, , full_name, , id_check_configuration_name, , id_check_information_input, identity_verification, inherit_email_notification_configuration, is_bulk_recipient, , last_name, , locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, , notary_id, notary_signer_email_sent, note, , offline_attributes, phone_authentication, phone_number, proof_file, , recipient_authentication_status, , recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, recipient_type, , require_id_lookup, , require_signer_certificate, require_sign_on_paper, require_upload_signature, role_name, routing_order, , sent_date_time, signature_info, signed_date_time, sign_in_each_location, , signing_group_id, , signing_group_name, signing_group_users, sms_authentication, , status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
894 895 896 897 |
# File 'lib/docusign_esign/models/signer.rb', line 894 def list_invalid_properties invalid_properties = Array.new invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
1090 1091 1092 |
# File 'lib/docusign_esign/models/signer.rb', line 1090 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
1096 1097 1098 1099 1100 1101 1102 1103 1104 |
# File 'lib/docusign_esign/models/signer.rb', line 1096 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
1084 1085 1086 |
# File 'lib/docusign_esign/models/signer.rb', line 1084 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
901 902 903 |
# File 'lib/docusign_esign/models/signer.rb', line 901 def valid? true end |