Class: DocuSign_eSign::SealSign

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

Overview

Specifies one or more electronic seals to apply on documents. An electronic seal recipient is a legal entity rather than an actual person. Electronic Seals can be used by organizations and governments to show evidence of origin and integrity of documents. Even though electronic seals can be represented by a tab in a document, they do not require user interaction and apply automatically in the order specified by the sender. The sender is therefore the person authorizing usage of the electronic seal in the flow. Example: “‘json "recipients": { "seals": [ { "recipientId": "1", "routingOrder" : 1, "recipientSignatureProviders": [ { "sealName": "52e9d968-xxxx-xxxx-xxxx-4682bc45c106" } ] } ] }, . . . “` For more information about Electronic Seals, see [Apply Electronic Seals to Your Documents](support.docusign.com/en/guides/ndse-user-guide-apply-electronic-seals).

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SealSign

Initializes the object

Parameters:

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

    Model attributes in the form of hash



321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
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
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 321

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

  if attributes.has_key?(:'bulkSendV2Recipient')
    self.bulk_send_v2_recipient = attributes[:'bulkSendV2Recipient']
  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?(:'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?(:'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.delivery_method_metadata = 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?(:'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?(:'faxNumber')
    self.fax_number = attributes[:'faxNumber']
  end

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

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

  if attributes.has_key?(:'idCheckConfigurationNameMetadata')
    self.id_check_configuration_name_metadata = 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?(:'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?(:'note')
    self.note = attributes[:'note']
  end

  if attributes.has_key?(:'noteMetadata')
    self.note_metadata = attributes[:'noteMetadata']
  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.recipient_feature_metadata = 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?(:'recipientType')
    self.recipient_type = attributes[:'recipientType']
  end

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

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

  if attributes.has_key?(:'requireIdLookupMetadata')
    self.require_id_lookup_metadata = attributes[:'requireIdLookupMetadata']
  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.routing_order_metadata = attributes[:'routingOrderMetadata']
  end

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

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



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

def access_code
  @access_code
end

#access_code_metadata ⇒ Object

Not applicable.



21
22
23
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 21

def access_code_metadata
  @access_code_metadata
end

#add_access_code_to_email ⇒ Object

This Optional attribute indicates that the access code will be added to the email sent to the recipient; this nullifies the Security measure of Access Code on the recipient.



24
25
26
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 24

def add_access_code_to_email
  @add_access_code_to_email
end

#allow_system_override_for_locked_recipient ⇒ Object

Returns the value of attribute allow_system_override_for_locked_recipient.



27
28
29
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 27

def allow_system_override_for_locked_recipient
  @allow_system_override_for_locked_recipient
end

#auto_responded_reason ⇒ Object

Returns the value of attribute auto_responded_reason.



30
31
32
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 30

def auto_responded_reason
  @auto_responded_reason
end

#bulk_send_v2_recipient ⇒ Object

Returns the value of attribute bulk_send_v2_recipient.



33
34
35
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 33

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



36
37
38
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 36

def client_user_id
  @client_user_id
end

#completed_count ⇒ Object

Returns the value of attribute completed_count.



39
40
41
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 39

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



42
43
44
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 42

def custom_fields
  @custom_fields
end

#declined_date_time ⇒ Object

The date and time the recipient declined the document.



45
46
47
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 45

def declined_date_time
  @declined_date_time
end

#declined_reason ⇒ Object

The reason the recipient declined the document.



48
49
50
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 48

def declined_reason
  @declined_reason
end

#delivered_date_time ⇒ Object

Reserved: For DocuSign use only.



51
52
53
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 51

def delivered_date_time
  @delivered_date_time
end

#delivery_method ⇒ Object

Reserved: For DocuSign use only.



54
55
56
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 54

def delivery_method
  @delivery_method
end

#delivery_method_metadata ⇒ Object

Reserved for DocuSign.



57
58
59
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 57

def delivery_method_metadata
  @delivery_method_metadata
end

#designator_id ⇒ Object

Returns the value of attribute designator_id.



60
61
62
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 60

def designator_id
  @designator_id
end

#designator_id_guid ⇒ Object

Returns the value of attribute designator_id_guid.



63
64
65
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 63

def designator_id_guid
  @designator_id_guid
end

#document_visibility ⇒ Object

Returns the value of attribute document_visibility.



66
67
68
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 66

def document_visibility
  @document_visibility
end

#email_notification ⇒ Object

A complex type that contains information sets the language of the recipient’s email information. IMPORTANT: If you enable email notification for one recipient, you must enable email notification for all recipients as it overrides the Envelope Subject and ‘EmailBlurb` property settings.



69
70
71
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 69

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



72
73
74
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 72

def embedded_recipient_start_url
  @embedded_recipient_start_url
end

#error_details ⇒ Object

Array or errors.



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

def error_details
  @error_details
end

#fax_number ⇒ Object

Reserved:



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

def fax_number
  @fax_number
end

#fax_number_metadata ⇒ Object

Reserved for DocuSign.



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

def fax_number_metadata
  @fax_number_metadata
end

#id_check_configuration_name ⇒ Object

Specifies authentication check by name. The names used here must be the same as the authentication type names used by the account (these name can also be found in the web console sending interface in the Identify list for a recipient,) This overrides any default authentication setting. Example: Your account has ID Check and SMS Authentication available and in the web console Identify list these appear as ‘ID Check $’ and ‘SMS Auth $’. To use ID check in an envelope, the idCheckConfigurationName should be ‘ID Check ’. If you wanted to use SMS, it would be ‘SMS Auth $’ and you would need to add you would need to add phone number information to the ‘smsAuthentication` node.



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

def id_check_configuration_name
  @id_check_configuration_name
end

#id_check_configuration_name_metadata ⇒ Object

Not applicable.



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

def id_check_configuration_name_metadata
  @id_check_configuration_name_metadata
end

#id_check_information_input ⇒ Object

Not applicable.



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

def id_check_information_input
  @id_check_information_input
end

#identity_verification ⇒ Object

Specifies the ID Verification workflow applied on an envelope by workflow ID. <br/>See the [list](/docs/esign-rest-api/reference/accounts/identityverifications/list/) method in the [IdentityVerifications](/docs/esign-rest-api/reference/accounts/identityverifications/) resource for more information on how to retrieve workflow IDs available for an account. <br/>This can be used in addition to other [recipient authentication](support.docusign.com/en/guides/ndse-user-guide-recipient-authentication) methods. <br/>Note that ID Verification and ID Check are two distinct methods. ID Verification checks recipients’ identity by verifying their ID while ID Check relies on data available on public records (such as current and former address).



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

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.



96
97
98
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 96

def inherit_email_notification_configuration
  @inherit_email_notification_configuration
end

#locked_recipient_phone_auth_editable ⇒ Object

Returns the value of attribute locked_recipient_phone_auth_editable.



99
100
101
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 99

def locked_recipient_phone_auth_editable
  @locked_recipient_phone_auth_editable
end

#locked_recipient_sms_editable ⇒ Object

Returns the value of attribute locked_recipient_sms_editable.



102
103
104
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 102

def locked_recipient_sms_editable
  @locked_recipient_sms_editable
end

#name ⇒ Object

Returns the value of attribute name.



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

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.



108
109
110
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 108

def note
  @note
end

#note_metadata ⇒ Object

Not applicable.



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

def note_metadata
  @note_metadata
end

#phone_authentication ⇒ Object

Not applicable.



114
115
116
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 114

def phone_authentication
  @phone_authentication
end

#recipient_attachments ⇒ Object

Reserved:



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

def recipient_attachments
  @recipient_attachments
end

#recipient_authentication_status ⇒ Object

Not applicable.



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

def recipient_authentication_status
  @recipient_authentication_status
end

#recipient_feature_metadata ⇒ Object

Returns the value of attribute recipient_feature_metadata.



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

def recipient_feature_metadata
  @recipient_feature_metadata
end

#recipient_id ⇒ Object

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



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

def recipient_id
  @recipient_id
end

#recipient_id_guid ⇒ Object

Returns the value of attribute recipient_id_guid.



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

def recipient_id_guid
  @recipient_id_guid
end

#recipient_signature_providers ⇒ Object

Returns the value of attribute recipient_signature_providers.



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

def recipient_signature_providers
  @recipient_signature_providers
end

#recipient_type ⇒ Object

Returns the value of attribute recipient_type.



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

def recipient_type
  @recipient_type
end

#recipient_type_metadata ⇒ Object

Metadata that indicates whether the ‘recipientType` property is editable. This property is read-only.



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

def recipient_type_metadata
  @recipient_type_metadata
end

#require_id_lookup ⇒ Object

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



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

def require_id_lookup
  @require_id_lookup
end

#require_id_lookup_metadata ⇒ Object

Not applicable.



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

def require_id_lookup_metadata
  @require_id_lookup_metadata
end

#role_name ⇒ Object

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



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

def role_name
  @role_name
end

#routing_order ⇒ Object

Specifies the routing order of the recipient in the envelope.



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

def routing_order
  @routing_order
end

#routing_order_metadata ⇒ Object

Metadata that indicates whether the ‘routingOrder` property is editable. This property is read-only.



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

def routing_order_metadata
  @routing_order_metadata
end

#sent_date_time ⇒ Object

The date and time the envelope was sent.



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

def sent_date_time
  @sent_date_time
end

#signed_date_time ⇒ Object

Reserved: For DocuSign use only.



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

def signed_date_time
  @signed_date_time
end

#sms_authentication ⇒ Object

Not applicable.



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

def sms_authentication
  @sms_authentication
end

#social_authentications ⇒ Object

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



165
166
167
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 165

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.



168
169
170
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 168

def status
  @status
end

#status_code ⇒ Object

Returns the value of attribute status_code.



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

def status_code
  @status_code
end

#suppress_emails ⇒ Object

Returns the value of attribute suppress_emails.



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

def suppress_emails
  @suppress_emails
end

#tabs ⇒ Object

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.



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

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.



180
181
182
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 180

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.



183
184
185
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 183

def template_required
  @template_required
end

#total_tab_count ⇒ Object

Returns the value of attribute total_tab_count.



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

def total_tab_count
  @total_tab_count
end

#user_id ⇒ Object

Returns the value of attribute user_id.



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

def user_id
  @user_id
end

Class Method Details

.attribute_map ⇒ Object

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



192
193
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
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 192

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_responded_reason' => :'autoRespondedReason',
    :'bulk_send_v2_recipient' => :'bulkSendV2Recipient',
    :'client_user_id' => :'clientUserId',
    :'completed_count' => :'completedCount',
    :'custom_fields' => :'customFields',
    :'declined_date_time' => :'declinedDateTime',
    :'declined_reason' => :'declinedReason',
    :'delivered_date_time' => :'deliveredDateTime',
    :'delivery_method' => :'deliveryMethod',
    :'delivery_method_metadata' => :'deliveryMethodMetadata',
    :'designator_id' => :'designatorId',
    :'designator_id_guid' => :'designatorIdGuid',
    :'document_visibility' => :'documentVisibility',
    :'email_notification' => :'emailNotification',
    :'embedded_recipient_start_url' => :'embeddedRecipientStartURL',
    :'error_details' => :'errorDetails',
    :'fax_number' => :'faxNumber',
    :'fax_number_metadata' => :'faxNumberMetadata',
    :'id_check_configuration_name' => :'idCheckConfigurationName',
    :'id_check_configuration_name_metadata' => :'idCheckConfigurationNameMetadata',
    :'id_check_information_input' => :'idCheckInformationInput',
    :'identity_verification' => :'identityVerification',
    :'inherit_email_notification_configuration' => :'inheritEmailNotificationConfiguration',
    :'locked_recipient_phone_auth_editable' => :'lockedRecipientPhoneAuthEditable',
    :'locked_recipient_sms_editable' => :'lockedRecipientSmsEditable',
    :'name' => :'name',
    :'note' => :'note',
    :'note_metadata' => :'noteMetadata',
    :'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_type' => :'recipientType',
    :'recipient_type_metadata' => :'recipientTypeMetadata',
    :'require_id_lookup' => :'requireIdLookup',
    :'require_id_lookup_metadata' => :'requireIdLookupMetadata',
    :'role_name' => :'roleName',
    :'routing_order' => :'routingOrder',
    :'routing_order_metadata' => :'routingOrderMetadata',
    :'sent_date_time' => :'sentDateTime',
    :'signed_date_time' => :'signedDateTime',
    :'sms_authentication' => :'smsAuthentication',
    :'social_authentications' => :'socialAuthentications',
    :'status' => :'status',
    :'status_code' => :'statusCode',
    :'suppress_emails' => :'suppressEmails',
    :'tabs' => :'tabs',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'total_tab_count' => :'totalTabCount',
    :'user_id' => :'userId'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 256

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_responded_reason' => :'String',
    :'bulk_send_v2_recipient' => :'String',
    :'client_user_id' => :'String',
    :'completed_count' => :'String',
    :'custom_fields' => :'Array<String>',
    :'declined_date_time' => :'String',
    :'declined_reason' => :'String',
    :'delivered_date_time' => :'String',
    :'delivery_method' => :'String',
    :'delivery_method_metadata' => :'PropertyMetadata',
    :'designator_id' => :'String',
    :'designator_id_guid' => :'String',
    :'document_visibility' => :'Array<DocumentVisibility>',
    :'email_notification' => :'RecipientEmailNotification',
    :'embedded_recipient_start_url' => :'String',
    :'error_details' => :'ErrorDetails',
    :'fax_number' => :'String',
    :'fax_number_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',
    :'locked_recipient_phone_auth_editable' => :'String',
    :'locked_recipient_sms_editable' => :'String',
    :'name' => :'String',
    :'note' => :'String',
    :'note_metadata' => :'PropertyMetadata',
    :'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_type' => :'String',
    :'recipient_type_metadata' => :'PropertyMetadata',
    :'require_id_lookup' => :'String',
    :'require_id_lookup_metadata' => :'PropertyMetadata',
    :'role_name' => :'String',
    :'routing_order' => :'String',
    :'routing_order_metadata' => :'PropertyMetadata',
    :'sent_date_time' => :'String',
    :'signed_date_time' => :'String',
    :'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



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_code == o.access_code &&
      access_code_metadata == o.access_code_metadata &&
      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_responded_reason == o.auto_responded_reason &&
      bulk_send_v2_recipient == o.bulk_send_v2_recipient &&
      client_user_id == o.client_user_id &&
      completed_count == o.completed_count &&
      custom_fields == o.custom_fields &&
      declined_date_time == o.declined_date_time &&
      declined_reason == o.declined_reason &&
      delivered_date_time == o.delivered_date_time &&
      delivery_method == o.delivery_method &&
      delivery_method_metadata == o.delivery_method_metadata &&
      designator_id == o.designator_id &&
      designator_id_guid == o.designator_id_guid &&
      document_visibility == o.document_visibility &&
      email_notification == o.email_notification &&
      embedded_recipient_start_url == o.embedded_recipient_start_url &&
      error_details == o.error_details &&
      fax_number == o.fax_number &&
      fax_number_metadata == o.fax_number_metadata &&
      id_check_configuration_name == o.id_check_configuration_name &&
      id_check_configuration_name_metadata == o.id_check_configuration_name_metadata &&
      id_check_information_input == o.id_check_information_input &&
      identity_verification == o.identity_verification &&
      inherit_email_notification_configuration == o.inherit_email_notification_configuration &&
      locked_recipient_phone_auth_editable == o.locked_recipient_phone_auth_editable &&
      locked_recipient_sms_editable == o.locked_recipient_sms_editable &&
      name == o.name &&
      note == o.note &&
      note_metadata == o.note_metadata &&
      phone_authentication == o.phone_authentication &&
      recipient_attachments == o.recipient_attachments &&
      recipient_authentication_status == o.recipient_authentication_status &&
      recipient_feature_metadata == o.recipient_feature_metadata &&
      recipient_id == o.recipient_id &&
      recipient_id_guid == o.recipient_id_guid &&
      recipient_signature_providers == o.recipient_signature_providers &&
      recipient_type == o.recipient_type &&
      recipient_type_metadata == o.recipient_type_metadata &&
      require_id_lookup == o.require_id_lookup &&
      require_id_lookup_metadata == o.require_id_lookup_metadata &&
      role_name == o.role_name &&
      routing_order == o.routing_order &&
      routing_order_metadata == o.routing_order_metadata &&
      sent_date_time == o.sent_date_time &&
      signed_date_time == o.signed_date_time &&
      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



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

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



752
753
754
755
756
757
758
759
760
761
762
763
764
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 752

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



665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 665

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


652
653
654
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 652

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



658
659
660
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 658

def hash
  [access_code, access_code_metadata, add_access_code_to_email, allow_system_override_for_locked_recipient, auto_responded_reason, bulk_send_v2_recipient, client_user_id, completed_count, custom_fields, declined_date_time, declined_reason, delivered_date_time, delivery_method, delivery_method_metadata, designator_id, designator_id_guid, document_visibility, email_notification, embedded_recipient_start_url, error_details, fax_number, fax_number_metadata, id_check_configuration_name, id_check_configuration_name_metadata, id_check_information_input, identity_verification, inherit_email_notification_configuration, locked_recipient_phone_auth_editable, locked_recipient_sms_editable, name, note, note_metadata, phone_authentication, recipient_attachments, recipient_authentication_status, recipient_feature_metadata, recipient_id, recipient_id_guid, recipient_signature_providers, recipient_type, recipient_type_metadata, require_id_lookup, require_id_lookup_metadata, role_name, routing_order, routing_order_metadata, sent_date_time, signed_date_time, sms_authentication, social_authentications, status, status_code, suppress_emails, tabs, template_locked, template_required, total_tab_count, user_id].hash
end

#list_invalid_properties ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



574
575
576
577
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 574

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



732
733
734
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 732

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



738
739
740
741
742
743
744
745
746
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 738

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



726
727
728
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 726

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



581
582
583
 
# File 'lib/docusign_esign/models/seal_sign.rb', line 581

def valid?
  true
end