| accessControlListBase64 |
String |
Reserved for DocuSign. |
[optional] |
| allowComments |
String |
When set to true, indicates that comments are allowed on the envelope. |
[optional] |
| allowMarkup |
String |
When set to true, the Document Markup feature is enabled. Note: To use this feature, Document Markup must be enabled at both the account and envelope levels. Only Admin users can change this setting for at the account level. |
[optional] |
| allowReassign |
String |
When true, the recipient can redirect an envelope to a more appropriate recipient. |
[optional] |
| allowViewHistory |
String |
When set to true, recipients can view the history of the envelope. |
[optional] |
| anySigner |
String |
Deprecated. This feature has been replaced by signing groups. |
[optional] |
| asynchronous |
String |
When 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. Note: A `transactionId` is required for this call to work correctly. When the envelope is created, the status is `Processing` and an `envelopeId` is not returned in the response. To get the `envelopeId`, use a GET envelope query by using the transactionId or by checking the Connect notification. |
[optional] |
| attachmentsUri |
String |
Contains a URL for retrieving the attachments that are associated with the envelope. |
[optional] |
| authoritativeCopy |
String |
When true, marks all of the documents in the envelope as authoritative copies. Note: You can override this value for a specific document. For example, you can set the `authoritativeCopy` property to true at the envelope level, but turn it off for a single document by setting the `authoritativeCopy` property for the document to false. |
[optional] |
| authoritativeCopyDefault |
String |
The default `authoritativeCopy` setting for documents in this envelope that do not have `authoritativeCopy` set. If this property is not set, each document defaults to the envelope's `authoritativeCopy`. |
[optional] |
| autoMatch |
String |
By default, templates that have been used within the last 60 days are included in auto-matching. By explicitly setting `autoMatch`, you can permanently include or exclude the template in auto matching. When true the template is included in auto-matching regardless of when it was last used. When false the template is never included in auto-matching. |
[optional] |
| autoMatchSpecifiedByUser |
String |
If true, the template has been explicitly included in or excluded from auto-matching. The default is false. This is a read-only property. |
[optional] |
| autoNavigation |
String |
When set to true, autonavigation is set for the recipient. |
[optional] |
| brandId |
String |
The id of the brand. |
[optional] |
| brandLock |
String |
When true, the `brandId` for the envelope is locked and senders cannot change the brand used for the envelope. |
[optional] |
| certificateUri |
String |
The URI for retrieving certificate information. |
[optional] |
| completedDateTime |
String |
Specifies the date and time this item was completed. |
[optional] |
| copyRecipientData |
String |
|
[optional] |
| created |
String |
The UTC DateTime when the workspace user authorization was created. |
[optional] |
| createdDateTime |
String |
The UTC DateTime when the item was created. |
[optional] |
| customFields |
AccountCustomFields |
|
[optional] |
| customFieldsUri |
String |
The URI for retrieving custom fields. |
[optional] |
| declinedDateTime |
String |
The date and time the recipient declined the document. Read only. |
[optional] |
| deletedDateTime |
String |
Reserved for DocuSign. |
[optional] |
| deliveredDateTime |
String |
The date and time that the envelope was delivered to the recipient. Read only. |
[optional] |
| description |
String |
A sender-defined description of the line item. |
[optional] |
| disableResponsiveDocument |
String |
When set to true, responsive documents are disabled for the envelope. |
[optional] |
| documents |
[Document] |
A complex element that contains details about the documents associated with the envelope. |
[optional] |
| documentsCombinedUri |
String |
The URI for retrieving all of the documents associated with the envelope as a single PDF file. |
[optional] |
| documentsUri |
String |
The URI for retrieving all of the documents associated with the envelope as separate files. |
[optional] |
| emailBlurb |
String |
This is the same as the email body. If the sender enters an email blurb, it is included in the email body for all envelope recipients. |
[optional] |
| emailSettings |
EmailSettings |
|
[optional] |
| emailSubject |
String |
The subject line of the email message that is sent to all recipients. For information about adding merge field information to the email subject, see Template Email Subject Merge Fields. |
[optional] |
| enableWetSign |
String |
When set to true, the signer is allowed to print the document and sign it on paper. |
[optional] |
| enforceSignerVisibility |
String |
When set to true, signers can only view the documents on which they have tabs. Recipients that have an administrative role (Agent, Editor, or Intermediaries) or informational role (Certified Deliveries or Carbon Copies) can always see all of the documents in an envelope, unless they are specifically excluded by 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 by using this setting when an envelope is sent. Note: To use this functionality, [Document Visibility][docviz] must be enabled for the account by making the account setting `allowDocumentVisibility` true. [docviz]: /esign/restapi/Envelopes/EnvelopeDocumentVisibility |
[optional] |
| envelopeAttachments |
[Attachment] |
An array of attachment objects that provide information about the attachments that are associated with the envelope. |
[optional] |
| envelopeDocuments |
[EnvelopeDocument] |
An array containing information about the documents that are included in the envelope. |
[optional] |
| envelopeId |
String |
The envelope ID of the envelope status that failed to post. |
[optional] |
| envelopeIdStamping |
String |
When set to true, Envelope ID Stamping is enabled. After a document or attachment is stamped with an Envelope ID, the ID is seen by all recipients and becomes a permanent part of the document and cannot be removed. |
[optional] |
| envelopeLocation |
String |
Reserved for DocuSign. |
[optional] |
| envelopeMetadata |
EnvelopeMetadata |
|
[optional] |
| envelopeUri |
String |
The URI for retrieving the envelope or envelopes. |
[optional] |
| expireAfter |
String |
An integer specifying the number of days that a sent envelope remains active before it expires. A negative number in a response indicates that the envelope has already expired. |
[optional] |
| expireDateTime |
String |
The date and time the envelope is set to expire. |
[optional] |
| expireEnabled |
String |
When set to true, the envelope expires (is no longer available for signing) after the specified number of days after it is sent (`sentDateTime`). Set `expireAfter` to set the number of days until an envelope expires. When false, the account default setting is used. If the account does not have an expiration setting, the DocuSign default value of 120 days is used. |
[optional] |
| externalEnvelopeId |
String |
May contain an external identifier for the envelope. |
[optional] |
| favoritedByMe |
String |
|
[optional] |
| folderId |
String |
The unique identifier for the folder that the template belongs to. |
[optional] |
| folderIds |
[String] |
An array of folder IDs that the template is in. |
[optional] |
| folderName |
String |
The name of the folder the template belongs to. |
[optional] |
| folders |
[Folder] |
A list of folder objects. |
[optional] |
| hasComments |
String |
When set to true, indicates that users have added comments to the envelope. |
[optional] |
| hasFormDataChanged |
String |
Specifies if the `EnvelopeFormData` associated with any forms in the template has changed. |
[optional] |
| hasWavFile |
String |
When set to true, indicates that the template includes a .wav file. |
[optional] |
| holder |
String |
Reserved for DocuSign. |
[optional] |
| initialSentDateTime |
String |
The date and time the envelope that used the template was initially sent. |
[optional] |
| is21CFRPart11 |
String |
When true, indicates compliance with United States Food and Drug Administration (FDA) regulations on electronic records and electronic signatures (ERES). |
[optional] |
| isDynamicEnvelope |
String |
When set to true, indicates that the envelope is a dynamic envelope. |
[optional] |
| isSignatureProviderEnvelope |
String |
When set to true, indicates that the envelope is a signature-provided envelope. |
[optional] |
| lastModified |
String |
The UTC date and time that the comment was last updated. Note: This can only be done by the creator. |
[optional] |
| lastModifiedBy |
UserInfo |
|
[optional] |
| lastModifiedDateTime |
String |
The date and time the template was last modified. |
[optional] |
| lastUsed |
String |
The date and time the template was last used. |
[optional] |
| location |
String |
Reserved for DocuSign. |
[optional] |
| lockInformation |
EnvelopeLocks |
|
[optional] |
| messageLock |
String |
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. |
[optional] |
| name |
String |
The name of the template. |
[optional] |
| newPassword |
String |
The user's new password. |
[optional] |
| notification |
Notification |
|
[optional] |
| notificationUri |
String |
The URI for retrieving notifications. |
[optional] |
| owner |
UserInfo |
|
[optional] |
| pageCount |
String |
An integer value specifying the number of document pages in the template. |
[optional] |
| password |
String |
The password for editing the template. |
[optional] |
| passwordProtected |
String |
If true, a password is required to edit the template. |
[optional] |
| powerForm |
PowerForm |
|
[optional] |
| powerForms |
[PowerForm] |
An array of PowerForm objects that contain information about any PowerForms that are included in the template. |
[optional] |
| purgeCompletedDate |
String |
The date that a purge was completed. |
[optional] |
| purgeRequestDate |
String |
The date that a purge was requested. |
[optional] |
| purgeState |
String |
Shows the current purge state for the envelope. The possible values are: * `unpurged`: There has been no successful request to purge documents. * `documents_queued`: The envelope documents have been added to the purge queue, but have not been purged. * `documents_dequeued`: The envelope documents have been taken out of the purge queue. * `documents_and_metadata_queued`: The envelope documents and metadata have been added to the purge queue, but have not yet been purged. * `documents_purged`: The envelope documents have been successfully purged. * `documents_and_metadata_purged`: The envelope documents and metadata have been successfully purged. |
[optional] |
| recipients |
EnvelopeRecipients |
|
[optional] |
| recipientsLock |
String |
When set to true, prevents senders from changing, correcting, or deleting the recipient information for the envelope. |
[optional] |
| recipientsUri |
String |
Contains a URI for an endpoint that you can use to retrieve the recipients. |
[optional] |
| sender |
UserInfo |
|
[optional] |
| sentDateTime |
String |
The UTC DateTime when the envelope was sent. Read only. |
[optional] |
| shared |
String |
When true, indicates the template is shared with the Everyone group, and is shared with all users on the account. If false, the template is only shared with the Administrator group. |
[optional] |
| signerCanSignOnMobile |
String |
When set to true, recipients can sign on a mobile device. Note: Only Admin users can change this setting. |
[optional] |
| signingLocation |
String |
Specifies the physical location where the signing takes place. It can have two enumeration values; `inPerson` and `online`. The default value is `online`. |
[optional] |
| status |
String |
Indicates the envelope status. Valid values are: * `completed`: The recipients have finished working with the envelope: the documents are signed and all required tabs are filled in. * `created`: The envelope is created as a draft. It can be modified and sent later. * `declined`: The envelope has been declined by the recipients. * `delivered`: The envelope has been delivered to the recipients. * `sent`: The envelope will be sent to the recipients after the envelope is created. * `signed`: The envelope has been signed by the recipients. * `voided`: The envelope is no longer valid and recipients cannot access or sign the envelope. |
[optional] |
| statusChangedDateTime |
String |
The data and time that the status changed. |
[optional] |
| statusDateTime |
String |
The DateTime that the envelope changed status (i.e. was created or sent.) |
[optional] |
| templateId |
String |
The id of the template. |
[optional] |
| templatesUri |
String |
The URI for retrieving the templates. |
[optional] |
| transactionId |
String |
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. |
[optional] |
| uri |
String |
Contains a URI that you can use to retreve the template. |
[optional] |
| useDisclosure |
String |
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. |
[optional] |
| voidedDateTime |
String |
The date and time the envelope or template was voided. |
[optional] |
| voidedReason |
String |
The reason the envelope or template was voided. |
[optional] |
| workflow |
Workflow |
|
[optional] |