module:model/EnvelopeTemplate

module:model/EnvelopeTemplate

new module:model/EnvelopeTemplate()

Source:

Constructs a new EnvelopeTemplate.

Members

(inner) accessControlListBase64 :String

Source:
Type:
  • String

(inner) allowComments :String

Source:
Type:
  • String

(inner) allowMarkup :String

Source:

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

Type:
  • String

(inner) allowReassign :String

Source:

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

Type:
  • String

(inner) allowViewHistory :String

Source:
Type:
  • String

(inner) anySigner :String

Source:
Type:
  • String

(inner) asynchronous :String

Source:

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.

Type:
  • String

(inner) attachmentsUri :String

Source:
Type:
  • String

(inner) authoritativeCopy :String

Source:

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

Type:
  • String

(inner) authoritativeCopyDefault :String

Source:
Type:
  • String

(inner) autoMatch :String

Source:
Type:
  • String

(inner) autoMatchSpecifiedByUser :String

Source:
Type:
  • String

(inner) autoNavigation :String

Source:
Type:
  • String

(inner) brandId :String

Source:
Type:
  • String

(inner) brandLock :String

Source:
Type:
  • String

(inner) burnDefaultTabData :String

Source:
Type:
  • String

(inner) certificateUri :String

Source:

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

Type:
  • String

(inner) completedDateTime :String

Source:

Specifies the date and time this item was completed.

Type:
  • String

(inner) copyRecipientData :String

Source:
Type:
  • String

(inner) created :String

Source:
Type:
  • String

(inner) createdDateTime :String

Source:

Indicates the date and time the item was created.

Type:
  • String

(inner) customFields :module:model/CustomFields

Source:

An optional array of strings that allows the sender to provide custom data about the recipient. This information is returned in the envelope status but otherwise not used by DocuSign. Each customField string can be a maximum of 100 characters.

Type:

(inner) customFieldsUri :String

Source:

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

Type:
  • String

(inner) declinedDateTime :String

Source:

The date and time the recipient declined the document.

Type:
  • String

(inner) deletedDateTime :String

Source:

Specifies the data and time the item was deleted.

Type:
  • String

(inner) deliveredDateTime :String

Source:

Reserved: For DocuSign use only.

Type:
  • String

(inner) description :String

Source:
Type:
  • String

(inner) disableResponsiveDocument :String

Source:
Type:
  • String

(inner) documentBase64 :String

Source:
Type:
  • String

(inner) documents :Array.<module:model/Document>

Source:

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

Type:

(inner) documentsCombinedUri :String

Source:
Type:
  • String

(inner) documentsUri :String

Source:

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

Type:
  • String

(inner) emailBlurb :String

Source:
Type:
  • String

(inner) emailSettings :module:model/EmailSettings

Source:

A complex type that contains email settings.

Type:

(inner) emailSubject :String

Source:

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.

Type:
  • String

(inner) enableWetSign :String

Source:

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

Type:
  • String

(inner) enforceSignerVisibility :String

Source:

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.

Type:
  • String

(inner) envelopeAttachments :Array.<module:model/Attachment>

Source:
Type:

(inner) envelopeCustomMetadata :module:model/EnvelopeCustomMetadata

Source:
Type:

(inner) envelopeDocuments :Array.<module:model/EnvelopeDocument>

Source:
Type:

(inner) envelopeId :String

Source:

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

Type:
  • String

(inner) envelopeIdStamping :String

Source:

When set to true, Envelope ID Stamping is enabled.

Type:
  • String

(inner) envelopeLocation :String

Source:
Type:
  • String

(inner) envelopeMetadata :module:model/EnvelopeMetadata

Source:

Provides information about the features and services that are enabled for the envelope, including the Correct feature, the Advanced Correct feature, and DocuSign eNotary service.

Type:

(inner) envelopeUri :String

Source:

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

Type:
  • String

(inner) expireAfter :String

Source:
Type:
  • String

(inner) expireDateTime :String

Source:
Type:
  • String

(inner) expireEnabled :String

Source:
Type:
  • String

(inner) externalEnvelopeId :String

Source:
Type:
  • String

(inner) favoritedByMe :String

Source:
Type:
  • String

(inner) folderId :String

Source:
Type:
  • String

(inner) folderIds :Array.<String>

Source:
Type:
  • Array.<String>

(inner) folderName :String

Source:
Type:
  • String

(inner) folders :Array.<module:model/Folder>

Source:
Type:

(inner) hasComments :String

Source:
Type:
  • String

(inner) hasFormDataChanged :String

Source:
Type:
  • String

(inner) hasWavFile :String

Source:
Type:
  • String

(inner) holder :String

Source:
Type:
  • String

(inner) initialSentDateTime :String

Source:
Type:
  • String

(inner) is21CFRPart11 :String

Source:

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

Type:
  • String

(inner) isDocGenTemplate :String

Source:
Type:
  • String

(inner) isDynamicEnvelope :String

Source:
Type:
  • String

(inner) isSignatureProviderEnvelope :String

Source:
Type:
  • String

(inner) lastModified :String

Source:
Type:
  • String

(inner) lastModifiedBy :module:model/UserInfo

Source:
Type:

(inner) lastModifiedDateTime :String

Source:

The date and time the item was last modified.

Type:
  • String

(inner) lastUsed :String

Source:
Type:
  • String

(inner) location :String

Source:
Type:
  • String

(inner) lockInformation :module:model/LockInformation

Source:

Provides lock information about an envelope that a user has locked.

Type:

(inner) messageLock :String

Source:

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.

Type:
  • String

(inner) name :String

Source:
Type:
  • String

(inner) newPassword :String

Source:
Type:
  • String

(inner) notification :module:model/Notification

Source:
Type:

(inner) notificationUri :String

Source:

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

Type:
  • String

(inner) owner :module:model/UserInfo

Source:
Type:

(inner) pageCount :String

Source:
Type:
  • String

(inner) password :String

Source:
Type:
  • String

(inner) passwordProtected :String

Source:
Type:
  • String

(inner) powerForm :module:model/PowerForm

Source:

Information about any PowerForms that are included in the envelope.

Type:

(inner) powerForms :Array.<module:model/PowerForm>

Source:
Type:

(inner) purgeCompletedDate :String

Source:
Type:
  • String

(inner) purgeRequestDate :String

Source:
Type:
  • String

(inner) purgeState :String

Source:
Type:
  • String

(inner) recipients :module:model/Recipients

Source:

An array of powerform recipients.

Type:

(inner) recipientsLock :String

Source:

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

Type:
  • String

(inner) recipientsUri :String

Source:

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

Type:
  • String

(inner) sender :module:model/UserInfo

Source:

Information about the sender of the envelope.

Type:

(inner) sentDateTime :String

Source:

The date and time the envelope was sent.

Type:
  • String

(inner) shared :String

Source:

When set to true, this custom tab is shared.

Type:
  • String

(inner) signerCanSignOnMobile :String

Source:
Type:
  • String

(inner) signingLocation :String

Source:

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

Type:
  • String

(inner) status :String

Source:

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.

Type:
  • String

(inner) statusChangedDateTime :String

Source:

The data and time the status changed.

Type:
  • String

(inner) statusDateTime :String

Source:
Type:
  • String

(inner) templateId :String

Source:

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

Type:
  • String

(inner) templatesUri :String

Source:

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

Type:
  • String

(inner) transactionId :String

Source:

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.

Type:
  • String

(inner) uri :String

Source:
Type:
  • String

(inner) useDisclosure :String

Source:

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.

Type:
  • String

(inner) voidedDateTime :String

Source:

The date and time the envelope or template was voided.

Type:
  • String

(inner) voidedReason :String

Source:

The reason the envelope or template was voided.

Type:
  • String

(inner) workflow :module:model/Workflow

Source:
Type:

Methods

(static) constructFromObject(data, obj) → {module:model/EnvelopeTemplate}

Source:

Constructs a EnvelopeTemplate from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/EnvelopeTemplate

Optional instance to populate.
Returns:

The populated EnvelopeTemplate instance.

Type
module:model/EnvelopeTemplate