Class: DocuSign_eSign::EnvelopeTemplateResult
- Inherits:
-
Object
- Object
- DocuSign_eSign::EnvelopeTemplateResult
- Defined in:
- lib/docusign_esign/models/envelope_template_result.rb
Instance Attribute Summary collapse
-
#allow_markup ⇒ Object
When set to true, Document Markup is enabled for envelope.
-
#allow_reassign ⇒ Object
When set to true, the recipient can redirect an envelope to a more appropriate recipient.
-
#allow_view_history ⇒ Object
Returns the value of attribute allow_view_history.
-
#asynchronous ⇒ Object
When set to true, the envelope is queued for processing and the value of the ‘status` property is set to ’Processing’.
-
#attachments_uri ⇒ Object
Returns the value of attribute attachments_uri.
-
#authoritative_copy ⇒ Object
Specifies the Authoritative copy feature.
-
#authoritative_copy_default ⇒ Object
Returns the value of attribute authoritative_copy_default.
-
#auto_navigation ⇒ Object
Returns the value of attribute auto_navigation.
-
#brand_id ⇒ Object
Returns the value of attribute brand_id.
-
#brand_lock ⇒ Object
Returns the value of attribute brand_lock.
-
#certificate_uri ⇒ Object
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
-
#completed_date_time ⇒ Object
Specifies the date and time this item was completed.
-
#created ⇒ Object
Returns the value of attribute created.
-
#created_date_time ⇒ Object
Indicates the date and time the item was created.
-
#custom_fields ⇒ Object
Returns the value of attribute custom_fields.
-
#custom_fields_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the custom fields.
-
#declined_date_time ⇒ Object
The date and time the recipient declined the document.
-
#deleted_date_time ⇒ Object
Specifies the data and time the item was deleted.
-
#delivered_date_time ⇒ Object
Reserved: For DocuSign use only.
-
#description ⇒ Object
Returns the value of attribute description.
-
#documents ⇒ Object
Complex element contains the details on the documents in the envelope.
-
#documents_combined_uri ⇒ Object
Returns the value of attribute documents_combined_uri.
-
#documents_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the documents.
-
#email_blurb ⇒ Object
Returns the value of attribute email_blurb.
-
#email_settings ⇒ Object
Returns the value of attribute email_settings.
-
#email_subject ⇒ Object
Specifies the subject of the email that is sent to all recipients.
-
#enable_wet_sign ⇒ Object
When set to true, the signer is allowed to print the document and sign it on paper.
-
#enforce_signer_visibility ⇒ Object
When set to true, documents with tabs can only be viewed by signers that have a tab on that document.
-
#envelope_id ⇒ Object
The envelope ID of the envelope status that failed to post.
-
#envelope_id_stamping ⇒ Object
When set to true, Envelope ID Stamping is enabled.
-
#envelope_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the envelope or envelopes.
-
#folder_id ⇒ Object
Returns the value of attribute folder_id.
-
#folder_name ⇒ Object
Returns the value of attribute folder_name.
-
#folder_uri ⇒ Object
Returns the value of attribute folder_uri.
-
#initial_sent_date_time ⇒ Object
Returns the value of attribute initial_sent_date_time.
-
#is21_cfr_part11 ⇒ Object
When set to true, indicates that this module is enabled on the account.
-
#is_signature_provider_envelope ⇒ Object
Returns the value of attribute is_signature_provider_envelope.
-
#last_modified ⇒ Object
Returns the value of attribute last_modified.
-
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
-
#lock_information ⇒ Object
Returns the value of attribute lock_information.
-
#message_lock ⇒ Object
When set to true, prevents senders from changing the contents of ‘emailBlurb` and `emailSubject` properties for the envelope.
-
#name ⇒ Object
Returns the value of attribute name.
-
#notification ⇒ Object
Returns the value of attribute notification.
-
#notification_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the notifications.
-
#owner ⇒ Object
Returns the value of attribute owner.
-
#page_count ⇒ Object
Returns the value of attribute page_count.
-
#parent_folder_uri ⇒ Object
Returns the value of attribute parent_folder_uri.
-
#password ⇒ Object
Returns the value of attribute password.
-
#purge_state ⇒ Object
Returns the value of attribute purge_state.
-
#recipients ⇒ Object
Returns the value of attribute recipients.
-
#recipients_lock ⇒ Object
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
-
#recipients_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the recipients.
-
#sent_date_time ⇒ Object
The date and time the envelope was sent.
-
#shared ⇒ Object
When set to true, this custom tab is shared.
-
#signer_can_sign_on_mobile ⇒ Object
Returns the value of attribute signer_can_sign_on_mobile.
-
#signing_location ⇒ Object
Specifies the physical location where the signing takes place.
-
#status ⇒ Object
Indicates the envelope status.
-
#status_changed_date_time ⇒ Object
The data and time the status changed.
-
#template_id ⇒ Object
The unique identifier of the template.
-
#templates_uri ⇒ Object
Contains a URI for an endpoint which you can use to retrieve the templates.
-
#transaction_id ⇒ Object
Used to identify an envelope.
-
#uri ⇒ Object
Returns the value of attribute uri.
-
#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.
-
#voided_date_time ⇒ Object
The date and time the envelope or template was voided.
-
#voided_reason ⇒ Object
The reason the envelope or template was voided.
Class Method Summary collapse
-
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
-
.swagger_types ⇒ Object
Attribute type mapping.
Instance Method Summary collapse
-
#==(o) ⇒ Object
Checks equality by comparing each attribute.
-
#_deserialize(type, value) ⇒ Object
Deserializes the data based on type.
-
#_to_hash(value) ⇒ Hash
Outputs non-array value in the form of hash For object, use to_hash.
-
#build_from_hash(attributes) ⇒ Object
Builds the object from hash.
- #eql?(o) ⇒ Boolean
-
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
-
#initialize(attributes = {}) ⇒ EnvelopeTemplateResult
constructor
Initializes the object.
-
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons.
-
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility).
-
#to_hash ⇒ Hash
Returns the object in the form of hash.
-
#to_s ⇒ String
Returns the string representation of the object.
-
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid.
Constructor Details
#initialize(attributes = {}) ⇒ EnvelopeTemplateResult
Initializes the object
351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 351 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?(:'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?(:'asynchronous') self.asynchronous = attributes[:'asynchronous'] end if attributes.has_key?(:'attachmentsUri') self. = attributes[:'attachmentsUri'] end if attributes.has_key?(:'authoritativeCopy') self. = attributes[:'authoritativeCopy'] end if attributes.has_key?(:'authoritativeCopyDefault') self. = attributes[:'authoritativeCopyDefault'] end if attributes.has_key?(:'autoNavigation') self. = 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?(:'created') self.created = attributes[:'created'] 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?(:'description') self.description = attributes[:'description'] 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?(:'folderId') self.folder_id = attributes[:'folderId'] end if attributes.has_key?(:'folderName') self.folder_name = attributes[:'folderName'] end if attributes.has_key?(:'folderUri') self.folder_uri = attributes[:'folderUri'] 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?(:'lastModified') self.last_modified = attributes[:'lastModified'] 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. = attributes[:'messageLock'] end if attributes.has_key?(:'name') self.name = attributes[:'name'] 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?(:'owner') self.owner = attributes[:'owner'] end if attributes.has_key?(:'pageCount') self.page_count = attributes[:'pageCount'] end if attributes.has_key?(:'parentFolderUri') self.parent_folder_uri = attributes[:'parentFolderUri'] 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?(:'shared') self.shared = attributes[:'shared'] 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?(:'templatesUri') self.templates_uri = attributes[:'templatesUri'] end if attributes.has_key?(:'transactionId') self.transaction_id = attributes[:'transactionId'] end if attributes.has_key?(:'uri') self.uri = attributes[:'uri'] 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
#allow_markup ⇒ Object
When set to true, Document Markup is enabled for envelope. Account must have Document Markup enabled to use this
18 19 20 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 18 def allow_markup @allow_markup end |
#allow_reassign ⇒ Object
When set to true, the recipient can redirect an envelope to a more appropriate recipient.
21 22 23 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 21 def allow_reassign @allow_reassign end |
#allow_view_history ⇒ Object
Returns the value of attribute allow_view_history.
24 25 26 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 24 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.
27 28 29 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 27 def asynchronous @asynchronous end |
#attachments_uri ⇒ Object
Returns the value of attribute attachments_uri.
30 31 32 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 30 def @attachments_uri end |
#authoritative_copy ⇒ Object
Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.
33 34 35 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 33 def @authoritative_copy end |
#authoritative_copy_default ⇒ Object
Returns the value of attribute authoritative_copy_default.
36 37 38 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 36 def @authoritative_copy_default end |
#auto_navigation ⇒ Object
Returns the value of attribute auto_navigation.
39 40 41 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 39 def @auto_navigation end |
#brand_id ⇒ Object
Returns the value of attribute brand_id.
42 43 44 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 42 def brand_id @brand_id end |
#brand_lock ⇒ Object
Returns the value of attribute brand_lock.
45 46 47 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 45 def brand_lock @brand_lock end |
#certificate_uri ⇒ Object
Retrieves a URI for an endpoint that allows you to easily retrieve certificate information.
48 49 50 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 48 def certificate_uri @certificate_uri end |
#completed_date_time ⇒ Object
Specifies the date and time this item was completed.
51 52 53 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 51 def completed_date_time @completed_date_time end |
#created ⇒ Object
Returns the value of attribute created.
54 55 56 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 54 def created @created end |
#created_date_time ⇒ Object
Indicates the date and time the item was created.
57 58 59 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 57 def created_date_time @created_date_time end |
#custom_fields ⇒ Object
Returns the value of attribute custom_fields.
59 60 61 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 59 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.
62 63 64 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 62 def custom_fields_uri @custom_fields_uri end |
#declined_date_time ⇒ Object
The date and time the recipient declined the document.
65 66 67 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 65 def declined_date_time @declined_date_time end |
#deleted_date_time ⇒ Object
Specifies the data and time the item was deleted.
68 69 70 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 68 def deleted_date_time @deleted_date_time end |
#delivered_date_time ⇒ Object
Reserved: For DocuSign use only.
71 72 73 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 71 def delivered_date_time @delivered_date_time end |
#description ⇒ Object
Returns the value of attribute description.
74 75 76 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 74 def description @description end |
#documents ⇒ Object
Complex element contains the details on the documents in the envelope.
77 78 79 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 77 def documents @documents end |
#documents_combined_uri ⇒ Object
Returns the value of attribute documents_combined_uri.
80 81 82 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 80 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.
83 84 85 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 83 def documents_uri @documents_uri end |
#email_blurb ⇒ Object
Returns the value of attribute email_blurb.
86 87 88 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 86 def email_blurb @email_blurb end |
#email_settings ⇒ Object
Returns the value of attribute email_settings.
88 89 90 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 88 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.
91 92 93 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 91 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.
94 95 96 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 94 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.
97 98 99 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 97 def enforce_signer_visibility @enforce_signer_visibility end |
#envelope_id ⇒ Object
The envelope ID of the envelope status that failed to post.
100 101 102 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 100 def envelope_id @envelope_id end |
#envelope_id_stamping ⇒ Object
When set to true, Envelope ID Stamping is enabled.
103 104 105 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 103 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.
106 107 108 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 106 def envelope_uri @envelope_uri end |
#folder_id ⇒ Object
Returns the value of attribute folder_id.
109 110 111 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 109 def folder_id @folder_id end |
#folder_name ⇒ Object
Returns the value of attribute folder_name.
112 113 114 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 112 def folder_name @folder_name end |
#folder_uri ⇒ Object
Returns the value of attribute folder_uri.
115 116 117 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 115 def folder_uri @folder_uri end |
#initial_sent_date_time ⇒ Object
Returns the value of attribute initial_sent_date_time.
118 119 120 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 118 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.
121 122 123 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 121 def is21_cfr_part11 @is21_cfr_part11 end |
#is_signature_provider_envelope ⇒ Object
Returns the value of attribute is_signature_provider_envelope.
124 125 126 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 124 def is_signature_provider_envelope @is_signature_provider_envelope end |
#last_modified ⇒ Object
Returns the value of attribute last_modified.
127 128 129 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 127 def last_modified @last_modified end |
#last_modified_date_time ⇒ Object
The date and time the item was last modified.
130 131 132 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 130 def last_modified_date_time @last_modified_date_time end |
#lock_information ⇒ Object
Returns the value of attribute lock_information.
132 133 134 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 132 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.
135 136 137 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 135 def @message_lock end |
#name ⇒ Object
Returns the value of attribute name.
138 139 140 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 138 def name @name end |
#notification ⇒ Object
Returns the value of attribute notification.
140 141 142 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 140 def notification @notification end |
#notification_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the notifications.
143 144 145 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 143 def notification_uri @notification_uri end |
#owner ⇒ Object
Returns the value of attribute owner.
145 146 147 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 145 def owner @owner end |
#page_count ⇒ Object
Returns the value of attribute page_count.
148 149 150 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 148 def page_count @page_count end |
#parent_folder_uri ⇒ Object
Returns the value of attribute parent_folder_uri.
151 152 153 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 151 def parent_folder_uri @parent_folder_uri end |
#password ⇒ Object
Returns the value of attribute password.
154 155 156 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 154 def password @password end |
#purge_state ⇒ Object
Returns the value of attribute purge_state.
157 158 159 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 157 def purge_state @purge_state end |
#recipients ⇒ Object
Returns the value of attribute recipients.
159 160 161 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 159 def recipients @recipients end |
#recipients_lock ⇒ Object
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope.
162 163 164 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 162 def recipients_lock @recipients_lock end |
#recipients_uri ⇒ Object
Contains a URI for an endpoint that you can use to retrieve the recipients.
165 166 167 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 165 def recipients_uri @recipients_uri end |
#sent_date_time ⇒ Object
The date and time the envelope was sent.
168 169 170 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 168 def sent_date_time @sent_date_time end |
#shared ⇒ Object
When set to true, this custom tab is shared.
171 172 173 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 171 def shared @shared end |
#signer_can_sign_on_mobile ⇒ Object
Returns the value of attribute signer_can_sign_on_mobile.
174 175 176 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 174 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.
177 178 179 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 177 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.
180 181 182 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 180 def status @status end |
#status_changed_date_time ⇒ Object
The data and time the status changed.
183 184 185 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 183 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.
186 187 188 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 186 def template_id @template_id end |
#templates_uri ⇒ Object
Contains a URI for an endpoint which you can use to retrieve the templates.
189 190 191 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 189 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.
192 193 194 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 192 def transaction_id @transaction_id end |
#uri ⇒ Object
Returns the value of attribute uri.
195 196 197 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 195 def uri @uri 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.
198 199 200 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 198 def use_disclosure @use_disclosure end |
#voided_date_time ⇒ Object
The date and time the envelope or template was voided.
201 202 203 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 201 def voided_date_time @voided_date_time end |
#voided_reason ⇒ Object
The reason the envelope or template was voided.
204 205 206 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 204 def voided_reason @voided_reason end |
Class Method Details
.attribute_map ⇒ Object
Attribute mapping from ruby-style variable name to JSON key.
208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 208 def self.attribute_map { :'allow_markup' => :'allowMarkup', :'allow_reassign' => :'allowReassign', :'allow_view_history' => :'allowViewHistory', :'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', :'created' => :'created', :'created_date_time' => :'createdDateTime', :'custom_fields' => :'customFields', :'custom_fields_uri' => :'customFieldsUri', :'declined_date_time' => :'declinedDateTime', :'deleted_date_time' => :'deletedDateTime', :'delivered_date_time' => :'deliveredDateTime', :'description' => :'description', :'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', :'folder_id' => :'folderId', :'folder_name' => :'folderName', :'folder_uri' => :'folderUri', :'initial_sent_date_time' => :'initialSentDateTime', :'is21_cfr_part11' => :'is21CFRPart11', :'is_signature_provider_envelope' => :'isSignatureProviderEnvelope', :'last_modified' => :'lastModified', :'last_modified_date_time' => :'lastModifiedDateTime', :'lock_information' => :'lockInformation', :'message_lock' => :'messageLock', :'name' => :'name', :'notification' => :'notification', :'notification_uri' => :'notificationUri', :'owner' => :'owner', :'page_count' => :'pageCount', :'parent_folder_uri' => :'parentFolderUri', :'password' => :'password', :'purge_state' => :'purgeState', :'recipients' => :'recipients', :'recipients_lock' => :'recipientsLock', :'recipients_uri' => :'recipientsUri', :'sent_date_time' => :'sentDateTime', :'shared' => :'shared', :'signer_can_sign_on_mobile' => :'signerCanSignOnMobile', :'signing_location' => :'signingLocation', :'status' => :'status', :'status_changed_date_time' => :'statusChangedDateTime', :'template_id' => :'templateId', :'templates_uri' => :'templatesUri', :'transaction_id' => :'transactionId', :'uri' => :'uri', :'use_disclosure' => :'useDisclosure', :'voided_date_time' => :'voidedDateTime', :'voided_reason' => :'voidedReason' } end |
.swagger_types ⇒ Object
Attribute type mapping.
279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 279 def self.swagger_types { :'allow_markup' => :'String', :'allow_reassign' => :'String', :'allow_view_history' => :'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', :'created' => :'String', :'created_date_time' => :'String', :'custom_fields' => :'CustomFields', :'custom_fields_uri' => :'String', :'declined_date_time' => :'String', :'deleted_date_time' => :'String', :'delivered_date_time' => :'String', :'description' => :'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', :'folder_id' => :'String', :'folder_name' => :'String', :'folder_uri' => :'String', :'initial_sent_date_time' => :'String', :'is21_cfr_part11' => :'String', :'is_signature_provider_envelope' => :'String', :'last_modified' => :'String', :'last_modified_date_time' => :'String', :'lock_information' => :'LockInformation', :'message_lock' => :'String', :'name' => :'String', :'notification' => :'Notification', :'notification_uri' => :'String', :'owner' => :'UserInfo', :'page_count' => :'Integer', :'parent_folder_uri' => :'String', :'password' => :'String', :'purge_state' => :'String', :'recipients' => :'Recipients', :'recipients_lock' => :'String', :'recipients_uri' => :'String', :'sent_date_time' => :'String', :'shared' => :'String', :'signer_can_sign_on_mobile' => :'String', :'signing_location' => :'String', :'status' => :'String', :'status_changed_date_time' => :'String', :'template_id' => :'String', :'templates_uri' => :'String', :'transaction_id' => :'String', :'uri' => :'String', :'use_disclosure' => :'String', :'voided_date_time' => :'String', :'voided_reason' => :'String' } end |
Instance Method Details
#==(o) ⇒ Object
Checks equality by comparing each attribute.
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 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 636 def ==(o) return true if self.equal?(o) self.class == o.class && allow_markup == o.allow_markup && allow_reassign == o.allow_reassign && allow_view_history == o.allow_view_history && asynchronous == o.asynchronous && == o. && == o. && == o. && == o. && brand_id == o.brand_id && brand_lock == o.brand_lock && certificate_uri == o.certificate_uri && completed_date_time == o.completed_date_time && created == o.created && 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 && description == o.description && 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 && folder_id == o.folder_id && folder_name == o.folder_name && folder_uri == o.folder_uri && 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 == o.last_modified && last_modified_date_time == o.last_modified_date_time && lock_information == o.lock_information && == o. && name == o.name && notification == o.notification && notification_uri == o.notification_uri && owner == o.owner && page_count == o.page_count && parent_folder_uri == o.parent_folder_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 && shared == o.shared && 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 && templates_uri == o.templates_uri && transaction_id == o.transaction_id && uri == o.uri && 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
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 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 742 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
808 809 810 811 812 813 814 815 816 817 818 819 820 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 808 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
721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 721 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 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
708 709 710 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 708 def eql?(o) self == o end |
#hash ⇒ Fixnum
Calculates hash code according to all attributes.
714 715 716 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 714 def hash [allow_markup, allow_reassign, allow_view_history, asynchronous, , , , , brand_id, brand_lock, certificate_uri, completed_date_time, created, created_date_time, custom_fields, custom_fields_uri, declined_date_time, deleted_date_time, delivered_date_time, description, 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, folder_id, folder_name, folder_uri, initial_sent_date_time, is21_cfr_part11, is_signature_provider_envelope, last_modified, last_modified_date_time, lock_information, , name, notification, notification_uri, owner, page_count, parent_folder_uri, password, purge_state, recipients, recipients_lock, recipients_uri, sent_date_time, shared, signer_can_sign_on_mobile, signing_location, status, status_changed_date_time, template_id, templates_uri, transaction_id, uri, use_disclosure, voided_date_time, voided_reason].hash end |
#list_invalid_properties ⇒ Object
Show invalid properties with the reasons. Usually used together with valid?
623 624 625 626 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 623 def list_invalid_properties invalid_properties = Array.new return invalid_properties end |
#to_body ⇒ Hash
to_body is an alias to to_hash (backward compatibility)
788 789 790 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 788 def to_body to_hash end |
#to_hash ⇒ Hash
Returns the object in the form of hash
794 795 796 797 798 799 800 801 802 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 794 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
782 783 784 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 782 def to_s to_hash.to_s end |
#valid? ⇒ Boolean
Check to see if the all the properties in the model are valid
630 631 632 |
# File 'lib/docusign_esign/models/envelope_template_result.rb', line 630 def valid? return true end |