Class: DocuSign_eSign::EnvelopeDefinition

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeDefinition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 329

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

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

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

  if attributes.has_key?(:'attachments')
    if (value = attributes[:'attachments']).is_a?(Array)
      self.attachments = value
    end
  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?(:'compositeTemplates')
    if (value = attributes[:'compositeTemplates']).is_a?(Array)
      self.composite_templates = value
    end
  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?(:'documents')
    if (value = attributes[:'documents']).is_a?(Array)
      self.documents = value
    end
  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?(:'envelopeId')
    self.envelope_id = attributes[:'envelopeId']
  end

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

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

  if attributes.has_key?(:'eventNotification')
    self.event_notification = attributes[:'eventNotification']
  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?(:'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?(:'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?(:'password')
    self.password = attributes[:'password']
  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?(:'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?(:'templateId')
    self.template_id = attributes[:'templateId']
  end

  if attributes.has_key?(:'templateRoles')
    if (value = attributes[:'templateRoles']).is_a?(Array)
      self.template_roles = value
    end
  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
end

Instance Attribute Details

#accessibility ⇒ Object

Sets the document reading zones for screen reader applications. This element can only be used if Document Accessibility is enabled for the account. ###### Note: This information is currently generated from the DocuSign web console by setting the reading zones when creating a template, exporting the reading zone string information, and adding it here.



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

def accessibility
  @accessibility
end

#allow_markup ⇒ Object

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



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

def allow_markup
  @allow_markup
end

#allow_reassign ⇒ Object

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



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

def allow_reassign
  @allow_reassign
end

#allow_recipient_recursion ⇒ Object

When set to true, this enables the Recursive Recipients feature and allows a recipient to appear more than once in the routing order.



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

def allow_recipient_recursion
  @allow_recipient_recursion
end

#allow_view_history ⇒ Object

Returns the value of attribute allow_view_history.



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

def allow_view_history
  @allow_view_history
end

#asynchronous ⇒ Object

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.



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

def asynchronous
  @asynchronous
end

#attachments ⇒ Object

Returns the value of attribute attachments.



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

def attachments
  @attachments
end

#attachments_uri ⇒ Object

Returns the value of attribute attachments_uri.



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

def attachments_uri
  @attachments_uri
end

#authoritative_copy ⇒ Object

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



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

def authoritative_copy
  @authoritative_copy
end

#authoritative_copy_default ⇒ Object

Returns the value of attribute authoritative_copy_default.



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

def authoritative_copy_default
  @authoritative_copy_default
end

#auto_navigation ⇒ Object

Returns the value of attribute auto_navigation.



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

def auto_navigation
  @auto_navigation
end

#brand_id ⇒ Object

This sets the brand profile format used for the envelope. The value in the string is the brandId associated with the profile. Account branding must be enabled for the account to use this option.



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

def brand_id
  @brand_id
end

#brand_lock ⇒ Object

Returns the value of attribute brand_lock.



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

def brand_lock
  @brand_lock
end

#certificate_uri ⇒ Object

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



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

def certificate_uri
  @certificate_uri
end

#completed_date_time ⇒ Object

Specifies the date and time this item was completed.



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

def completed_date_time
  @completed_date_time
end

#composite_templates ⇒ Object

A complex type that can be added to create envelopes from a combination of DocuSign templates and PDF forms. The basic envelope remains the same, while the Composite Template adds new document and template overlays into the envelope. There can be any number of Composite Template structures in the envelope.



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

def composite_templates
  @composite_templates
end

#copy_recipient_data ⇒ Object

Returns the value of attribute copy_recipient_data.



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

def copy_recipient_data
  @copy_recipient_data
end

#created_date_time ⇒ Object

Indicates the date and time the item was created.



68
69
70
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 68

def created_date_time
  @created_date_time
end

#custom_fields ⇒ Object

Returns the value of attribute custom_fields.



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

def custom_fields
  @custom_fields
end

#custom_fields_uri ⇒ Object

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



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

def custom_fields_uri
  @custom_fields_uri
end

#declined_date_time ⇒ Object

The date and time the recipient declined the document.



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

def declined_date_time
  @declined_date_time
end

#deleted_date_time ⇒ Object

Specifies the data and time the item was deleted.



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

def deleted_date_time
  @deleted_date_time
end

#delivered_date_time ⇒ Object

Reserved: For DocuSign use only.



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

def delivered_date_time
  @delivered_date_time
end

#disable_responsive_document ⇒ Object

Returns the value of attribute disable_responsive_document.



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

def disable_responsive_document
  @disable_responsive_document
end

#documents ⇒ Object

Complex element contains the details on the documents in the envelope.



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

def documents
  @documents
end

#documents_combined_uri ⇒ Object

Returns the value of attribute documents_combined_uri.



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

def documents_combined_uri
  @documents_combined_uri
end

#documents_uri ⇒ Object

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



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

def documents_uri
  @documents_uri
end

#email_blurb ⇒ Object

Optional element. This is the same as the email body. If specified it is included in email body for all envelope recipients. This can be a maximum of 10000 characters



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

def email_blurb
  @email_blurb
end

#email_settings ⇒ Object

Returns the value of attribute email_settings.



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

def email_settings
  @email_settings
end

#email_subject ⇒ Object

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.



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

def email_subject
  @email_subject
end

#enable_wet_sign ⇒ Object

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



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

def enable_wet_sign
  @enable_wet_sign
end

#enforce_signer_visibility ⇒ Object

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.



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

def enforce_signer_visibility
  @enforce_signer_visibility
end

#envelope_id ⇒ Object

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



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

def envelope_id
  @envelope_id
end

#envelope_id_stamping ⇒ Object

When set to true, Envelope ID Stamping is enabled.



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

def envelope_id_stamping
  @envelope_id_stamping
end

#envelope_uri ⇒ Object

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



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

def envelope_uri
  @envelope_uri
end

#event_notification ⇒ Object

Returns the value of attribute event_notification.



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

def event_notification
  @event_notification
end

#initial_sent_date_time ⇒ Object

Returns the value of attribute initial_sent_date_time.



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

def initial_sent_date_time
  @initial_sent_date_time
end

#is21_cfr_part11 ⇒ Object

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



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

def is21_cfr_part11
  @is21_cfr_part11
end

#is_signature_provider_envelope ⇒ Object

Returns the value of attribute is_signature_provider_envelope.



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

def is_signature_provider_envelope
  @is_signature_provider_envelope
end

#last_modified_date_time ⇒ Object

The date and time the item was last modified.



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

def last_modified_date_time
  @last_modified_date_time
end

#lock_information ⇒ Object

Returns the value of attribute lock_information.



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

def lock_information
  @lock_information
end

#message_lock ⇒ Object

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.



136
137
138
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 136

def message_lock
  @message_lock
end

#notification ⇒ Object

Returns the value of attribute notification.



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

def notification
  @notification
end

#notification_uri ⇒ Object

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



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

def notification_uri
  @notification_uri
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#purge_state ⇒ Object

Initiates a purge request. Valid values are: * documents_queued: Places envelope documents in the purge queue. * documents_and_metadata_queued: Places envelope documents and metadata in the purge queue.



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

def purge_state
  @purge_state
end

#recipients ⇒ Object

Returns the value of attribute recipients.



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

def recipients
  @recipients
end

#recipients_lock ⇒ Object

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



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

def recipients_lock
  @recipients_lock
end

#recipients_uri ⇒ Object

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



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

def recipients_uri
  @recipients_uri
end

#sent_date_time ⇒ Object

The date and time the envelope was sent.



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

def sent_date_time
  @sent_date_time
end

#signer_can_sign_on_mobile ⇒ Object

Returns the value of attribute signer_can_sign_on_mobile.



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

def signer_can_sign_on_mobile
  @signer_can_sign_on_mobile
end

#signing_location ⇒ Object

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



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

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



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

def status
  @status
end

#status_changed_date_time ⇒ Object

The data and time the status changed.



170
171
172
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 170

def status_changed_date_time
  @status_changed_date_time
end

#template_id ⇒ Object

The unique identifier of the template. If this is not provided, DocuSign will generate a value.



173
174
175
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 173

def template_id
  @template_id
end

#template_roles ⇒ Object

Specifies the template recipients. Each roleName in the template must have a recipient assigned to it. This is made up elements: * email - The recipient’s email address. * name - The recipient’s name. * roleName - The template roleName associated with the recipient. * clientUserId - Optional, this sets if the signer is This specifies if the recipient is embedded or remote. If the clientUserId is not null then the recipient is embedded. Note that if a ClientUserId is used and the account settings SignerMustHaveAccount or SignerMustLoginToSign are true, an error is generated on sending. * defaultRecipient - Optional, When set to true, this recipient is the default recipient and any tabs generated by the transformPdfFields option are mapped to this recipient. * routingOrder - This specifies the routing order of the recipient in the envelope. * accessCode - This optional element specifies the access code a recipient has to enter to validate the identity. This can be a maximum of 50 characters. * inPersonSignerName - Optional, if the template role is an in person signer, this is the full legal name of the signer. This can be a maximum of 100 characters. * emailNotification - This is an optional complex element that has a role specific emailSubject, emailBody, and language. It follows the same format as the emailNotification node for Recipients. * tabs - This allows the tab values to be specified for matching to tabs in the template.



176
177
178
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 176

def template_roles
  @template_roles
end

#templates_uri ⇒ Object

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



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

def templates_uri
  @templates_uri
end

#transaction_id ⇒ Object

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.



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

def transaction_id
  @transaction_id
end

#use_disclosure ⇒ Object

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.



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

def use_disclosure
  @use_disclosure
end

#voided_date_time ⇒ Object

The date and time the envelope or template was voided.



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

def voided_date_time
  @voided_date_time
end

#voided_reason ⇒ Object

The reason the envelope or template was voided.



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

def voided_reason
  @voided_reason
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
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 194

def self.attribute_map
  {
    :'accessibility' => :'accessibility',
    :'allow_markup' => :'allowMarkup',
    :'allow_reassign' => :'allowReassign',
    :'allow_recipient_recursion' => :'allowRecipientRecursion',
    :'allow_view_history' => :'allowViewHistory',
    :'asynchronous' => :'asynchronous',
    :'attachments' => :'attachments',
    :'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',
    :'composite_templates' => :'compositeTemplates',
    :'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' => :'documents',
    :'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_id' => :'envelopeId',
    :'envelope_id_stamping' => :'envelopeIdStamping',
    :'envelope_uri' => :'envelopeUri',
    :'event_notification' => :'eventNotification',
    :'initial_sent_date_time' => :'initialSentDateTime',
    :'is21_cfr_part11' => :'is21CFRPart11',
    :'is_signature_provider_envelope' => :'isSignatureProviderEnvelope',
    :'last_modified_date_time' => :'lastModifiedDateTime',
    :'lock_information' => :'lockInformation',
    :'message_lock' => :'messageLock',
    :'notification' => :'notification',
    :'notification_uri' => :'notificationUri',
    :'password' => :'password',
    :'purge_state' => :'purgeState',
    :'recipients' => :'recipients',
    :'recipients_lock' => :'recipientsLock',
    :'recipients_uri' => :'recipientsUri',
    :'sent_date_time' => :'sentDateTime',
    :'signer_can_sign_on_mobile' => :'signerCanSignOnMobile',
    :'signing_location' => :'signingLocation',
    :'status' => :'status',
    :'status_changed_date_time' => :'statusChangedDateTime',
    :'template_id' => :'templateId',
    :'template_roles' => :'templateRoles',
    :'templates_uri' => :'templatesUri',
    :'transaction_id' => :'transactionId',
    :'use_disclosure' => :'useDisclosure',
    :'voided_date_time' => :'voidedDateTime',
    :'voided_reason' => :'voidedReason'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'accessibility' => :'String',
    :'allow_markup' => :'String',
    :'allow_reassign' => :'String',
    :'allow_recipient_recursion' => :'String',
    :'allow_view_history' => :'String',
    :'asynchronous' => :'String',
    :'attachments' => :'Array<Attachment>',
    :'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',
    :'composite_templates' => :'Array<CompositeTemplate>',
    :'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' => :'Array<Document>',
    :'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_id' => :'String',
    :'envelope_id_stamping' => :'String',
    :'envelope_uri' => :'String',
    :'event_notification' => :'EventNotification',
    :'initial_sent_date_time' => :'String',
    :'is21_cfr_part11' => :'String',
    :'is_signature_provider_envelope' => :'String',
    :'last_modified_date_time' => :'String',
    :'lock_information' => :'LockInformation',
    :'message_lock' => :'String',
    :'notification' => :'Notification',
    :'notification_uri' => :'String',
    :'password' => :'String',
    :'purge_state' => :'String',
    :'recipients' => :'Recipients',
    :'recipients_lock' => :'String',
    :'recipients_uri' => :'String',
    :'sent_date_time' => :'String',
    :'signer_can_sign_on_mobile' => :'String',
    :'signing_location' => :'String',
    :'status' => :'String',
    :'status_changed_date_time' => :'String',
    :'template_id' => :'String',
    :'template_roles' => :'Array<TemplateRole>',
    :'templates_uri' => :'String',
    :'transaction_id' => :'String',
    :'use_disclosure' => :'String',
    :'voided_date_time' => :'String',
    :'voided_reason' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      accessibility == o.accessibility &&
      allow_markup == o.allow_markup &&
      allow_reassign == o.allow_reassign &&
      allow_recipient_recursion == o.allow_recipient_recursion &&
      allow_view_history == o.allow_view_history &&
      asynchronous == o.asynchronous &&
      attachments == o.attachments &&
      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 &&
      composite_templates == o.composite_templates &&
      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 == o.documents &&
      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_id == o.envelope_id &&
      envelope_id_stamping == o.envelope_id_stamping &&
      envelope_uri == o.envelope_uri &&
      event_notification == o.event_notification &&
      initial_sent_date_time == o.initial_sent_date_time &&
      is21_cfr_part11 == o.is21_cfr_part11 &&
      is_signature_provider_envelope == o.is_signature_provider_envelope &&
      last_modified_date_time == o.last_modified_date_time &&
      lock_information == o.lock_information &&
      message_lock == o.message_lock &&
      notification == o.notification &&
      notification_uri == o.notification_uri &&
      password == o.password &&
      purge_state == o.purge_state &&
      recipients == o.recipients &&
      recipients_lock == o.recipients_lock &&
      recipients_uri == o.recipients_uri &&
      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 &&
      template_id == o.template_id &&
      template_roles == o.template_roles &&
      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
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



705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 705

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



771
772
773
774
775
776
777
778
779
780
781
782
783
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 771

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



684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 684

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


671
672
673
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 671

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



677
678
679
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 677

def hash
  [accessibility, allow_markup, allow_reassign, allow_recipient_recursion, allow_view_history, asynchronous, attachments, attachments_uri, authoritative_copy, authoritative_copy_default, auto_navigation, brand_id, brand_lock, certificate_uri, completed_date_time, composite_templates, copy_recipient_data, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, disable_responsive_document, documents, documents_combined_uri, documents_uri, email_blurb, email_settings, email_subject, enable_wet_sign, enforce_signer_visibility, envelope_id, envelope_id_stamping, envelope_uri, event_notification, initial_sent_date_time, is21_cfr_part11, is_signature_provider_envelope, last_modified_date_time, lock_information, message_lock, notification, notification_uri, password, purge_state, recipients, recipients_lock, recipients_uri, sent_date_time, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, template_id, template_roles, templates_uri, transaction_id, use_disclosure, voided_date_time, voided_reason].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



590
591
592
593
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 590

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



751
752
753
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 751

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



757
758
759
760
761
762
763
764
765
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 757

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



745
746
747
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 745

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



597
598
599
 
# File 'lib/docusign_esign/models/envelope_definition.rb', line 597

def valid?
  true
end