Class: DocuSign_eSign::Envelope

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Envelope

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'envelopeAttachments')
    if (value = attributes[:'envelopeAttachments']).is_a?(Array)
      self.envelope_attachments = value
    end
  end

  if attributes.has_key?(:'envelopeDocuments')
    if (value = attributes[:'envelopeDocuments']).is_a?(Array)
      self.envelope_documents = value
    end
  end

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'folders')
    if (value = attributes[:'folders']).is_a?(Array)
      self.folders = value
    end
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#access_control_list_base64Object

Returns the value of attribute access_control_list_base64


17
18
19
# File 'lib/docusign_esign/models/envelope.rb', line 17

def access_control_list_base64
  @access_control_list_base64
end

#allow_commentsObject

Returns the value of attribute allow_comments


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

def allow_comments
  @allow_comments
end

#allow_markupObject

When set to *true*, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this


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

def allow_markup
  @allow_markup
end

#allow_reassignObject

When set to *true*, the recipient can redirect an envelope to a more appropriate recipient.


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

def allow_reassign
  @allow_reassign
end

#allow_view_historyObject

Returns the value of attribute allow_view_history


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

def allow_view_history
  @allow_view_history
end

#any_signerObject

Returns the value of attribute any_signer


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

def any_signer
  @any_signer
end

#asynchronousObject

When set to *true*, the envelope is queued for processing and the value of the `status` property is set to 'Processing'. Additionally, get status calls return 'Processing' until completed.


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

def asynchronous
  @asynchronous
end

#attachments_uriObject

Returns the value of attribute attachments_uri


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

def attachments_uri
  @attachments_uri
end

#authoritative_copyObject

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.


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

def authoritative_copy
  @authoritative_copy
end

#authoritative_copy_defaultObject

Returns the value of attribute authoritative_copy_default


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

def authoritative_copy_default
  @authoritative_copy_default
end

#auto_navigationObject

Returns the value of attribute auto_navigation


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

def auto_navigation
  @auto_navigation
end

#brand_idObject

Returns the value of attribute brand_id


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

def brand_id
  @brand_id
end

#brand_lockObject

Returns the value of attribute brand_lock


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

def brand_lock
  @brand_lock
end

#certificate_uriObject

Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.


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

def certificate_uri
  @certificate_uri
end

#completed_date_timeObject

Specifies the date and time this item was completed.


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

def completed_date_time
  @completed_date_time
end

#copy_recipient_dataObject

Returns the value of attribute copy_recipient_data


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

def copy_recipient_data
  @copy_recipient_data
end

#created_date_timeObject

Indicates the date and time the item was created.


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

def created_date_time
  @created_date_time
end

#custom_fieldsObject

Returns the value of attribute custom_fields


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

def custom_fields
  @custom_fields
end

#custom_fields_uriObject

Contains a URI for an endpoint that you can use to retrieve the custom fields.


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

def custom_fields_uri
  @custom_fields_uri
end

#declined_date_timeObject

The date and time the recipient declined the document.


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

def declined_date_time
  @declined_date_time
end

#deleted_date_timeObject

Specifies the data and time the item was deleted.


76
77
78
# File 'lib/docusign_esign/models/envelope.rb', line 76

def deleted_date_time
  @deleted_date_time
end

#delivered_date_timeObject

Reserved: For DocuSign use only.


79
80
81
# File 'lib/docusign_esign/models/envelope.rb', line 79

def delivered_date_time
  @delivered_date_time
end

#disable_responsive_documentObject

Returns the value of attribute disable_responsive_document


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

def disable_responsive_document
  @disable_responsive_document
end

#documents_combined_uriObject

Returns the value of attribute documents_combined_uri


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

def documents_combined_uri
  @documents_combined_uri
end

#documents_uriObject

Contains a URI for an endpoint that you can use to retrieve the documents.


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

def documents_uri
  @documents_uri
end

#email_blurbObject

This is the same as the email body. If specified it is included in email body for all envelope recipients.


91
92
93
# File 'lib/docusign_esign/models/envelope.rb', line 91

def email_blurb
  @email_blurb
end

#email_settingsObject

Returns the value of attribute email_settings


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

def email_settings
  @email_settings
end

#email_subjectObject

Specifies the subject of the email that is sent to all recipients. See [ML:Template Email Subject Merge Fields] for information about adding merge field information to the email subject.


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

def email_subject
  @email_subject
end

#enable_wet_signObject

When set to *true*, the signer is allowed to print the document and sign it on paper.


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

def enable_wet_sign
  @enable_wet_sign
end

#enforce_signer_visibilityObject

When set to *true*, 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. Your account must have Document Visibility enabled to use this.


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

def enforce_signer_visibility
  @enforce_signer_visibility
end

#envelope_attachmentsObject

Returns the value of attribute envelope_attachments


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

def envelope_attachments
  @envelope_attachments
end

#envelope_documentsObject

Returns the value of attribute envelope_documents


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

def envelope_documents
  @envelope_documents
end

#envelope_idObject

The envelope ID of the envelope status that failed to post.


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

def envelope_id
  @envelope_id
end

#envelope_id_stampingObject

When set to *true*, Envelope ID Stamping is enabled.


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

def envelope_id_stamping
  @envelope_id_stamping
end

#envelope_locationObject

Returns the value of attribute envelope_location


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

def envelope_location
  @envelope_location
end

#envelope_metadataObject

Returns the value of attribute envelope_metadata


119
120
121
# File 'lib/docusign_esign/models/envelope.rb', line 119

def 
  @envelope_metadata
end

#envelope_uriObject

Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.


122
123
124
# File 'lib/docusign_esign/models/envelope.rb', line 122

def envelope_uri
  @envelope_uri
end

#expire_afterObject

Returns the value of attribute expire_after


125
126
127
# File 'lib/docusign_esign/models/envelope.rb', line 125

def expire_after
  @expire_after
end

#expire_date_timeObject

Returns the value of attribute expire_date_time


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

def expire_date_time
  @expire_date_time
end

#expire_enabledObject

Returns the value of attribute expire_enabled


131
132
133
# File 'lib/docusign_esign/models/envelope.rb', line 131

def expire_enabled
  @expire_enabled
end

#external_envelope_idObject

Returns the value of attribute external_envelope_id


134
135
136
# File 'lib/docusign_esign/models/envelope.rb', line 134

def external_envelope_id
  @external_envelope_id
end

#foldersObject

Returns the value of attribute folders


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

def folders
  @folders
end

#has_commentsObject

Returns the value of attribute has_comments


140
141
142
# File 'lib/docusign_esign/models/envelope.rb', line 140

def has_comments
  @has_comments
end

#has_form_data_changedObject

Returns the value of attribute has_form_data_changed


143
144
145
# File 'lib/docusign_esign/models/envelope.rb', line 143

def has_form_data_changed
  @has_form_data_changed
end

#has_wav_fileObject

Returns the value of attribute has_wav_file


146
147
148
# File 'lib/docusign_esign/models/envelope.rb', line 146

def has_wav_file
  @has_wav_file
end

#holderObject

Returns the value of attribute holder


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

def holder
  @holder
end

#initial_sent_date_timeObject

Returns the value of attribute initial_sent_date_time


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

def initial_sent_date_time
  @initial_sent_date_time
end

#is21_cfr_part11Object

When set to *true*, indicates that this module is enabled on the account.


155
156
157
# File 'lib/docusign_esign/models/envelope.rb', line 155

def is21_cfr_part11
  @is21_cfr_part11
end

#is_dynamic_envelopeObject

Returns the value of attribute is_dynamic_envelope


158
159
160
# File 'lib/docusign_esign/models/envelope.rb', line 158

def is_dynamic_envelope
  @is_dynamic_envelope
end

#is_signature_provider_envelopeObject

Returns the value of attribute is_signature_provider_envelope


161
162
163
# File 'lib/docusign_esign/models/envelope.rb', line 161

def is_signature_provider_envelope
  @is_signature_provider_envelope
end

#last_modified_date_timeObject

The date and time the item was last modified.


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

def last_modified_date_time
  @last_modified_date_time
end

#locationObject

Returns the value of attribute location


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

def location
  @location
end

#lock_informationObject

Returns the value of attribute lock_information


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

def lock_information
  @lock_information
end

#message_lockObject

When set to *true*, prevents senders from changing the contents of `emailBlurb` and `emailSubject` properties for the envelope. Additionally, this prevents users from making changes to the contents of `emailBlurb` and `emailSubject` properties when correcting envelopes. However, if the `messageLock` node is set to true**** and the `emailSubject` property is empty, senders and correctors are able to add a subject to the envelope.


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

def message_lock
  @message_lock
end

#notificationObject

Returns the value of attribute notification


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

def notification
  @notification
end

#notification_uriObject

Contains a URI for an endpoint that you can use to retrieve the notifications.


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

def notification_uri
  @notification_uri
end

#power_formObject

Returns the value of attribute power_form


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

def power_form
  @power_form
end

#purge_completed_dateObject

Returns the value of attribute purge_completed_date


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

def purge_completed_date
  @purge_completed_date
end

#purge_request_dateObject

Returns the value of attribute purge_request_date


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

def purge_request_date
  @purge_request_date
end

#purge_stateObject

Returns the value of attribute purge_state


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

def purge_state
  @purge_state
end

#recipientsObject

Returns the value of attribute recipients


190
191
192
# File 'lib/docusign_esign/models/envelope.rb', line 190

def recipients
  @recipients
end

#recipients_lockObject

When set to *true*, prevents senders from changing, correcting, or deleting the recipient information for the envelope.


193
194
195
# File 'lib/docusign_esign/models/envelope.rb', line 193

def recipients_lock
  @recipients_lock
end

#recipients_uriObject

Contains a URI for an endpoint that you can use to retrieve the recipients.


196
197
198
# File 'lib/docusign_esign/models/envelope.rb', line 196

def recipients_uri
  @recipients_uri
end

#senderObject

Returns the value of attribute sender


198
199
200
# File 'lib/docusign_esign/models/envelope.rb', line 198

def sender
  @sender
end

#sent_date_timeObject

The date and time the envelope was sent.


201
202
203
# File 'lib/docusign_esign/models/envelope.rb', line 201

def sent_date_time
  @sent_date_time
end

#signer_can_sign_on_mobileObject

Returns the value of attribute signer_can_sign_on_mobile


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

def signer_can_sign_on_mobile
  @signer_can_sign_on_mobile
end

#signing_locationObject

Specifies the physical location where the signing takes place. It can have two enumeration values; InPerson and Online. The default value is Online.


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

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


210
211
212
# File 'lib/docusign_esign/models/envelope.rb', line 210

def status
  @status
end

#status_changed_date_timeObject

The data and time the status changed.


213
214
215
# File 'lib/docusign_esign/models/envelope.rb', line 213

def status_changed_date_time
  @status_changed_date_time
end

#status_date_timeObject

Returns the value of attribute status_date_time


216
217
218
# File 'lib/docusign_esign/models/envelope.rb', line 216

def status_date_time
  @status_date_time
end

#templates_uriObject

Contains a URI for an endpoint which you can use to retrieve the templates.


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

def templates_uri
  @templates_uri
end

#transaction_idObject

Used to identify an envelope. The id is a sender-generated value and is valid in the DocuSign system for 7 days. It is recommended that a transaction ID is used for offline signing to ensure that an envelope is not sent multiple times. The `transactionId` property can be used determine an envelope's status (i.e. was it created or not) in cases where the internet connection was lost before the envelope status was returned.


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

def transaction_id
  @transaction_id
end

#use_disclosureObject

When set to *true*, the disclosure is shown to recipients in accordance with the account's Electronic Record and Signature Disclosure frequency setting. When set to *false*, the Electronic Record and Signature Disclosure is not shown to any envelope recipients. If the `useDisclosure` property is not set, then the account's normal disclosure setting is used and the value of the `useDisclosure` property is not returned in responses when getting envelope information.


225
226
227
# File 'lib/docusign_esign/models/envelope.rb', line 225

def use_disclosure
  @use_disclosure
end

#voided_date_timeObject

The date and time the envelope or template was voided.


228
229
230
# File 'lib/docusign_esign/models/envelope.rb', line 228

def voided_date_time
  @voided_date_time
end

#voided_reasonObject

The reason the envelope or template was voided.


231
232
233
# File 'lib/docusign_esign/models/envelope.rb', line 231

def voided_reason
  @voided_reason
end

#workflowObject

Returns the value of attribute workflow


233
234
235
# File 'lib/docusign_esign/models/envelope.rb', line 233

def workflow
  @workflow
end

Class Method Details

.attribute_mapObject

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


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

def self.attribute_map
  {
    :'access_control_list_base64' => :'accessControlListBase64',
    :'allow_comments' => :'allowComments',
    :'allow_markup' => :'allowMarkup',
    :'allow_reassign' => :'allowReassign',
    :'allow_view_history' => :'allowViewHistory',
    :'any_signer' => :'anySigner',
    :'asynchronous' => :'asynchronous',
    :'attachments_uri' => :'attachmentsUri',
    :'authoritative_copy' => :'authoritativeCopy',
    :'authoritative_copy_default' => :'authoritativeCopyDefault',
    :'auto_navigation' => :'autoNavigation',
    :'brand_id' => :'brandId',
    :'brand_lock' => :'brandLock',
    :'certificate_uri' => :'certificateUri',
    :'completed_date_time' => :'completedDateTime',
    :'copy_recipient_data' => :'copyRecipientData',
    :'created_date_time' => :'createdDateTime',
    :'custom_fields' => :'customFields',
    :'custom_fields_uri' => :'customFieldsUri',
    :'declined_date_time' => :'declinedDateTime',
    :'deleted_date_time' => :'deletedDateTime',
    :'delivered_date_time' => :'deliveredDateTime',
    :'disable_responsive_document' => :'disableResponsiveDocument',
    :'documents_combined_uri' => :'documentsCombinedUri',
    :'documents_uri' => :'documentsUri',
    :'email_blurb' => :'emailBlurb',
    :'email_settings' => :'emailSettings',
    :'email_subject' => :'emailSubject',
    :'enable_wet_sign' => :'enableWetSign',
    :'enforce_signer_visibility' => :'enforceSignerVisibility',
    :'envelope_attachments' => :'envelopeAttachments',
    :'envelope_documents' => :'envelopeDocuments',
    :'envelope_id' => :'envelopeId',
    :'envelope_id_stamping' => :'envelopeIdStamping',
    :'envelope_location' => :'envelopeLocation',
    :'envelope_metadata' => :'envelopeMetadata',
    :'envelope_uri' => :'envelopeUri',
    :'expire_after' => :'expireAfter',
    :'expire_date_time' => :'expireDateTime',
    :'expire_enabled' => :'expireEnabled',
    :'external_envelope_id' => :'externalEnvelopeId',
    :'folders' => :'folders',
    :'has_comments' => :'hasComments',
    :'has_form_data_changed' => :'hasFormDataChanged',
    :'has_wav_file' => :'hasWavFile',
    :'holder' => :'holder',
    :'initial_sent_date_time' => :'initialSentDateTime',
    :'is21_cfr_part11' => :'is21CFRPart11',
    :'is_dynamic_envelope' => :'isDynamicEnvelope',
    :'is_signature_provider_envelope' => :'isSignatureProviderEnvelope',
    :'last_modified_date_time' => :'lastModifiedDateTime',
    :'location' => :'location',
    :'lock_information' => :'lockInformation',
    :'message_lock' => :'messageLock',
    :'notification' => :'notification',
    :'notification_uri' => :'notificationUri',
    :'power_form' => :'powerForm',
    :'purge_completed_date' => :'purgeCompletedDate',
    :'purge_request_date' => :'purgeRequestDate',
    :'purge_state' => :'purgeState',
    :'recipients' => :'recipients',
    :'recipients_lock' => :'recipientsLock',
    :'recipients_uri' => :'recipientsUri',
    :'sender' => :'sender',
    :'sent_date_time' => :'sentDateTime',
    :'signer_can_sign_on_mobile' => :'signerCanSignOnMobile',
    :'signing_location' => :'signingLocation',
    :'status' => :'status',
    :'status_changed_date_time' => :'statusChangedDateTime',
    :'status_date_time' => :'statusDateTime',
    :'templates_uri' => :'templatesUri',
    :'transaction_id' => :'transactionId',
    :'use_disclosure' => :'useDisclosure',
    :'voided_date_time' => :'voidedDateTime',
    :'voided_reason' => :'voidedReason',
    :'workflow' => :'workflow'
  }
end

.swagger_typesObject

Attribute type mapping.


318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
# File 'lib/docusign_esign/models/envelope.rb', line 318

def self.swagger_types
  {
    :'access_control_list_base64' => :'String',
    :'allow_comments' => :'String',
    :'allow_markup' => :'String',
    :'allow_reassign' => :'String',
    :'allow_view_history' => :'String',
    :'any_signer' => :'String',
    :'asynchronous' => :'String',
    :'attachments_uri' => :'String',
    :'authoritative_copy' => :'String',
    :'authoritative_copy_default' => :'String',
    :'auto_navigation' => :'String',
    :'brand_id' => :'String',
    :'brand_lock' => :'String',
    :'certificate_uri' => :'String',
    :'completed_date_time' => :'String',
    :'copy_recipient_data' => :'String',
    :'created_date_time' => :'String',
    :'custom_fields' => :'CustomFields',
    :'custom_fields_uri' => :'String',
    :'declined_date_time' => :'String',
    :'deleted_date_time' => :'String',
    :'delivered_date_time' => :'String',
    :'disable_responsive_document' => :'String',
    :'documents_combined_uri' => :'String',
    :'documents_uri' => :'String',
    :'email_blurb' => :'String',
    :'email_settings' => :'EmailSettings',
    :'email_subject' => :'String',
    :'enable_wet_sign' => :'String',
    :'enforce_signer_visibility' => :'String',
    :'envelope_attachments' => :'Array<Attachment>',
    :'envelope_documents' => :'Array<EnvelopeDocument>',
    :'envelope_id' => :'String',
    :'envelope_id_stamping' => :'String',
    :'envelope_location' => :'String',
    :'envelope_metadata' => :'EnvelopeMetadata',
    :'envelope_uri' => :'String',
    :'expire_after' => :'String',
    :'expire_date_time' => :'String',
    :'expire_enabled' => :'String',
    :'external_envelope_id' => :'String',
    :'folders' => :'Array<Folder>',
    :'has_comments' => :'String',
    :'has_form_data_changed' => :'String',
    :'has_wav_file' => :'String',
    :'holder' => :'String',
    :'initial_sent_date_time' => :'String',
    :'is21_cfr_part11' => :'String',
    :'is_dynamic_envelope' => :'String',
    :'is_signature_provider_envelope' => :'String',
    :'last_modified_date_time' => :'String',
    :'location' => :'String',
    :'lock_information' => :'LockInformation',
    :'message_lock' => :'String',
    :'notification' => :'Notification',
    :'notification_uri' => :'String',
    :'power_form' => :'PowerForm',
    :'purge_completed_date' => :'String',
    :'purge_request_date' => :'String',
    :'purge_state' => :'String',
    :'recipients' => :'Recipients',
    :'recipients_lock' => :'String',
    :'recipients_uri' => :'String',
    :'sender' => :'UserInfo',
    :'sent_date_time' => :'String',
    :'signer_can_sign_on_mobile' => :'String',
    :'signing_location' => :'String',
    :'status' => :'String',
    :'status_changed_date_time' => :'String',
    :'status_date_time' => :'String',
    :'templates_uri' => :'String',
    :'transaction_id' => :'String',
    :'use_disclosure' => :'String',
    :'voided_date_time' => :'String',
    :'voided_reason' => :'String',
    :'workflow' => :'Workflow'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared


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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      access_control_list_base64 == o.access_control_list_base64 &&
      allow_comments == o.allow_comments &&
      allow_markup == o.allow_markup &&
      allow_reassign == o.allow_reassign &&
      allow_view_history == o.allow_view_history &&
      any_signer == o.any_signer &&
      asynchronous == o.asynchronous &&
      attachments_uri == o.attachments_uri &&
      authoritative_copy == o.authoritative_copy &&
      authoritative_copy_default == o.authoritative_copy_default &&
      auto_navigation == o.auto_navigation &&
      brand_id == o.brand_id &&
      brand_lock == o.brand_lock &&
      certificate_uri == o.certificate_uri &&
      completed_date_time == o.completed_date_time &&
      copy_recipient_data == o.copy_recipient_data &&
      created_date_time == o.created_date_time &&
      custom_fields == o.custom_fields &&
      custom_fields_uri == o.custom_fields_uri &&
      declined_date_time == o.declined_date_time &&
      deleted_date_time == o.deleted_date_time &&
      delivered_date_time == o.delivered_date_time &&
      disable_responsive_document == o.disable_responsive_document &&
      documents_combined_uri == o.documents_combined_uri &&
      documents_uri == o.documents_uri &&
      email_blurb == o.email_blurb &&
      email_settings == o.email_settings &&
      email_subject == o.email_subject &&
      enable_wet_sign == o.enable_wet_sign &&
      enforce_signer_visibility == o.enforce_signer_visibility &&
      envelope_attachments == o.envelope_attachments &&
      envelope_documents == o.envelope_documents &&
      envelope_id == o.envelope_id &&
      envelope_id_stamping == o.envelope_id_stamping &&
      envelope_location == o.envelope_location &&
       == o. &&
      envelope_uri == o.envelope_uri &&
      expire_after == o.expire_after &&
      expire_date_time == o.expire_date_time &&
      expire_enabled == o.expire_enabled &&
      external_envelope_id == o.external_envelope_id &&
      folders == o.folders &&
      has_comments == o.has_comments &&
      has_form_data_changed == o.has_form_data_changed &&
      has_wav_file == o.has_wav_file &&
      holder == o.holder &&
      initial_sent_date_time == o.initial_sent_date_time &&
      is21_cfr_part11 == o.is21_cfr_part11 &&
      is_dynamic_envelope == o.is_dynamic_envelope &&
      is_signature_provider_envelope == o.is_signature_provider_envelope &&
      last_modified_date_time == o.last_modified_date_time &&
      location == o.location &&
      lock_information == o.lock_information &&
      message_lock == o.message_lock &&
      notification == o.notification &&
      notification_uri == o.notification_uri &&
      power_form == o.power_form &&
      purge_completed_date == o.purge_completed_date &&
      purge_request_date == o.purge_request_date &&
      purge_state == o.purge_state &&
      recipients == o.recipients &&
      recipients_lock == o.recipients_lock &&
      recipients_uri == o.recipients_uri &&
      sender == o.sender &&
      sent_date_time == o.sent_date_time &&
      signer_can_sign_on_mobile == o.signer_can_sign_on_mobile &&
      signing_location == o.signing_location &&
      status == o.status &&
      status_changed_date_time == o.status_changed_date_time &&
      status_date_time == o.status_date_time &&
      templates_uri == o.templates_uri &&
      transaction_id == o.transaction_id &&
      use_disclosure == o.use_disclosure &&
      voided_date_time == o.voided_date_time &&
      voided_reason == o.voided_reason &&
      workflow == o.workflow
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


850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
# File 'lib/docusign_esign/models/envelope.rb', line 850

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


916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'lib/docusign_esign/models/envelope.rb', line 916

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


829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
# File 'lib/docusign_esign/models/envelope.rb', line 829

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

816
817
818
# File 'lib/docusign_esign/models/envelope.rb', line 816

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


822
823
824
# File 'lib/docusign_esign/models/envelope.rb', line 822

def hash
  [access_control_list_base64, allow_comments, allow_markup, allow_reassign, allow_view_history, any_signer, asynchronous, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_attachments, envelope_documents, envelope_id, envelope_id_stamping, envelope_location, , envelope_uri, expire_after, expire_date_time, expire_enabled, external_envelope_id, folders, has_comments, has_form_data_changed, has_wav_file, holder, initial_sent_date_time, is21_cfr_part11, is_dynamic_envelope, is_signature_provider_envelope, last_modified_date_time, location, lock_information, message_lock, notification, notification_uri, power_form, purge_completed_date, purge_request_date, purge_state, recipients, recipients_lock, recipients_uri, sender, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, status_date_time, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason, workflow].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


720
721
722
723
# File 'lib/docusign_esign/models/envelope.rb', line 720

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


896
897
898
# File 'lib/docusign_esign/models/envelope.rb', line 896

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


902
903
904
905
906
907
908
909
910
# File 'lib/docusign_esign/models/envelope.rb', line 902

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


890
891
892
# File 'lib/docusign_esign/models/envelope.rb', line 890

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


727
728
729
# File 'lib/docusign_esign/models/envelope.rb', line 727

def valid?
  true
end