Class: DocuSign_eSign::Signer

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Signer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
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
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
 
# File 'lib/docusign_esign/models/signer.rb', line 333

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?(:'addAccessCodeToEmail')
    self.add_access_code_to_email = attributes[:'addAccessCodeToEmail']
  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?(:'autoNavigation')
    self.auto_navigation = attributes[:'autoNavigation']
  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?(:'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?(:'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?(:'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.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?(:'firstName')
    self.first_name = attributes[:'firstName']
  end

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

  if attributes.has_key?(:'idCheckConfigurationName')
    self.id_check_configuration_name = attributes[:'idCheckConfigurationName']
  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?(:'lastName')
    self.last_name = attributes[:'lastName']
  end

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

  if attributes.has_key?(:'note')
    self.note = attributes[:'note']
  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?(:'proofFile')
    self.proof_file = attributes[:'proofFile']
  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?(:'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?(:'requireIdLookup')
    self.require_id_lookup = attributes[:'requireIdLookup']
  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?(:'roleName')
    self.role_name = attributes[:'roleName']
  end

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

  if attributes.has_key?(:'samlAuthentication')
    self.saml_authentication = attributes[:'samlAuthentication']
  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. = attributes[:'signInEachLocation']
  end

  if attributes.has_key?(:'signingGroupId')
    self.signing_group_id = attributes[:'signingGroupId']
  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?(:'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

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



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

def add_access_code_to_email
  @add_access_code_to_email
end

#agent_can_edit_email ⇒ Object

Returns the value of attribute agent_can_edit_email.



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

def agent_can_edit_email
  @agent_can_edit_email
end

#agent_can_edit_name ⇒ Object

Returns the value of attribute agent_can_edit_name.



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

def agent_can_edit_name
  @agent_can_edit_name
end

#auto_navigation ⇒ Object

Returns the value of attribute auto_navigation.



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

def auto_navigation
  @auto_navigation
end

#bulk_recipients_uri ⇒ Object

Contains a URI for an endpoint that allows you to easily retrieve bulk recipient information.



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

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.



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

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.



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

def client_user_id
  @client_user_id
end

#creation_reason ⇒ Object

Returns the value of attribute creation_reason.



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

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.



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

def custom_fields
  @custom_fields
end

#declined_date_time ⇒ Object

The date and time the recipient declined the document.



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

def declined_date_time
  @declined_date_time
end

#declined_reason ⇒ Object

The reason the recipient declined the document.



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

def declined_reason
  @declined_reason
end

#default_recipient ⇒ Object

Returns the value of attribute default_recipient.



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

def default_recipient
  @default_recipient
end

#delivered_date_time ⇒ Object

Reserved: For DocuSign use only.



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

def delivered_date_time
  @delivered_date_time
end

#delivery_method ⇒ Object

Reserved: For DocuSign use only.



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

def delivery_method
  @delivery_method
end

#document_visibility ⇒ Object

Returns the value of attribute document_visibility.



62
63
64
 
# File 'lib/docusign_esign/models/signer.rb', line 62

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.



65
66
67
 
# File 'lib/docusign_esign/models/signer.rb', line 65

def email
  @email
end

#email_notification ⇒ Object

Returns the value of attribute email_notification.



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

def email_notification
  @email_notification
end

#email_recipient_post_signing_url ⇒ Object

Returns the value of attribute email_recipient_post_signing_url.



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

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



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

def embedded_recipient_start_url
  @embedded_recipient_start_url
end

#error_details ⇒ Object

Returns the value of attribute error_details.



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

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.



78
79
80
 
# File 'lib/docusign_esign/models/signer.rb', line 78

def excluded_documents
  @excluded_documents
end

#fax_number ⇒ Object

Reserved:



81
82
83
 
# File 'lib/docusign_esign/models/signer.rb', line 81

def fax_number
  @fax_number
end

#first_name ⇒ Object

The user’s first name. Maximum Length: 50 characters.



84
85
86
 
# File 'lib/docusign_esign/models/signer.rb', line 84

def first_name
  @first_name
end

#full_name ⇒ Object

Returns the value of attribute full_name.



87
88
89
 
# File 'lib/docusign_esign/models/signer.rb', line 87

def full_name
  @full_name
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.



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

def id_check_configuration_name
  @id_check_configuration_name
end

#id_check_information_input ⇒ Object

Returns the value of attribute id_check_information_input.



92
93
94
 
# File 'lib/docusign_esign/models/signer.rb', line 92

def id_check_information_input
  @id_check_information_input
end

#identity_verification ⇒ Object

Returns the value of attribute identity_verification.



94
95
96
 
# File 'lib/docusign_esign/models/signer.rb', line 94

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.



97
98
99
 
# File 'lib/docusign_esign/models/signer.rb', line 97

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.



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

def is_bulk_recipient
  @is_bulk_recipient
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#name ⇒ Object

Returns the value of attribute name.



106
107
108
 
# File 'lib/docusign_esign/models/signer.rb', line 106

def name
  @name
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.



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

def note
  @note
end

#offline_attributes ⇒ Object

Returns the value of attribute offline_attributes.



111
112
113
 
# File 'lib/docusign_esign/models/signer.rb', line 111

def offline_attributes
  @offline_attributes
end

#phone_authentication ⇒ Object

Returns the value of attribute phone_authentication.



113
114
115
 
# File 'lib/docusign_esign/models/signer.rb', line 113

def phone_authentication
  @phone_authentication
end

#proof_file ⇒ Object

Returns the value of attribute proof_file.



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

def proof_file
  @proof_file
end

#recipient_attachments ⇒ Object

Reserved:



118
119
120
 
# File 'lib/docusign_esign/models/signer.rb', line 118

def recipient_attachments
  @recipient_attachments
end

#recipient_authentication_status ⇒ Object

Returns the value of attribute recipient_authentication_status.



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

def recipient_authentication_status
  @recipient_authentication_status
end

#recipient_id ⇒ Object

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



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

def recipient_id
  @recipient_id
end

#recipient_id_guid ⇒ Object

Returns the value of attribute recipient_id_guid.



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

def recipient_id_guid
  @recipient_id_guid
end

#recipient_signature_providers ⇒ Object

Returns the value of attribute recipient_signature_providers.



129
130
131
 
# File 'lib/docusign_esign/models/signer.rb', line 129

def recipient_signature_providers
  @recipient_signature_providers
end

#recipient_supplies_tabs ⇒ Object

Returns the value of attribute recipient_supplies_tabs.



132
133
134
 
# File 'lib/docusign_esign/models/signer.rb', line 132

def recipient_supplies_tabs
  @recipient_supplies_tabs
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.



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

def require_id_lookup
  @require_id_lookup
end

#require_sign_on_paper ⇒ Object

When set to true, the signer must print, sign, and upload or fax the signed documents to DocuSign.



141
142
143
 
# File 'lib/docusign_esign/models/signer.rb', line 141

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.



138
139
140
 
# File 'lib/docusign_esign/models/signer.rb', line 138

def require_signer_certificate
  @require_signer_certificate
end

#role_name ⇒ Object

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



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

def role_name
  @role_name
end

#routing_order ⇒ Object

Specifies the routing order of the recipient in the envelope.



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

def routing_order
  @routing_order
end

#saml_authentication ⇒ Object

Returns the value of attribute saml_authentication.



149
150
151
 
# File 'lib/docusign_esign/models/signer.rb', line 149

def saml_authentication
  @saml_authentication
end

#sent_date_time ⇒ Object

The date and time the envelope was sent.



152
153
154
 
# File 'lib/docusign_esign/models/signer.rb', line 152

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.



160
161
162
 
# File 'lib/docusign_esign/models/signer.rb', line 160

def 
  @sign_in_each_location
end

#signature_info ⇒ Object

Returns the value of attribute signature_info.



154
155
156
 
# File 'lib/docusign_esign/models/signer.rb', line 154

def signature_info
  @signature_info
end

#signed_date_time ⇒ Object

Reserved: For DocuSign use only.



157
158
159
 
# File 'lib/docusign_esign/models/signer.rb', line 157

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



163
164
165
 
# File 'lib/docusign_esign/models/signer.rb', line 163

def signing_group_id
  @signing_group_id
end

#signing_group_name ⇒ Object

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



166
167
168
 
# File 'lib/docusign_esign/models/signer.rb', line 166

def signing_group_name
  @signing_group_name
end

#signing_group_users ⇒ Object

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



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

def signing_group_users
  @signing_group_users
end

#sms_authentication ⇒ Object

Returns the value of attribute sms_authentication.



171
172
173
 
# File 'lib/docusign_esign/models/signer.rb', line 171

def sms_authentication
  @sms_authentication
end

#social_authentications ⇒ Object

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



174
175
176
 
# File 'lib/docusign_esign/models/signer.rb', line 174

def social_authentications
  @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.



177
178
179
 
# File 'lib/docusign_esign/models/signer.rb', line 177

def status
  @status
end

#tabs ⇒ Object

Returns the value of attribute tabs.



179
180
181
 
# File 'lib/docusign_esign/models/signer.rb', line 179

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.



182
183
184
 
# File 'lib/docusign_esign/models/signer.rb', line 182

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.



185
186
187
 
# File 'lib/docusign_esign/models/signer.rb', line 185

def template_required
  @template_required
end

#total_tab_count ⇒ Object

Returns the value of attribute total_tab_count.



188
189
190
 
# File 'lib/docusign_esign/models/signer.rb', line 188

def total_tab_count
  @total_tab_count
end

#user_id ⇒ Object

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
 
# File 'lib/docusign_esign/models/signer.rb', line 194

def self.attribute_map
  {
    :'access_code' => :'accessCode',
    :'add_access_code_to_email' => :'addAccessCodeToEmail',
    :'agent_can_edit_email' => :'agentCanEditEmail',
    :'agent_can_edit_name' => :'agentCanEditName',
    :'auto_navigation' => :'autoNavigation',
    :'bulk_recipients_uri' => :'bulkRecipientsUri',
    :'can_sign_offline' => :'canSignOffline',
    :'client_user_id' => :'clientUserId',
    :'creation_reason' => :'creationReason',
    :'custom_fields' => :'customFields',
    :'declined_date_time' => :'declinedDateTime',
    :'declined_reason' => :'declinedReason',
    :'default_recipient' => :'defaultRecipient',
    :'delivered_date_time' => :'deliveredDateTime',
    :'delivery_method' => :'deliveryMethod',
    :'document_visibility' => :'documentVisibility',
    :'email' => :'email',
    :'email_notification' => :'emailNotification',
    :'email_recipient_post_signing_url' => :'emailRecipientPostSigningURL',
    :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
    :'error_details' => :'errorDetails',
    :'excluded_documents' => :'excludedDocuments',
    :'fax_number' => :'faxNumber',
    :'first_name' => :'firstName',
    :'full_name' => :'fullName',
    :'id_check_configuration_name' => :'idCheckConfigurationName',
    :'id_check_information_input' => :'idCheckInformationInput',
    :'identity_verification' => :'identityVerification',
    :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
    :'is_bulk_recipient' => :'isBulkRecipient',
    :'last_name' => :'lastName',
    :'name' => :'name',
    :'note' => :'note',
    :'offline_attributes' => :'offlineAttributes',
    :'phone_authentication' => :'phoneAuthentication',
    :'proof_file' => :'proofFile',
    :'recipient_attachments' => :'recipientAttachments',
    :'recipient_authentication_status' => :'recipientAuthenticationStatus',
    :'recipient_id' => :'recipientId',
    :'recipient_id_guid' => :'recipientIdGuid',
    :'recipient_signature_providers' => :'recipientSignatureProviders',
    :'recipient_supplies_tabs' => :'recipientSuppliesTabs',
    :'require_id_lookup' => :'requireIdLookup',
    :'require_signer_certificate' => :'requireSignerCertificate',
    :'require_sign_on_paper' => :'requireSignOnPaper',
    :'role_name' => :'roleName',
    :'routing_order' => :'routingOrder',
    :'saml_authentication' => :'samlAuthentication',
    :'sent_date_time' => :'sentDateTime',
    :'signature_info' => :'signatureInfo',
    :'signed_date_time' => :'signedDateTime',
    :'sign_in_each_location' => :'signInEachLocation',
    :'signing_group_id' => :'signingGroupId',
    :'signing_group_name' => :'signingGroupName',
    :'signing_group_users' => :'signingGroupUsers',
    :'sms_authentication' => :'smsAuthentication',
    :'social_authentications' => :'socialAuthentications',
    :'status' => :'status',
    :'tabs' => :'tabs',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'total_tab_count' => :'totalTabCount',
    :'user_id' => :'userId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'access_code' => :'String',
    :'add_access_code_to_email' => :'String',
    :'agent_can_edit_email' => :'String',
    :'agent_can_edit_name' => :'String',
    :'auto_navigation' => :'String',
    :'bulk_recipients_uri' => :'String',
    :'can_sign_offline' => :'String',
    :'client_user_id' => :'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',
    :'document_visibility' => :'Array<DocumentVisibility>',
    :'email' => :'String',
    :'email_notification' => :'RecipientEmailNotification',
    :'email_recipient_post_signing_url' => :'String',
    :'embedded_recipient_start_url' => :'String',
    :'error_details' => :'ErrorDetails',
    :'excluded_documents' => :'Array<String>',
    :'fax_number' => :'String',
    :'first_name' => :'String',
    :'full_name' => :'String',
    :'id_check_configuration_name' => :'String',
    :'id_check_information_input' => :'IdCheckInformationInput',
    :'identity_verification' => :'RecipientIdentityVerification',
    :'inherit_email_notification_configuration' => :'String',
    :'is_bulk_recipient' => :'String',
    :'last_name' => :'String',
    :'name' => :'String',
    :'note' => :'String',
    :'offline_attributes' => :'OfflineAttributes',
    :'phone_authentication' => :'RecipientPhoneAuthentication',
    :'proof_file' => :'RecipientProofFile',
    :'recipient_attachments' => :'Array<RecipientAttachment>',
    :'recipient_authentication_status' => :'AuthenticationStatus',
    :'recipient_id' => :'String',
    :'recipient_id_guid' => :'String',
    :'recipient_signature_providers' => :'Array<RecipientSignatureProvider>',
    :'recipient_supplies_tabs' => :'String',
    :'require_id_lookup' => :'String',
    :'require_signer_certificate' => :'String',
    :'require_sign_on_paper' => :'String',
    :'role_name' => :'String',
    :'routing_order' => :'String',
    :'saml_authentication' => :'RecipientSAMLAuthentication',
    :'sent_date_time' => :'String',
    :'signature_info' => :'RecipientSignatureInformation',
    :'signed_date_time' => :'String',
    :'sign_in_each_location' => :'String',
    :'signing_group_id' => :'String',
    :'signing_group_name' => :'String',
    :'signing_group_users' => :'Array<UserInfo>',
    :'sms_authentication' => :'RecipientSMSAuthentication',
    :'social_authentications' => :'Array<SocialAuthentication>',
    :'status' => :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      add_access_code_to_email == o.add_access_code_to_email &&
      agent_can_edit_email == o.agent_can_edit_email &&
      agent_can_edit_name == o.agent_can_edit_name &&
      auto_navigation == o.auto_navigation &&
      bulk_recipients_uri == o.bulk_recipients_uri &&
      can_sign_offline == o.can_sign_offline &&
      client_user_id == o.client_user_id &&
      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 &&
      document_visibility == o.document_visibility &&
      email == o.email &&
      email_notification == o.email_notification &&
      email_recipient_post_signing_url == o.email_recipient_post_signing_url &&
      embedded_recipient_start_url == o.embedded_recipient_start_url &&
      error_details == o.error_details &&
      excluded_documents == o.excluded_documents &&
      fax_number == o.fax_number &&
      first_name == o.first_name &&
      full_name == o.full_name &&
      id_check_configuration_name == o.id_check_configuration_name &&
      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 &&
      last_name == o.last_name &&
      name == o.name &&
      note == o.note &&
      offline_attributes == o.offline_attributes &&
      phone_authentication == o.phone_authentication &&
      proof_file == o.proof_file &&
      recipient_attachments == o.recipient_attachments &&
      recipient_authentication_status == o.recipient_authentication_status &&
      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 &&
      require_id_lookup == o.require_id_lookup &&
      require_signer_certificate == o.require_signer_certificate &&
      require_sign_on_paper == o.require_sign_on_paper &&
      role_name == o.role_name &&
      routing_order == o.routing_order &&
      saml_authentication == o.saml_authentication &&
      sent_date_time == o.sent_date_time &&
      signature_info == o.signature_info &&
      signed_date_time == o.signed_date_time &&
       == o. &&
      signing_group_id == o.signing_group_id &&
      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 &&
      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



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

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



791
792
793
794
795
796
797
798
799
800
801
802
803
 
# File 'lib/docusign_esign/models/signer.rb', line 791

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



704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
 
# File 'lib/docusign_esign/models/signer.rb', line 704

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


691
692
693
 
# File 'lib/docusign_esign/models/signer.rb', line 691

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



697
698
699
 
# File 'lib/docusign_esign/models/signer.rb', line 697

def hash
  [access_code, add_access_code_to_email, agent_can_edit_email, agent_can_edit_name, auto_navigation, bulk_recipients_uri, can_sign_offline, client_user_id, creation_reason, custom_fields, declined_date_time, declined_reason, default_recipient, delivered_date_time, delivery_method, document_visibility, email, email_notification, email_recipient_post_signing_url, embedded_recipient_start_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, name, note, offline_attributes, phone_authentication, proof_file, recipient_attachments, recipient_authentication_status, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_supplies_tabs, require_id_lookup, require_signer_certificate, require_sign_on_paper, role_name, routing_order, saml_authentication, sent_date_time, signature_info, signed_date_time, , signing_group_id, signing_group_name, signing_group_users, sms_authentication, social_authentications, status, 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?

Returns:

  • Array for valid properties with the reasons



608
609
610
611
 
# File 'lib/docusign_esign/models/signer.rb', line 608

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



771
772
773
 
# File 'lib/docusign_esign/models/signer.rb', line 771

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



777
778
779
780
781
782
783
784
785
 
# File 'lib/docusign_esign/models/signer.rb', line 777

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

Returns:

  • (String) —

    String presentation of the object



765
766
767
 
# File 'lib/docusign_esign/models/signer.rb', line 765

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



615
616
617
 
# File 'lib/docusign_esign/models/signer.rb', line 615

def valid?
  true
end