Class: DocuSign_eSign::InPersonSigner

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ InPersonSigner

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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?(:'allowSystemOverrideForLockedRecipient')
    self.allow_system_override_for_locked_recipient = attributes[:'allowSystemOverrideForLockedRecipient']
  end

  if attributes.has_key?(:'autoNavigation')
    self.auto_navigation = attributes[:'autoNavigation']
  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?(:'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?(:'embeddedRecipientStartURL')
    self.embedded_recipient_start_url = 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?(:'hostEmail')
    self.host_email = attributes[:'hostEmail']
  end

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

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

  if attributes.has_key?(:'hostNameMetadata')
    self. = attributes[:'hostNameMetadata']
  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?(:'inPersonSigningType')
    self.in_person_signing_type = attributes[:'inPersonSigningType']
  end

  if attributes.has_key?(:'inPersonSigningTypeMetadata')
    self. = attributes[:'inPersonSigningTypeMetadata']
  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?(:'notaryHost')
    self.notary_host = attributes[:'notaryHost']
  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?(:'recipientAttachments')
    if (value = attributes[:'recipientAttachments']).is_a?(Array)
      self.recipient_attachments = 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?(:'signerEmail')
    self.signer_email = attributes[:'signerEmail']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'signInEachLocation')
    self. = 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.social_authentications = 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_codeObject

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.


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

def access_code
  @access_code
end

#access_code_metadataObject

Returns the value of attribute access_code_metadata


20
21
22
# File 'lib/docusign_esign/models/in_person_signer.rb', line 20

def 
  @access_code_metadata
end

#add_access_code_to_emailObject

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.


23
24
25
# File 'lib/docusign_esign/models/in_person_signer.rb', line 23

def add_access_code_to_email
  @add_access_code_to_email
end

#allow_system_override_for_locked_recipientObject

Returns the value of attribute allow_system_override_for_locked_recipient


26
27
28
# File 'lib/docusign_esign/models/in_person_signer.rb', line 26

def allow_system_override_for_locked_recipient
  @allow_system_override_for_locked_recipient
end

#auto_navigationObject

Returns the value of attribute auto_navigation


29
30
31
# File 'lib/docusign_esign/models/in_person_signer.rb', line 29

def auto_navigation
  @auto_navigation
end

#can_sign_offlineObject

When set to *true*, specifies that the signer can perform the signing ceremony offline.


32
33
34
# File 'lib/docusign_esign/models/in_person_signer.rb', line 32

def can_sign_offline
  @can_sign_offline
end

#client_user_idObject

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.


35
36
37
# File 'lib/docusign_esign/models/in_person_signer.rb', line 35

def client_user_id
  @client_user_id
end

#completed_countObject

Returns the value of attribute completed_count


38
39
40
# File 'lib/docusign_esign/models/in_person_signer.rb', line 38

def completed_count
  @completed_count
end

#creation_reasonObject

Returns the value of attribute creation_reason


41
42
43
# File 'lib/docusign_esign/models/in_person_signer.rb', line 41

def creation_reason
  @creation_reason
end

#custom_fieldsObject

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.


44
45
46
# File 'lib/docusign_esign/models/in_person_signer.rb', line 44

def custom_fields
  @custom_fields
end

#declined_date_timeObject

The date and time the recipient declined the document.


47
48
49
# File 'lib/docusign_esign/models/in_person_signer.rb', line 47

def declined_date_time
  @declined_date_time
end

#declined_reasonObject

The reason the recipient declined the document.


50
51
52
# File 'lib/docusign_esign/models/in_person_signer.rb', line 50

def declined_reason
  @declined_reason
end

#default_recipientObject

Returns the value of attribute default_recipient


53
54
55
# File 'lib/docusign_esign/models/in_person_signer.rb', line 53

def default_recipient
  @default_recipient
end

#delivered_date_timeObject

Reserved: For DocuSign use only.


56
57
58
# File 'lib/docusign_esign/models/in_person_signer.rb', line 56

def delivered_date_time
  @delivered_date_time
end

#delivery_methodObject

Reserved: For DocuSign use only.


59
60
61
# File 'lib/docusign_esign/models/in_person_signer.rb', line 59

def delivery_method
  @delivery_method
end

#delivery_method_metadataObject

Returns the value of attribute delivery_method_metadata


61
62
63
# File 'lib/docusign_esign/models/in_person_signer.rb', line 61

def 
  @delivery_method_metadata
end

#designator_idObject

Returns the value of attribute designator_id


64
65
66
# File 'lib/docusign_esign/models/in_person_signer.rb', line 64

def designator_id
  @designator_id
end

#designator_id_guidObject

Returns the value of attribute designator_id_guid


67
68
69
# File 'lib/docusign_esign/models/in_person_signer.rb', line 67

def designator_id_guid
  @designator_id_guid
end

#document_visibilityObject

Returns the value of attribute document_visibility


70
71
72
# File 'lib/docusign_esign/models/in_person_signer.rb', line 70

def document_visibility
  @document_visibility
end

#emailObject

Returns the value of attribute email


73
74
75
# File 'lib/docusign_esign/models/in_person_signer.rb', line 73

def email
  @email
end

#email_metadataObject

Returns the value of attribute email_metadata


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

def 
  @email_metadata
end

#email_notificationObject

Returns the value of attribute email_notification


77
78
79
# File 'lib/docusign_esign/models/in_person_signer.rb', line 77

def email_notification
  @email_notification
end

#embedded_recipient_start_urlObject

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]]&[]`


80
81
82
# File 'lib/docusign_esign/models/in_person_signer.rb', line 80

def embedded_recipient_start_url
  @embedded_recipient_start_url
end

#error_detailsObject

Returns the value of attribute error_details


82
83
84
# File 'lib/docusign_esign/models/in_person_signer.rb', line 82

def error_details
  @error_details
end

#excluded_documentsObject

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.


85
86
87
# File 'lib/docusign_esign/models/in_person_signer.rb', line 85

def excluded_documents
  @excluded_documents
end

#fax_numberObject

Reserved:


88
89
90
# File 'lib/docusign_esign/models/in_person_signer.rb', line 88

def fax_number
  @fax_number
end

#fax_number_metadataObject

Returns the value of attribute fax_number_metadata


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

def 
  @fax_number_metadata
end

#host_emailObject

Returns the value of attribute host_email


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

def host_email
  @host_email
end

#host_email_metadataObject

Returns the value of attribute host_email_metadata


95
96
97
# File 'lib/docusign_esign/models/in_person_signer.rb', line 95

def 
  @host_email_metadata
end

#host_nameObject

Specifies the name of the signing host. It is a required element for In Person Signers recipient Type. Maximum Length: 100 characters.


98
99
100
# File 'lib/docusign_esign/models/in_person_signer.rb', line 98

def host_name
  @host_name
end

#host_name_metadataObject

Returns the value of attribute host_name_metadata


100
101
102
# File 'lib/docusign_esign/models/in_person_signer.rb', line 100

def 
  @host_name_metadata
end

#id_check_configuration_nameObject

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.


103
104
105
# File 'lib/docusign_esign/models/in_person_signer.rb', line 103

def id_check_configuration_name
  @id_check_configuration_name
end

#id_check_configuration_name_metadataObject

Returns the value of attribute id_check_configuration_name_metadata


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

def 
  @id_check_configuration_name_metadata
end

#id_check_information_inputObject

Returns the value of attribute id_check_information_input


107
108
109
# File 'lib/docusign_esign/models/in_person_signer.rb', line 107

def id_check_information_input
  @id_check_information_input
end

#identity_verificationObject

Returns the value of attribute identity_verification


109
110
111
# File 'lib/docusign_esign/models/in_person_signer.rb', line 109

def identity_verification
  @identity_verification
end

#in_person_signing_typeObject

Returns the value of attribute in_person_signing_type


115
116
117
# File 'lib/docusign_esign/models/in_person_signer.rb', line 115

def in_person_signing_type
  @in_person_signing_type
end

#in_person_signing_type_metadataObject

Returns the value of attribute in_person_signing_type_metadata


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

def 
  @in_person_signing_type_metadata
end

#inherit_email_notification_configurationObject

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.


112
113
114
# File 'lib/docusign_esign/models/in_person_signer.rb', line 112

def inherit_email_notification_configuration
  @inherit_email_notification_configuration
end

#locked_recipient_phone_auth_editableObject

Returns the value of attribute locked_recipient_phone_auth_editable


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

def locked_recipient_phone_auth_editable
  @locked_recipient_phone_auth_editable
end

#locked_recipient_sms_editableObject

Returns the value of attribute locked_recipient_sms_editable


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

def locked_recipient_sms_editable
  @locked_recipient_sms_editable
end

#nameObject

Returns the value of attribute name


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

def name
  @name
end

#name_metadataObject

Returns the value of attribute name_metadata


128
129
130
# File 'lib/docusign_esign/models/in_person_signer.rb', line 128

def 
  @name_metadata
end

#notary_hostObject

Returns the value of attribute notary_host


130
131
132
# File 'lib/docusign_esign/models/in_person_signer.rb', line 130

def notary_host
  @notary_host
end

#noteObject

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.


133
134
135
# File 'lib/docusign_esign/models/in_person_signer.rb', line 133

def note
  @note
end

#note_metadataObject

Returns the value of attribute note_metadata


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

def 
  @note_metadata
end

#offline_attributesObject

Returns the value of attribute offline_attributes


137
138
139
# File 'lib/docusign_esign/models/in_person_signer.rb', line 137

def offline_attributes
  @offline_attributes
end

#phone_authenticationObject

Returns the value of attribute phone_authentication


139
140
141
# File 'lib/docusign_esign/models/in_person_signer.rb', line 139

def phone_authentication
  @phone_authentication
end

#recipient_attachmentsObject

Reserved:


142
143
144
# File 'lib/docusign_esign/models/in_person_signer.rb', line 142

def recipient_attachments
  @recipient_attachments
end

#recipient_authentication_statusObject

Returns the value of attribute recipient_authentication_status


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

def recipient_authentication_status
  @recipient_authentication_status
end

#recipient_feature_metadataObject

Returns the value of attribute recipient_feature_metadata


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

def 
  @recipient_feature_metadata
end

#recipient_idObject

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


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

def recipient_id
  @recipient_id
end

#recipient_id_guidObject

Returns the value of attribute recipient_id_guid


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

def recipient_id_guid
  @recipient_id_guid
end

#recipient_signature_providersObject

Returns the value of attribute recipient_signature_providers


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

def recipient_signature_providers
  @recipient_signature_providers
end

#recipient_supplies_tabsObject

Returns the value of attribute recipient_supplies_tabs


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

def recipient_supplies_tabs
  @recipient_supplies_tabs
end

#recipient_typeObject

Returns the value of attribute recipient_type


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

def recipient_type
  @recipient_type
end

#recipient_type_metadataObject

Returns the value of attribute recipient_type_metadata


164
165
166
# File 'lib/docusign_esign/models/in_person_signer.rb', line 164

def 
  @recipient_type_metadata
end

#require_id_lookupObject

When set to *true*, the recipient is required to use the specified ID check method (including Phone and SMS authentication) to validate their identity.


167
168
169
# File 'lib/docusign_esign/models/in_person_signer.rb', line 167

def require_id_lookup
  @require_id_lookup
end

#require_id_lookup_metadataObject

Returns the value of attribute require_id_lookup_metadata


169
170
171
# File 'lib/docusign_esign/models/in_person_signer.rb', line 169

def 
  @require_id_lookup_metadata
end

#require_sign_on_paperObject

Returns the value of attribute require_sign_on_paper


175
176
177
# File 'lib/docusign_esign/models/in_person_signer.rb', line 175

def require_sign_on_paper
  @require_sign_on_paper
end

#require_signer_certificateObject

Returns the value of attribute require_signer_certificate


172
173
174
# File 'lib/docusign_esign/models/in_person_signer.rb', line 172

def require_signer_certificate
  @require_signer_certificate
end

#require_upload_signatureObject

Returns the value of attribute require_upload_signature


178
179
180
# File 'lib/docusign_esign/models/in_person_signer.rb', line 178

def require_upload_signature
  @require_upload_signature
end

#role_nameObject

Optional element. Specifies the role name associated with the recipient.<br/><br/>This is required when working with template recipients.


181
182
183
# File 'lib/docusign_esign/models/in_person_signer.rb', line 181

def role_name
  @role_name
end

#routing_orderObject

Specifies the routing order of the recipient in the envelope.


184
185
186
# File 'lib/docusign_esign/models/in_person_signer.rb', line 184

def routing_order
  @routing_order
end

#routing_order_metadataObject

Returns the value of attribute routing_order_metadata


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

def 
  @routing_order_metadata
end

#sent_date_timeObject

The date and time the envelope was sent.


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

def sent_date_time
  @sent_date_time
end

#sign_in_each_locationObject

When set to *true*, specifies that the signer must sign in all locations.


217
218
219
# File 'lib/docusign_esign/models/in_person_signer.rb', line 217

def 
  @sign_in_each_location
end

#sign_in_each_location_metadataObject

Returns the value of attribute sign_in_each_location_metadata


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

def 
  @sign_in_each_location_metadata
end

#signature_infoObject

Returns the value of attribute signature_info


191
192
193
# File 'lib/docusign_esign/models/in_person_signer.rb', line 191

def signature_info
  @signature_info
end

#signed_date_timeObject

Reserved: For DocuSign use only.


194
195
196
# File 'lib/docusign_esign/models/in_person_signer.rb', line 194

def signed_date_time
  @signed_date_time
end

#signer_emailObject

The email address for an InPersonSigner recipient Type. Maximum Length: 100 characters.


197
198
199
# File 'lib/docusign_esign/models/in_person_signer.rb', line 197

def signer_email
  @signer_email
end

#signer_email_metadataObject

Returns the value of attribute signer_email_metadata


199
200
201
# File 'lib/docusign_esign/models/in_person_signer.rb', line 199

def 
  @signer_email_metadata
end

#signer_first_nameObject

Returns the value of attribute signer_first_name


202
203
204
# File 'lib/docusign_esign/models/in_person_signer.rb', line 202

def signer_first_name
  @signer_first_name
end

#signer_first_name_metadataObject

Returns the value of attribute signer_first_name_metadata


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

def 
  @signer_first_name_metadata
end

#signer_last_nameObject

Returns the value of attribute signer_last_name


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

def signer_last_name
  @signer_last_name
end

#signer_last_name_metadataObject

Returns the value of attribute signer_last_name_metadata


209
210
211
# File 'lib/docusign_esign/models/in_person_signer.rb', line 209

def 
  @signer_last_name_metadata
end

#signer_nameObject

Required. The full legal name of a signer for the envelope. Maximum Length: 100 characters.


212
213
214
# File 'lib/docusign_esign/models/in_person_signer.rb', line 212

def signer_name
  @signer_name
end

#signer_name_metadataObject

Returns the value of attribute signer_name_metadata


214
215
216
# File 'lib/docusign_esign/models/in_person_signer.rb', line 214

def 
  @signer_name_metadata
end

#signing_group_idObject

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).


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

def signing_group_id
  @signing_group_id
end

#signing_group_id_metadataObject

Returns the value of attribute signing_group_id_metadata


224
225
226
# File 'lib/docusign_esign/models/in_person_signer.rb', line 224

def 
  @signing_group_id_metadata
end

#signing_group_nameObject

The display name for the signing group. Maximum Length: 100 characters.


227
228
229
# File 'lib/docusign_esign/models/in_person_signer.rb', line 227

def signing_group_name
  @signing_group_name
end

#signing_group_usersObject

A complex type that contains information about users in the signing group.


230
231
232
# File 'lib/docusign_esign/models/in_person_signer.rb', line 230

def signing_group_users
  @signing_group_users
end

#sms_authenticationObject

Returns the value of attribute sms_authentication


232
233
234
# File 'lib/docusign_esign/models/in_person_signer.rb', line 232

def sms_authentication
  @sms_authentication
end

#social_authenticationsObject

Lists the social ID type that can be used for recipient authentication.


235
236
237
# File 'lib/docusign_esign/models/in_person_signer.rb', line 235

def social_authentications
  @social_authentications
end

#statusObject

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.


238
239
240
# File 'lib/docusign_esign/models/in_person_signer.rb', line 238

def status
  @status
end

#status_codeObject

Returns the value of attribute status_code


241
242
243
# File 'lib/docusign_esign/models/in_person_signer.rb', line 241

def status_code
  @status_code
end

#suppress_emailsObject

Returns the value of attribute suppress_emails


244
245
246
# File 'lib/docusign_esign/models/in_person_signer.rb', line 244

def suppress_emails
  @suppress_emails
end

#tabsObject

Returns the value of attribute tabs


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

def tabs
  @tabs
end

#template_lockedObject

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


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

def template_locked
  @template_locked
end

#template_requiredObject

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


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

def template_required
  @template_required
end

#total_tab_countObject

Returns the value of attribute total_tab_count


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

def total_tab_count
  @total_tab_count
end

#user_idObject

Returns the value of attribute user_id


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

def user_id
  @user_id
end

Class Method Details

.attribute_mapObject

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


261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
# File 'lib/docusign_esign/models/in_person_signer.rb', line 261

def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'access_code_metadata' => :'accessCodeMetadata',
    :'add_access_code_to_email' => :'addAccessCodeToEmail',
    :'allow_system_override_for_locked_recipient' => :'allowSystemOverrideForLockedRecipient',
    :'auto_navigation' => :'autoNavigation',
    :'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',
    :'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',
    :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
    :'error_details' => :'errorDetails',
    :'excluded_documents' => :'excludedDocuments',
    :'fax_number' => :'faxNumber',
    :'fax_number_metadata' => :'faxNumberMetadata',
    :'host_email' => :'hostEmail',
    :'host_email_metadata' => :'hostEmailMetadata',
    :'host_name' => :'hostName',
    :'host_name_metadata' => :'hostNameMetadata',
    :'id_check_configuration_name' => :'idCheckConfigurationName',
    :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
    :'id_check_information_input' => :'idCheckInformationInput',
    :'identity_verification' => :'identityVerification',
    :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
    :'in_person_signing_type' => :'inPersonSigningType',
    :'in_person_signing_type_metadata' => :'inPersonSigningTypeMetadata',
    :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
    :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
    :'name' => :'name',
    :'name_metadata' => :'nameMetadata',
    :'notary_host' => :'notaryHost',
    :'note' => :'note',
    :'note_metadata' => :'noteMetadata',
    :'offline_attributes' => :'offlineAttributes',
    :'phone_authentication' => :'phoneAuthentication',
    :'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',
    :'signer_email' => :'signerEmail',
    :'signer_email_metadata' => :'signerEmailMetadata',
    :'signer_first_name' => :'signerFirstName',
    :'signer_first_name_metadata' => :'signerFirstNameMetadata',
    :'signer_last_name' => :'signerLastName',
    :'signer_last_name_metadata' => :'signerLastNameMetadata',
    :'signer_name' => :'signerName',
    :'signer_name_metadata' => :'signerNameMetadata',
    :'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_typesObject

Attribute type mapping.


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

def self.swagger_types
  {
    :'access_code' => :'String',
    :'access_code_metadata' => :'PropertyMetadata',
    :'add_access_code_to_email' => :'String',
    :'allow_system_override_for_locked_recipient' => :'String',
    :'auto_navigation' => :'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',
    :'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',
    :'embedded_recipient_start_url' => :'String',
    :'error_details' => :'ErrorDetails',
    :'excluded_documents' => :'Array<String>',
    :'fax_number' => :'String',
    :'fax_number_metadata' => :'PropertyMetadata',
    :'host_email' => :'String',
    :'host_email_metadata' => :'PropertyMetadata',
    :'host_name' => :'String',
    :'host_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',
    :'in_person_signing_type' => :'String',
    :'in_person_signing_type_metadata' => :'PropertyMetadata',
    :'locked_recipient_phone_auth_editable' => :'String',
    :'locked_recipient_sms_editable' => :'String',
    :'name' => :'String',
    :'name_metadata' => :'PropertyMetadata',
    :'notary_host' => :'NotaryHost',
    :'note' => :'String',
    :'note_metadata' => :'PropertyMetadata',
    :'offline_attributes' => :'OfflineAttributes',
    :'phone_authentication' => :'RecipientPhoneAuthentication',
    :'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',
    :'signer_email' => :'String',
    :'signer_email_metadata' => :'PropertyMetadata',
    :'signer_first_name' => :'String',
    :'signer_first_name_metadata' => :'PropertyMetadata',
    :'signer_last_name' => :'String',
    :'signer_last_name_metadata' => :'PropertyMetadata',
    :'signer_name' => :'String',
    :'signer_name_metadata' => :'PropertyMetadata',
    :'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.

Parameters:

  • Object (Object)

    to be compared


858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
# File 'lib/docusign_esign/models/in_person_signer.rb', line 858

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 &&
      allow_system_override_for_locked_recipient == o.allow_system_override_for_locked_recipient &&
      auto_navigation == o.auto_navigation &&
      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 &&
      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 &&
      embedded_recipient_start_url == o.embedded_recipient_start_url &&
      error_details == o.error_details &&
      excluded_documents == o.excluded_documents &&
      fax_number == o.fax_number &&
       == o. &&
      host_email == o.host_email &&
       == o. &&
      host_name == o.host_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 &&
      in_person_signing_type == o.in_person_signing_type &&
       == 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_host == o.notary_host &&
      note == o.note &&
       == o. &&
      offline_attributes == o.offline_attributes &&
      phone_authentication == o.phone_authentication &&
      recipient_attachments == o.recipient_attachments &&
      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 &&
      signer_email == o.signer_email &&
       == o. &&
      signer_first_name == o.signer_first_name &&
       == o. &&
      signer_last_name == o.signer_last_name &&
       == o. &&
      signer_name == o.signer_name &&
       == o. &&
       == o. &&
       == 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 &&
      social_authentications == o.social_authentications &&
      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

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
# File 'lib/docusign_esign/models/in_person_signer.rb', line 990

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object)

    Any valid value

Returns:

  • (Hash)

    Returns the value in the form of hash


1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
# File 'lib/docusign_esign/models/in_person_signer.rb', line 1056

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself


969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
# File 'lib/docusign_esign/models/in_person_signer.rb', line 969

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method

956
957
958
# File 'lib/docusign_esign/models/in_person_signer.rb', line 956

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


962
963
964
# File 'lib/docusign_esign/models/in_person_signer.rb', line 962

def hash
  [access_code, , add_access_code_to_email, allow_system_override_for_locked_recipient, auto_navigation, can_sign_offline, client_user_id, completed_count, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, , designator_id, designator_id_guid, document_visibility, email, , email_notification, embedded_recipient_start_url, error_details, excluded_documents, fax_number, , host_email, , host_name, , id_check_configuration_name, , id_check_information_input, identity_verification, inherit_email_notification_configuration, in_person_signing_type, , locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, , notary_host, note, , offline_attributes, phone_authentication, recipient_attachments, 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, signer_email, , signer_first_name, , signer_last_name, , signer_name, , , , signing_group_id, , signing_group_name, signing_group_users, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


845
846
847
848
# File 'lib/docusign_esign/models/in_person_signer.rb', line 845

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


1036
1037
1038
# File 'lib/docusign_esign/models/in_person_signer.rb', line 1036

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


1042
1043
1044
1045
1046
1047
1048
1049
1050
# File 'lib/docusign_esign/models/in_person_signer.rb', line 1042

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


1030
1031
1032
# File 'lib/docusign_esign/models/in_person_signer.rb', line 1030

def to_s
  to_hash.to_s
end

#valid?Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean)

    true if the model is valid


852
853
854
# File 'lib/docusign_esign/models/in_person_signer.rb', line 852

def valid?
  true
end